Skip to content
This repository has been archived by the owner on Jun 15, 2020. It is now read-only.

Update docs with new features #38

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

edtoken
Copy link
Contributor

@edtoken edtoken commented Jan 24, 2020

Checks:

  • Have you checked the dependencies list?
  • Have you checked the examples page?
  • Have you checked the build command?
  • Have you checked with the default environment configuration?

Description

Changes

  • Update configuration add changelog link
  • Replace bankAccount with bban
  • Add organizationId configuration property
  • Add bic and bankName details
  • Add changelog content

@edtoken
Copy link
Contributor Author

edtoken commented Jan 24, 2020

A few screens with some parts of updates
Снимок экрана 2020-01-25 в 0 23 36

Снимок экрана 2020-01-25 в 1 05 22

Снимок экрана 2020-01-25 в 0 22 23

@edtoken edtoken requested a review from a team February 10, 2020 13:00
@edtoken edtoken added the enhancement New feature or request label Feb 10, 2020
@edtoken edtoken self-assigned this Feb 10, 2020
@edtoken edtoken marked this pull request as ready for review February 10, 2020 13:00
@@ -1,7 +1,7 @@
(function () {
Rebilly.initialize({
publishableKey: 'pk_sandbox_1234567890',
locale: Rebilly.locales.es,
locale: 'es-ES',
Copy link

@rensftw rensftw Feb 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good 👌 but it depends on the i18n refactoring in FramePay, which is not released yet (see internal FramePay PR #203).
If this gets merged, the docs will not be working properly anymore - perhaps we should consider shipping this update separately, once there are no blockers.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(There's a few different places doing this in the PR)

docs/changelog.md Outdated Show resolved Hide resolved

## 91 (2020-01-20)
### Added
- `bic` and `bankName` element types for `Rebilly.bban` and `Rebilly.iban` namespace
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `bic` and `bankName` element types for `Rebilly.bban` and `Rebilly.iban` namespace
- `bic` and `bankName` element types for the `Rebilly.bban` and `Rebilly.iban` namespaces.

## 91 (2020-01-20)
### Added
- `bic` and `bankName` element types for `Rebilly.bban` and `Rebilly.iban` namespace
see [Rebilly.bban.mount](./reference/rebilly.md#rebilly-bban-mount) and [Rebilly.iban.mount](./reference/rebilly.md#rebilly-iban-mount)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
see [Rebilly.bban.mount](./reference/rebilly.md#rebilly-bban-mount) and [Rebilly.iban.mount](./reference/rebilly.md#rebilly-iban-mount)
See [Rebilly.bban.mount](./reference/rebilly.md#rebilly-bban-mount) and [Rebilly.iban.mount](./reference/rebilly.md#rebilly-iban-mount).

## 90 (2020-01-14)
### Deprecated
- `Rebilly.bankAccount` namespace.
The namespace `Rebilly.bankAccount` deprecated but still works, this namespace moved to `Rebilly.bban` namespace with changes of element type names.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The namespace `Rebilly.bankAccount` deprecated but still works, this namespace moved to `Rebilly.bban` namespace with changes of element type names.
The namespace `Rebilly.bankAccount` is now deprecated, but it currently still works. This namespace is now moved to the `Rebilly.bban` namespace and there are changes to the names of element type.


```javascript
{
publishableKey:'',
publishableKey: 'String, required',
organizationId: 'String, no-required',
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
organizationId: 'String, no-required',
organizationId: 'String, optional',


## 92 (2020-01-24)
### Added
- `organizationId` configuration property (String, no-required) see [configuration.organizationId](./configuration/properties.md#organizationid)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `organizationId` configuration property (String, no-required) see [configuration.organizationId](./configuration/properties.md#organizationid)
- `organizationId` configuration property (String, optional). See [configuration.organizationId](./configuration/properties.md#organizationid).

@@ -10,21 +10,35 @@ A Rebilly publishable <a href="https://app.rebilly.com/api-keys/add">API key</a>

<<< @/docs/.vuepress/public/examples/example-publishablekey-1/index.js

## organizationId
Your organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Your organization identifier in scope of which need to perform request (if not specified, the default organization will be used).
Your organization identifier, in the scope of which requests are performed. (If it is not specified, the default organization will be used).

- `emails`

---
Only for the [BBAN](./rebilly.md#rebilly-bban-mount) and [IBAN](./rebilly.md#rebilly-iban-mount) methods we support additional fields `bic` and `bankName` that can be automatically gathered by FramePay if they are present within the form with a `data-rebilly` attribute:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Only for the [BBAN](./rebilly.md#rebilly-bban-mount) and [IBAN](./rebilly.md#rebilly-iban-mount) methods we support additional fields `bic` and `bankName` that can be automatically gathered by FramePay if they are present within the form with a `data-rebilly` attribute:
Exclusively for the [BBAN](./rebilly.md#rebilly-bban-mount) and [IBAN](./rebilly.md#rebilly-iban-mount) methods we support the additional fields `bic` and `bankName`, which can be automatically gathered by FramePay if they are present within the form with a `data-rebilly` attribute:


---

For example, to collect the `firstName` and `lastName` when the token is created you can setup your form as follows:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, to collect the `firstName` and `lastName` when the token is created you can setup your form as follows:
For example, to collect the `firstName` and `lastName` when the token is created, you can setup your form as follows:

Co-Authored-By: Irena Angelova <rensftw@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants