vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Support square-connect@3.x API typings (#43468)

Browse Source
This commit is contained in:
Dmitri Dimitrioglo 2020-03-31 20:06:19 +03:00 committed by GitHub
parent 9986a0cc66
commit 29d6b019ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2136 additions and 3141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
types/square-connect/README.md
View File

@ -1,21 +1,25 @@
# Type definitions for square-connect
This is an unofficial package of type definitions for [square-connect][1] which is _mostly_ generated automatically by [swagger-codegen][2].
In case you are facing some issues - feel free to contribute or open an issue.
This is an unofficial package of type definitions for [square-connect][1].
Initially, it was generated by [swagger-codegen][2] but currently it requires to be updated manually and takes a lot of time.
Hence, you may encounter typings update delays in contrast to the official library.
To keep me motivated you can [buy me a beer][6] 😉
# Installation
`npm i @types/square-connect`
> make sure that `square-connect` package is installed too
> in @types/square-connect@3.x all API-v1 related typings were removed, if you need them - install @types/square-connect@2.x
# @todo
* Declare `ApiClient` properly
* Declare methods definition for missing classes (ex: `export class SomeApi {}`)
* Change `any`s in methods definitions (ex: `doSomething(...args: Array<any>)`) regarding the [docs][5]
# Contribution
If you are facing some issues or you have an idea how to improve typings - feel free to contribute or open an issue.
* Clone the [DefinitelyTyped][3] project
* or update if you already have it (`git fetch upstream && git reset --hard upstream/master`)
* Add your changes and commit them (in case of error in [api.json][4] too, let the Square team know about it)
@ -28,3 +32,4 @@ In case you are facing some issues - feel free to contribute or open an issue.
[3]: https://github.com/DefinitelyTyped/DefinitelyTyped
[4]: https://github.com/square/connect-api-specification/blob/master/api.json
[5]: https://github.com/square/connect-nodejs-sdk#documentation-for-api-endpoints
[6]: https://paypal.me/dimitrioglo

5264
types/square-connect/index.d.ts vendored
View File

File diff suppressed because it is too large Load Diff