You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We welcome bug reports, feature requests, and code contributions in a pull request.
5
+
6
+
For most pull requests, we request that you identify or create an associated issue that has the necessary context. We use these issues to reach agreement on an approach and save the PR author from having to redo work. Fixing typos or documentation issues likely do not need an issue; for any issue that introduces substantial code changes, changes the public interface, or if you aren't sure, please find or [create an issue](https://www.github.com/stripe/stripe-go/issues/new/choose).
7
+
8
+
## Contributor License Agreement
9
+
10
+
All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agreement, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant.
11
+
12
+
## Generated code
13
+
14
+
This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution.
15
+
16
+
To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`.
17
+
18
+
## Compatibility with supported language and runtime versions
19
+
20
+
This project supports [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward.
21
+
22
+
## Set up your dev environment
23
+
24
+
Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment.
See more examples in the [/example/v2 folder](example/v2).
632
632
633
633
## Support
@@ -641,19 +641,15 @@ the following guidelines in mind:
641
641
642
642
1. Code must be `go fmt` compliant.
643
643
2. All types, structs and funcs should be documented.
644
-
3. Ensure that `make test` succeeds.
645
-
646
-
## Test
644
+
3. Ensure that `just test` succeeds.
647
645
648
-
The test suite needs testify's `require` package to run:
646
+
[Other contribution guidelines for this project](CONTRIBUTING.md)
649
647
650
-
github.com/stretchr/testify/require
651
-
652
-
Before running the tests, make sure to grab all of the package's dependencies:
648
+
## Test
653
649
654
-
go get -t -v
650
+
We use [just](https://github.com/casey/just) for conveniently running development tasks. You can use them directly, or copy the commands out of the `justfile`. To our help docs, run `just`.
655
651
656
-
It also depends on [stripe-mock][stripe-mock], so make sure to fetch and run it from a
652
+
This package depends on [stripe-mock][stripe-mock], so make sure to fetch and run it from a
657
653
background terminal ([stripe-mock's README][stripe-mock-usage] also contains
658
654
instructions for installing via Homebrew and other methods):
659
655
@@ -662,15 +658,24 @@ instructions for installing via Homebrew and other methods):
662
658
663
659
Run all tests:
664
660
665
-
make test
661
+
```sh
662
+
just test
663
+
# or: go test ./...
664
+
```
666
665
667
666
Run tests for one package:
668
667
669
-
go test ./invoice
668
+
```sh
669
+
just test ./invoice
670
+
# or: go test ./invoice
671
+
```
670
672
671
673
Run a single test:
672
674
673
-
go test ./invoice -run TestInvoiceGet
675
+
```sh
676
+
just test ./invoice -run TestInvoiceGet
677
+
# or: go test ./invoice -run TestInvoiceGet
678
+
```
674
679
675
680
For any requests, bug or comments, please [open an issue][issues] or [submit a
// Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
// Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -836,6 +842,8 @@ type AccountCapabilitiesParams struct {
// Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
960
980
DirectorsProvided*bool`form:"directors_provided"`
961
981
// Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
@@ -1035,6 +1055,12 @@ type AccountDocumentsProofOfRegistrationParams struct {
1035
1055
Files []*string`form:"files"`
1036
1056
}
1037
1057
1058
+
// One or more documents that demonstrate proof of ultimate beneficial ownership.
// One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
1061
+
Files []*string`form:"files"`
1062
+
}
1063
+
1038
1064
// Documents that may be submitted to satisfy various informational requests.
1039
1065
typeAccountDocumentsParamsstruct {
1040
1066
// One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a check.
@@ -1051,6 +1077,8 @@ type AccountDocumentsParams struct {
0 commit comments