gerencianet 0.0.7 → 0.0.8

data/docs/carnet-cancel.md

@@ -1,20 +0,0 @@
-### Canceling the carnet
-
-Only `active` carnets can be canceled:
-
-```ruby
-params = {
-  id: 1000
-}
-
-gerencianet = Gerencianet.new(options)
-puts gerencianet.cancel_carnet(params: params)
-```
-
-If everything goes well, the return will be:
-
-```ruby
-{
-  "code": 200
-}
-```

data/docs/carnet-create-history.md

@@ -1,27 +0,0 @@
-## Adding information to carnet's history
-
-It is possible to add information to the history of a carnet. These informations will be listed when [detailing a carnet](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/carnet-detailing.md).
-
-The process to add information to history is shown below:
-
-
-```ruby
-params = {
-  id: 1000
-}
-
-body = {
-  description: "Info that will be added to carnet history"
-}
-
-gerencianet = Gerencianet.new(options)
-gerencianet.create_carnet_history(params: params, body: body)
-```
-
-If everything goes well, the return will be:
-
-```ruby
-{
-  "code": 200
-}
-```

data/docs/carnet-detailing.md

@@ -1,61 +0,0 @@
-## Detailing carnets
-
-In order to retrieve carnets, just provide the id:
-
-```ruby
-params = {
-  id: 1000
-}
-
-gerencianet = Gerencianet.new(options)
-puts gerencianet.detail_carnet(params: params)
-```
-
-The response you'll receive contains all the information about the carnet:
-
-```ruby
-{
-  "code": 200,
-  "data": {
-    "carnet_id": 1000,
-    "status": "active",
-    "repeats": 4,
-    "cover": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CC-28333-61428-LEENA9/28333-61428-LEENA9",
-    "value": 8000,
-    "split_items": false,
-    "charges": [{
-        "charge_id": 357,
-        "parcel": "1",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": '2020-12-12',
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61428-LEENA9",
-        "barcode": "00190.00009 01523.894002 00061.428181 1 64780000002000"
-      }, {
-        "charge_id": 358,
-        "parcel": "2",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": '2021-01-12',
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61429-CORZE4",
-        "barcode": "00190.00009 01523.894002 00061.428181 8 65090000002000"
-      }, {
-        "charge_id": 359,
-        "parcel": "3",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": '2021-02-12',
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61430-HIRRA4",
-        "barcode": "00190.00009 01523.894002 00061.428181 7 65400000002000"
-      }, {
-        "charge_id": 360,
-        "parcel": "4",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": '2021-03-12',
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61431-HIRRA4",
-        "barcode": "00190.00009 01523.894002 00061.428181 5 65400000002000"
-      }
-    ]
-  }
-}

data/docs/carnet-resend-parcel.md

@@ -1,27 +0,0 @@
-### Resending carnet parcel
-
-To resend the carnet parcel, the parcel must have a `waiting` status.
-
-If the parcel contemplates this requirement, you just have to provide the carnet id, the parcel number and a email to resend it:
-
-```ruby
-params = {
-  id: 1000,
-  parcel: 1
-}
-
-body = {
-  email: 'oldbuck@gerencianet.com.br'
-}
-
-gerencianet = Gerencianet.new(options)
-puts gerencianet.resend_parcel(params: params, body: body)
-```
-
-If everything goes well, the return will be:
-
-```ruby
-{
-  "code": 200
-}
-```

data/docs/carnet-resend.md

@@ -1,26 +0,0 @@
-### Resending the carnet
-
-To resend the carnet, it must have a `active` status.
-
-If the carnet contemplates this requirement, you just have to provide the carnet id and a email to resend it:
-
-```ruby
-params = {
-  id: 1000
-}
-
-body = {
-  email: 'oldbuck@gerencianet.com.br'
-}
-
-gerencianet = Gerencianet.new(options)
-puts gerencianet.resend_carnet(params: params, body: body)
-```
-
-If everything goes well, the return will be:
-
-```ruby
-{
-  "code": 200
-}
-```

data/docs/carnet-update.md

@@ -1,55 +0,0 @@
-## Updating carnets
-
-### Changing the metadata
-
-You can update the `custom_id` and the `notification_url` of a carnet at any time.
-
-It's important to keep in mind that all the charges of the carnet will be updated. If you want to update only one charge, check [Updating charges](/docs/charge-update.md).
-
-```ruby
-params = {
-  id: 1000
-}
-
-body = {
-  notification_url: "http://yourdomain.com",
-  custom_id: "my_new_id"
-}
-
-gerencianet = Gerencianet.new(options)
-puts gerencianet.update_carnet_metadata(params: params, body: body)
-```
-
-If everything goes well, the response will be:
-
-```ruby
-{
-  "code": 200
-}
-```
-
-### Updating the expiration date of a parcel
-
-Only parcels with status `waiting` or `unpaid` can have expiration date set or updated:
-
-```ruby
-params = {
-  id: 1000,
-  parcel: 1
-}
-
-body = {
-  expire_at: "2020-12-12"
-}
-
-gerencianet = Gerencianet.new(options)
-puts gerencianet.update_parcel(params: params, body: body)
-```
-
-If everything goes well, the response will be:
-
-```ruby
-{
-  "code": 200
-}
-```

data/docs/carnets.md

@@ -1,165 +0,0 @@
-## Creating carnet billets
-
-Carnet is a payment method that generates a bundle of charges with the same payment information and customer.
-
-In order to generate a carnet, you'll need the items, the customer, the expiration date of the first charge and the number of repeats (or parcels).
-
-The carnets can also be generated with the `metadata` attribute, just like in the banking billet, containing the `notification_url` and/or `custom_id`
-
-There are other optional params:
-
-- `split_items`, identifying if the total value must be splitted among the charges (defaults to `false`)
-- The carnet `instructions`
-
-### Required properties:
-
-```ruby
-body = {
-  items: [{
-    name: "Carnet Item 1",
-    value: 1000,
-    amount: 2
-  }],
-  customer: {
-    name: "Gorbadoc Oldbuck",
-    email: "oldbuck@gerencianet.com.br",
-    cpf: "04267484171",
-    birth: "1977-01-15",
-    phone_number: "5144916523"
-  },
-  repeats: 4,
-  expire_at: "2020-12-12"
-}
-```
-
-### Required properties plus metadata **(optional)**:
-
-```ruby
-body = {
-  items: [{
-    name: "Carnet Item 1",
-    value: 1000,
-    amount: 2
-  }],
-  customer: {
-    name: "Gorbadoc Oldbuck",
-    email: "oldbuck@gerencianet.com.br",
-    cpf: "04267484171",
-    birth: "1977-01-15",
-    phone_number: "5144916523"
-  },
-  repeats: 4,
-  expire_at: "2020-12-12",
-  metadata: {
-    custom_id: "my_id",
-    notification_url: "http://yourdomain.com"
-  }
-}
-```
-
-The `notification_url` property will be used for sending notifications once things happen with charges statuses, as when it's payment was approved, for example. More about notifications [here](https://github.com/gerencianet/gn-api-sdk-node/tree/master/docs/notifications.md). The `custom_id` property can be used to set your own reference to the carnet.
-
-### split_items attribute **(optional)**
-
-By default, each parcel has the total value of the carnet. If you want to divide the total value among the parcels, change `split_items` property to *true*.
-
-```ruby
-var body = {
-  items: [{
-    name: "Carnet Item 1",
-    value: 1000,
-    amount: 2
-  }],
-  customer: {
-    name: "Gorbadoc Oldbuck",
-    email: "oldbuck@gerencianet.com.br",
-    cpf: "04267484171",
-    birth: "1977-01-15",
-    phone_number: "5144916523"
-  },
-  repeats: 4,
-  expire_at: "2020-12-12",
-  split_items: true
-}
-```
-
-### Setting instructions **(optional)**
-
-If you want the carnet billet to have extra instructions, it's possible to send a maximum of 4 different instructions with a maximum of 90 caracters, just as follows:
-
-```ruby
-body = {
-  items: [{
-    name: "Carnet Item 1",
-    value: 1000,
-    amount: 2
-  }],
-  customer: {
-    name: "Gorbadoc Oldbuck",
-    email: "oldbuck@gerencianet.com.br",
-    cpf: "04267484171",
-    birth: "1977-01-15",
-    phone_number: "5144916523"
-  },
-  repeats: 4,
-  expire_at: "2020-12-12",
-  instructions: [
-    "Pay only with money",
-    "Do not pay with gold"
-  ]
-}
-```
-
-### Finally, create the carnet:
-
-```ruby
-gerencianet.create_carnet(body: body)
-```
-
-Check out the response:
-
-```ruby
-{
-  "code": 200,
-  "data": {
-    "carnet_id": 1000,
-    "cover": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CC-28333-61428-LEENA9/28333-61428-LEENA9",
-    "charges": [{
-        "charge_id": 357,
-        "parcel": "1",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": "2020-12-12",
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61428-LEENA9",
-        "barcode": "00190.00009 01523.894002 00061.428181 1 64780000002000"
-      }, {
-        "charge_id": 358,
-        "parcel": "2",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": "2021-01-12",
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61429-CORZE4",
-        "barcode": "00190.00009 01523.894002 00061.428181 8 65090000002000"
-      }, {
-        "charge_id": 359,
-        "parcel": "3",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": "2021-02-12",
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61430-HIRRA4",
-        "barcode": "00190.00009 01523.894002 00061.428181 7 65400000002000"
-      }, {
-        "charge_id": 360,
-        "parcel": "4",
-        "status": "waiting",
-        "value": 2000,
-        "expire_at": "2021-03-12",
-        "url": "https://visualizacao.gerencianet.com.br/emissao/28333_2385_ZEMAL5/A5CL-28333-61428-LEENA9/28333-61431-HIRRA4",
-        "barcode": "00190.00009 01523.894002 00061.428181 5 65400000002000"
-      }
-    ]
-  }
-}
-```
-
-Notice that, as the `repeats` were set to 4, the output contains 4 charges with `waiting` status. The value of each charge is the sum of the items values, because the `split_items` property was set to *false*. Also notice that `expire_at` increases monthly.

data/docs/charge-create-history.md

@@ -1,27 +0,0 @@
-## Adding information to charge's history
-
-It is possible to add information to the history of a charge. These informations will be listed when [detailing a charge](https://github.com/gerencianet/gn-api-sdk-ruby/tree/master/docs/charge-detailing.md).
-
-The process to add information to history is shown below:
-
-
-```ruby
-params = {
-  id: 1253
-}
-
-body = {
-  description: "Info that will be added to charges history"
-}
-
-gerencianet = Gerencianet.new(options)
-gerencianet.create_charge_history(params: params, body: body)
-```
-
-If everything goes well, the return will be:
-
-```ruby
-{
-  "code": 200
-}
-```

data/docs/charge-detailing.md

@@ -1,42 +0,0 @@
-## Detailing charges
-
-It's very simple to get details from a charge. You just need the id:
-
-```ruby
-params = {
-  id: 1300
-}
-
-gerencianet = Gerencianet.new(options)
-gerencianet.detail_charge(params: params)
-```
-
-As response, you will receive all the information about the charge (including if it belongs to a subscription or carnet):
-
-```ruby
-{
-  "code": 200,
-  "data": {
-    "charge_id": 1300,
-    "subscription_id": 12,
-    "total": 2000,
-    "status": "new",
-    "custom_id": null,
-    "created_at": "2015-05-14",
-    "notification_url": "http://yourdomain.com",
-    "items": [
-      {
-        "name": "Product 1",
-        "value": 1000,
-        "amount": 2
-      }
-    ],
-    "history": [
-      {
-        "message": "Cobrança criada",
-        "created_at": "2015-05-14 15:39:14"
-      }
-    ]
-  }
-}
-```