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
Copy file name to clipboardExpand all lines: README.md
-90Lines changed: 0 additions & 90 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -216,96 +216,6 @@ client.files.create(
216
216
217
217
The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
218
218
219
-
## Webhook verification
220
-
221
-
Verifying webhook signatures is _optional but encouraged_.
222
-
223
-
For more information about webhooks, see [the API docs](https://increase.com/documentation/webhooks#events-and-webhooks).
224
-
225
-
### Parsing webhook payloads
226
-
227
-
For most use cases, you will likely want to verify the webhook and parse the payload at the same time. To achieve this, we provide the method `client.webhooks.unwrap()`, which parses a webhook request and verifies that it was sent by Increase. This method will raise an error if the signature is invalid.
228
-
229
-
Note that the `body` parameter must be the raw JSON string sent from the server (do not parse it first). The `.unwrap()` method will parse this JSON for you into an event object after verifying the webhook was sent from Increase.
230
-
231
-
```python
232
-
from increase import Increase
233
-
from flask import Flask, request
234
-
235
-
app = Flask(__name__)
236
-
237
-
# You can also configure the webhook secret with any of:
238
-
# - The `INCREASE_WEBHOOK_SECRET` environment variable.
239
-
# - The `webhook_secret` argument to the Increase client.
In some cases, you may want to verify the webhook separately from parsing the payload. If you prefer to handle these steps separately, we provide the method `client.webhooks.verify_signature()` to _only verify_ the signature of a webhook request. Like `.unwrap()`, this method will raise an error if the signature is invalid.
271
-
272
-
Note that the `body` parameter must be the raw JSON string sent from the server (do not parse it first). You will then need to parse the body after verifying the signature.
273
-
274
-
```python
275
-
import json
276
-
from increase import Increase
277
-
from flask import Flask, request
278
-
279
-
app = Flask(__name__)
280
-
281
-
# You can also configure the webhook secret with any of:
282
-
# - The `INCREASE_WEBHOOK_SECRET` environment variable.
283
-
# - The `webhook_secret` argument to the Increase client.
When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `increase.APIConnectionError` is raised.
Please visit https://increase.com/security for our security policy.
3
+
## Reporting Security Issues
4
+
5
+
This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
6
+
7
+
To report a security issue, please contact the Stainless team at security@stainless.com.
8
+
9
+
## Responsible Disclosure
10
+
11
+
We appreciate the efforts of security researchers and individuals who help us maintain the security of
12
+
SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
13
+
disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
14
+
before making any information public.
15
+
16
+
## Reporting Non-SDK Related Security Issues
17
+
18
+
If you encounter security issues that are not directly related to SDKs but pertain to the services
19
+
or products provided by Increase, please follow the respective company's security reporting guidelines.
20
+
21
+
### Increase Terms and Policies
22
+
23
+
Please contact dev-feedback@increase.com for any questions or concerns regarding the security of our services.
24
+
25
+
---
26
+
27
+
Thank you for helping us keep the SDKs and systems they interact with secure.
0 commit comments