gn-api-sdk-node - npm Package Compare versions

Comparing version 0.0.15 to 0.0.16

CHANGELOG.md

@@ -0,1 +1,6 @@
+# 0.0.16
+- Added: new endpoint (cancel carnet)
+- Added: new endpoint (cancel parcel)
+- Updated: docs
+
 # 0.0.15
@@ -2,0 +7,0 @@ - Added: new endpoint (carnet history)

docs/carnets.md

@@ -11,3 +11,2 @@ ## Creating carnet billets
 
-- `post_office_service`, which tells if the carnet must be sent via post office service (to you or to your clients)
 - `split_items`, identifying if the total value must be splitted among the charges (defaults to `false`)
@@ -71,31 +70,2 @@ - The carnet `instructions`
 
-### Required properties plus post office service information **(optional)**:
-
-If you want the carnet to arrive at your house or at your client's house, you can count on Gerencianet's post office service. Just send an extra attribute:
-
-```js
-var body = {
-  items: [{
-    name: 'Carnet Item 1',
-    value: 1000,
-    amount: 2
-  }],
-  customer: {
-    name: 'Gorbadoc Oldbuck',
-    email: '[e-mail]',
-    cpf: '04267484171',
-    birth: '1977-01-15',
-    phone_number: '5144916523'
-  },
-  repeats: 4,
-  expire_at: '2020-06-01',
-  post_office_service: {
-    send_to: 'customer'
-  }
-}
-```
-
-If `send_to` is set to *customer*, the carnet arrives at you customer's. If it is set to *seller*, just wait for it to arrive at your place!
-
-
 ### split_items attribute **(optional)**
@@ -102,0 +72,0 @@

docs/charge-payment.md

@@ -153,3 +153,3 @@ ## Paying charges
 
-For web apps you should follow this [guide](https://api.gerencianet.com.br/checkout/card). It basically consists of copying/pasting a script tag in your checkout page.
+For web apps you should follow this [guide](https://docs.gerencianet.com.br/#!/charges/checkout/card). It basically consists of copying/pasting a script tag in your checkout page.
 
@@ -156,0 +156,0 @@ For mobile apps you should use this [SDK for Android](https://github.com/gerencianet/gn-api-sdk-android) or this [SDK for iOS](https://github.com/gerencianet/gn-api-sdk-ios).

docs/charges.md

@@ -61,21 +61,2 @@ ## Creating charges
 
-## Post office service:
-
-If you want the charge to arrive at your house or at your client's house, you can count on Gerencianet's post office service. Just send an extra attribute:
-
-```js
-var body = {
-  items: [{
-    name: 'Product A',
-    value: 1000,
-    amount: 2
-  }],
-  post_office_service: {
-    send_to: 'customer'
-  }
-}
-```
-
-If `send_to` is set to *customer*, the charge arrives at you customer's. If it is set to *seller*, just wait for it to arrive at your place. It's awesome!
-
 ### Finally, create the charge:
@@ -82,0 +63,0 @@

lib/gn-constants.js

@@ -112,4 +112,12 @@ 'use strict';
       method: 'post'
+    },
+    cancelCarnet: {
+      route: '/carnet/:id/cancel',
+      method: 'put'
+    },
+    cancelParcel: {
+      route: '/carnet/:id/parcel/:parcel/cancel',
+      method: 'put'
     }
   }
 };

package.json

 {
   "name": "gn-api-sdk-node",
   "description": "Module for integration with Gerencianet API",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "author": "Francisco Carvalho <[e-mail]>",
@@ -44,2 +44,2 @@ "license": "MIT",
   }
-}
+}

README.md

@@ -120,2 +120,4 @@ # gn-api-sdk-node
 - [Adding information to carnet history](https://github.com/gerencianet/gn-api-sdk-node/tree/master/docs/carnet-create-history.md)
+- [Canceling the carnet](https://github.com/gerencianet/gn-api-sdk-node/tree/master/docs/carnet-cancel.md)
+- [Canceling carnet parcel](https://github.com/gerencianet/gn-api-sdk-node/tree/master/docs/carnet-cancel-parcel.md)
 
@@ -122,0 +124,0 @@ ### Subscriptions

No alert changes

Improved metrics

Number of package files

70

increased by4.48%

Lines of code

1342

increased by3.15%

Number of lines in readme file

153

increased by1.32%

Worsened metrics

Total package byte prevSize

88742

decreased by-0.84%

No dependency changes