Skip to content

Commit

Permalink
update all api documentation links to the latest version of the API
Browse files Browse the repository at this point in the history
  • Loading branch information
fredericdelordm committed May 11, 2021
1 parent 2eea1a9 commit f3a9227
Show file tree
Hide file tree
Showing 32 changed files with 125 additions and 286 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Usage inside your app

api.Users.create(...)

Supported options
Supported options
-------------------------------------------------
| Option | Default value | Description |
| -------- | ----------- | ----------- |
Expand All @@ -39,7 +39,7 @@ Supported options
Documentation
-------------------------------------------------
[Github Full Node.js SDK Documentation](docs/README.md) is located in ``/docs`` folder.
You can also access [API References on our website](https://docs.mangopay.com/api-references/).
You can also access [API References on our website](https://docs.mangopay.com/endpoints/).

License
-------------------------------------------------
Expand Down Expand Up @@ -127,7 +127,7 @@ Here is how they can be implemented :
```

### Pagination / Filtering
In order to [paginate](https://docs.mangopay.com/api-references/pagination/) or [filter](https://docs.mangopay.com/api-references/sort-lists/) results,
In order to [paginate or filter](https://docs.mangopay.com/guide/lists-pagination-management) results,
we can use ``options.parameters`` to specify these options:
```ts
api.Transactions.getAll({
Expand Down
18 changes: 4 additions & 14 deletions docs/CardPreAuthorizations.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# CardPreAuthorizations

[MangoPay Card Pre-Authorizations API Reference](https://docs.mangopay.com/api-references/card/pre-authorization/)
[MangoPay Card Pre-Authorizations API Reference](https://docs.mangopay.com/endpoints/v2.01/preauthorizations)



* * *

### CardPreAuthorizations.create(cardPreAuthorization, callback, options)
### CardPreAuthorizations.create(cardPreAuthorization, callback, options)

Create new pre-authorization

Expand All @@ -21,7 +21,7 @@ Create new pre-authorization
**Returns**: `Object`, Promise of the request


### CardPreAuthorizations.get(cardPreAuthorizationId, callback, options)
### CardPreAuthorizations.get(cardPreAuthorizationId, callback, options)

Get pre-authorization object

Expand All @@ -36,7 +36,7 @@ Get pre-authorization object
**Returns**: `Object`, Request promise


### CardPreAuthorizations.update(cardPreAuthorization, callback, options)
### CardPreAuthorizations.update(cardPreAuthorization, callback, options)

Update pre-authorization object

Expand All @@ -53,13 +53,3 @@ Update pre-authorization object


* * *










18 changes: 4 additions & 14 deletions docs/CardRegistrations.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# CardRegistrations

[MangoPay Card Registration API Reference](https://docs.mangopay.com/api-references/card-registration/)
[MangoPay Card Registration API Reference](https://docs.mangopay.com/endpoints/v2.01/cards)



* * *

### CardRegistrations.create(cardRegistration, callback, options)
### CardRegistrations.create(cardRegistration, callback, options)

Create new card registration

Expand All @@ -21,7 +21,7 @@ Create new card registration
**Returns**: `Object`, Promise of the request


### CardRegistrations.get(cardRegistrationId, callback, options)
### CardRegistrations.get(cardRegistrationId, callback, options)

Get registration

Expand All @@ -36,7 +36,7 @@ Get registration
**Returns**: `Object`, Request promise


### CardRegistrations.update(cardRegistration, callback, options)
### CardRegistrations.update(cardRegistration, callback, options)

Update card registration

Expand All @@ -53,13 +53,3 @@ Update card registration


* * *










22 changes: 6 additions & 16 deletions docs/Cards.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Cards

[MangoPay Cards API Reference](https://docs.mangopay.com/api-references/card/)
[MangoPay Cards API Reference](https://docs.mangopay.com/endpoints/v2.01/cards#e177_the-card-registration-object)



* * *

### Cards.get(cardId, callback, options)
### Cards.get(cardId, callback, options)

Get card

Expand All @@ -21,7 +21,7 @@ Get card
**Returns**: `Object`, Request promise


### Cards.getByFingerprint(fingerprint)
### Cards.getByFingerprint(fingerprint)

Gets a list of cards having the same fingerprint.
The fingerprint is a hash uniquely generated per 16-digit card number.
Expand All @@ -33,7 +33,7 @@ The fingerprint is a hash uniquely generated per 16-digit card number.
**Returns**: , List of Cards corresponding to provided fingerprint


### Cards.update(card, callback, options)
### Cards.update(card, callback, options)

Update card

Expand All @@ -48,7 +48,7 @@ Update card
**Returns**: `Object`, Request promise


### Cards.getTransactions(cardId, callback, options)
### Cards.getTransactions(cardId, callback, options)

Get list of Transactions of a Card

Expand All @@ -63,7 +63,7 @@ Get list of Transactions of a Card
**Returns**: `object`, Request promise


### Cards.getPreAuthorizations(cardId, callback, options)
### Cards.getPreAuthorizations(cardId, callback, options)

Gets list of PreAuthorizations of a Card.

Expand All @@ -80,13 +80,3 @@ Gets list of PreAuthorizations of a Card.


* * *










18 changes: 4 additions & 14 deletions docs/DisputeDocuments.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# DisputeDocuments

[MangoPay Dispute Documents API Reference](https://docs.mangopay.com/api-references/disputes/dispute-documents/)
[MangoPay Dispute Documents API Reference](https://docs.mangopay.com/endpoints/v2/dispute-documents#e214_the-dispute-document-object)



* * *

### DisputeDocuments.get(documentId, callback, options)
### DisputeDocuments.get(documentId, callback, options)

Gets dispute's document

Expand All @@ -21,7 +21,7 @@ Gets dispute's document
**Returns**: `Object`, Request promise


### DisputeDocuments.getAll(callback, options)
### DisputeDocuments.getAll(callback, options)

Gets dispute's documents for client

Expand All @@ -34,7 +34,7 @@ Gets dispute's documents for client
**Returns**: `Object`, Request promise


### DisputeDocuments.createDisputeDocumentConsult(documentId, callback, options)
### DisputeDocuments.createDisputeDocumentConsult(documentId, callback, options)

Creates temporary URLs where each page of a dispute document can be viewed.

Expand All @@ -51,13 +51,3 @@ Creates temporary URLs where each page of a dispute document can be viewed.


* * *










Loading

0 comments on commit f3a9227

Please sign in to comment.