voucherify 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93236863fb4ac7cae0378cb4c8287bf04686b651
-  data.tar.gz: 8819259dbfbaa0411336f5a7bcbeead247f67f49
+  metadata.gz: f5bb63b6752861158fe5bf8e4987956de16a839e
+  data.tar.gz: d4b8822a452531daa4e85c94de8652b55bd32edd
 SHA512:
-  metadata.gz: 8bf377abdcd3bb07477ed748a179836fc5c5c4033ace42f9feb490fe9c8eba7572ee4fa8ae269d31ee291082a5ab3a40da95372c151a53c26473dcb122f45387
-  data.tar.gz: f43536f00e1f4eece69096286742742a7d51d251fe2067412907edc838dbecfcbb293b54fc4d6b6fdaf1fee9409294ebcb8fdb9e4d89ec2abbafda5e6ddd295d
+  metadata.gz: 10ea71d73be55ac3bd913b8651f54fa81c812b8f115a4170f8cb5e8c5b2f1c40c792530492a9bde4e77c2553699c995c5290a8041cb08416edd34b8af740a792
+  data.tar.gz: d7ce430802905f0678e9313fa8785230377a6e0768ddb0680b17080af1a7ce6406895308649b484f0c0bd866e1899d072b5501707a589908b057cc639b76ea58

data/README.md

@@ -42,6 +42,10 @@ API:
 |
 <a href="#products-api">Products</a>
 |
+<a href="#validation-rules-api">Validation Rules</a>
+|
+<a href="#segments-api">Segments</a>
+|
 <a href="#utils">Utils</a>
 </p>
 
@@ -74,6 +78,15 @@ voucherify = Voucherify::Client.new({
 })
 ```
 
+You can also specify which API version you want to use:
+```ruby
+voucherify = Voucherify::Client.new({
+  :applicationId => 'YOUR-APPLICATION-ID',
+  :clientSecretKey => 'YOUR-CLIENT-SECRET-KEY',
+  :apiVersion => 'v2017-04-05'
+})
+```
+
 ## API
 
 This SDK is fully consistent with restful API Voucherify provides.
@@ -90,6 +103,7 @@ Methods are provided within `voucherify.vouchers.*` namespace.
 - [Enable Voucher](#enable-voucher)
 - [Disable Voucher](#disable-voucher)
 - [Import Vouchers](#import-vouchers)
+- [Add Gift Voucher Balance](#add-gift-voucher-balance)
 
 #### [Create Voucher]
 ```ruby
@@ -124,6 +138,11 @@ voucherify.vouchers.disable(code)
 ```ruby
 voucherify.vouchers.import(vouchers)
 ```
+#### [Add Gift Voucher Balance]
+```ruby
+voucherify.vouchers().add_balance(code, balance);
+```
+
 ---
 
 ### Campaigns API
@@ -156,11 +175,26 @@ voucherify.campaigns.import_vouchers(campaign_name, vouchers)
 Methods are provided within `voucherify.distributions.*` namespace.
 
 - [Publish Vouchers](#publish-vouchers)
+- [Create Export](#create-export)
+- [Get Export](#get-export)
+- [Delete Export](#delete-export)
 
 #### [Publish Vouchers]
 ```ruby
 voucherify.distributions.publish(campaign_name)
 ```
+#### [Create Export]
+```ruby
+voucherify.distributions.create_export(export)
+```
+#### [Get Export]
+```ruby
+voucherify.distributions.get_export(export_id)
+```
+#### [Delete Export]
+```ruby
+voucherify.distributions.delete_export(export_id)
+```
 
 ---
 
@@ -183,6 +217,7 @@ Methods are provided within `voucherify.redemptions.*` namespace.
 - [List Redemptions](#list-redemptions)
 - [Get Voucher's Redemptions](#get-vouchers-redemptions)
 - [Rollback Redemption](#rollback-redemption)
+- [Get Redemption](#get-redemption)
 
 #### [Redeem Voucher]
 ```ruby
@@ -200,6 +235,10 @@ voucherify.redemptions.list(params)
 ```ruby
 voucherify.redemptions.get_for_voucher(code)
 ```
+#### [Get Redemption]
+```ruby
+voucherify.redemptions.get(redemption_id);
+```
 #### [Rollback Redemption]
 ```ruby
 voucherify.redemptions.rollback(redemption_id, [params])
@@ -296,6 +335,55 @@ voucherify.products.list_skus(product_id)
 
 ---
 
+### Validation Rules API
+Methods are provided within `voucherify.validation_rules.*` namespace.
+
+- [Create Validation Rules](#create-validation-rules)
+- [Get Validation Rules](#get-validation-rules)
+- [Update Validation Rules](#update-validation-rules)
+- [Delete Validation Rules](#delete-validation-rules)
+
+#### [Create Validation Rules]
+```ruby
+voucherify.validation_rules.create(rules);
+```
+#### [Get Validation Rules]
+```ruby
+voucherify.validation_rules.get(id);
+```
+#### [Update Validation Rules]
+```ruby
+voucherify.validation_rules.update(rules);
+```
+#### [Delete Validation Rules]
+```ruby
+voucherify.validation_rules.delete(id);
+```
+
+---
+
+### Segments API
+Methods are provided within `voucherify.segments.*` namespace.
+
+- [Create Segment](#create-segment)
+- [Get Segment](#get-segment)
+- [Delete Validation Rules](#delete-segment)
+
+#### [Create Segment]
+```ruby
+voucherify.segments.create(segment);
+```
+#### [Get Segment]
+```ruby
+voucherify.segments.get(id);
+```
+#### [Delete Segment]
+```ruby
+voucherify.segments.delete(id);
+```
+
+---
+
 ### Migration from 0.x
 
 Version 1.x of the SDK is not backwards compatible with versions 0.x.
@@ -384,6 +472,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/rspective/voucherify-ruby-sdk.
 
 ## Changelog
+- **2017-05-07** - `1.4.0` - Segments, Validation rules, API Versioning
 - **2017-03-22** - `1.3.0` - improved error handling
 - **2017-01-04** - `1.2.0` - added [import vouchers](#import-vouchers) method.
 - **2016-12-29** - `1.1.0` - introduced [campaigns api](#campaigns-api) and [products api](#products-api).
@@ -418,6 +507,7 @@ The gem is available as open source under the terms of the [MIT License](http://
 [Enable Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#enable-voucher
 [Disable Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#disable-voucher
 [Import Vouchers]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#import-vouchers-1
+[Add Gift Voucher Balance]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#add-gift-voucher-balance
 
 [Create Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-campaign
 [Get Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-campaign
@@ -425,12 +515,16 @@ The gem is available as open source under the terms of the [MIT License](http://
 [Import Vouchers to Campaign]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#import-vouchers
 
 [Publish Vouchers]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#publish-voucher
+[Create Export]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-export
+[Get Export]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-export
+[Delete Export]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#elete-export
 
 [Validate Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#validate-voucher
 
 [Redeem Voucher]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#redeem-voucher
 [List Redemptions]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-redemptions
 [Get Voucher's Redemptions]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#vouchers-redemptions
+[Get Redemption]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-redemption
 [Rollback Redemption]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#rollback-redemption
 
 [Create Customer]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-customer
@@ -449,3 +543,11 @@ The gem is available as open source under the terms of the [MIT License](http://
 [Delete SKU]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-sku
 [List all product SKUs]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#list-skus
 
+[Create Validation Rules]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-validation-rules
+[Get Validation Rules]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-validation-rules
+[Update Validation Rules]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#update-validation-rules
+[Delete Validation Rules]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-validation-rules
+
+[Create Segment]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#create-segment
+[Get Segment]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#get-segment
+[Delete Segment]: https://docs.voucherify.io/reference?utm_source=github&utm_medium=sdk&utm_campaign=acq#delete-segment

data/lib/voucherify.rb

@@ -5,6 +5,9 @@ require 'voucherify/service/customers'
 require 'voucherify/service/distributions'
 require 'voucherify/service/products'
 require 'voucherify/service/redemptions'
+require 'voucherify/service/segments'
+require 'voucherify/service/segments'
+require 'voucherify/service/validation_rules'
 require 'voucherify/service/validations'
 require 'voucherify/service/vouchers'
 require 'voucherify/utils'

data/lib/voucherify/client.rb

@@ -14,8 +14,9 @@ module Voucherify
           'X-App-Id' => @options[:applicationId] || @options['applicationId'],
           'X-App-Token' => @options[:clientSecretKey] || @options['clientSecretKey'],
           'X-Voucherify-Channel' => 'Ruby-SDK',
-          :accept => :json
-      }
+          'X-Voucherify-API-Version' => @options[:apiVersion] || @options['apiVersion'],
+          :accept => :json,
+      }.reject{ |k,v| v.nil? }
     end
 
     def vouchers
@@ -46,6 +47,14 @@ module Voucherify
       Voucherify::Service::Campaigns.new(self)
     end
 
+    def validation_rules
+      Voucherify::Service::ValidationRules.new(self)
+    end
+
+    def segments
+      Voucherify::Service::Segments.new(self)
+    end
+
     def get(path, params = {})
       begin
         url = @backend_url + path

data/lib/voucherify/service/distributions.rb

@@ -19,6 +19,23 @@ module Voucherify
 
         @client.post('/vouchers/publish', payload.to_json)
       end
+
+      def create_export(export)
+        @client.post('/exports', export)
+      end
+
+      def get_export(id)
+        @client.get("/exports/#{URI.encode(id)}")
+      end
+
+      def delete_export(id)
+        @client.delete("/exports/#{URI.encode(id)}")
+      end
+
+      def list_publications(params = {})
+        @client.get('/publications', params)
+      end
+      
     end
   end
 end

data/lib/voucherify/service/redemptions.rb

@@ -29,6 +29,9 @@ module Voucherify
         @client.post("/redemptions/#{URI.encode(redemption_id)}/rollback", payload.to_json, params)
       end
 
+      def get_redemption(redemption_id)
+        @client.get("/redemptions/#{URI.encode(redemption_id)}")
+      end
     end
   end
 end

data/lib/voucherify/service/segments.rb

@@ -0,0 +1,25 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class Segments
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(segment)
+        @client.post('/segments', segment.to_json)
+      end
+
+      def get(id)
+        @client.get("/segments/#{URI.encode(id)}")
+      end
+
+      def delete(id)
+        @client.delete("/segments/#{URI.encode(id)}")
+      end
+    end
+  end
+end

data/lib/voucherify/service/validation_rules.rb

@@ -0,0 +1,29 @@
+require 'uri'
+
+module Voucherify
+  module Service
+    class ValidationRules
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def create(validation_rules)
+        @client.post('/validation-rules', validation_rules.to_json)
+      end
+
+      def get(id)
+        @client.get("/validation-rules/#{URI.encode(id)}")
+      end
+
+      def update(validation_rules)
+        @client.put("/validation-rules/#{URI.encode(validation_rules['id'] || validation_rules[:id])}", validation_rules.to_json)
+      end
+
+      def delete(id)
+        @client.delete("/validation-rules/#{URI.encode(id)}")
+      end
+    end
+  end
+end

data/lib/voucherify/service/validations.rb

@@ -12,6 +12,7 @@ module Voucherify
       def validate_voucher(code, context = {})
         @client.post("/vouchers/#{URI.encode(code)}/validate", context.to_json)
       end
+      
     end
   end
 end

data/lib/voucherify/service/vouchers.rb

@@ -43,7 +43,11 @@ module Voucherify
       end
 
       def import(vouchers)
-        @client.post('/vouchers/import', vouchers.to_json);
+        @client.post('/vouchers/import', vouchers.to_json)
+      end
+
+      def add_balance(code, balance)
+        @client.post("/vouchers/#{URI.encode(code)}/balance", balance.to_json)
       end
     end
   end

data/lib/voucherify/version.rb

@@ -1,3 +1,3 @@
 module Voucherify
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voucherify
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - pawelrychlik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,8 @@ files:
 - lib/voucherify/service/distributions.rb
 - lib/voucherify/service/products.rb
 - lib/voucherify/service/redemptions.rb
+- lib/voucherify/service/segments.rb
+- lib/voucherify/service/validation_rules.rb
 - lib/voucherify/service/validations.rb
 - lib/voucherify/service/vouchers.rb
 - lib/voucherify/utils.rb