@crevio/sdk 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -12
- package/RUNTIMES.md +6 -6
- package/dist/commonjs/funcs/accountsGet.js +1 -1
- package/dist/commonjs/funcs/accountsGet.js.map +1 -1
- package/dist/commonjs/funcs/checkoutsCreate.js +1 -1
- package/dist/commonjs/funcs/checkoutsCreate.js.map +1 -1
- package/dist/commonjs/funcs/productsGet.js +1 -1
- package/dist/commonjs/funcs/productsGet.js.map +1 -1
- package/dist/commonjs/funcs/productsList.js +2 -2
- package/dist/commonjs/funcs/productsList.js.map +1 -1
- package/dist/commonjs/funcs/userDelete.js +1 -1
- package/dist/commonjs/funcs/userDelete.js.map +1 -1
- package/dist/commonjs/funcs/userGet.js +1 -1
- package/dist/commonjs/funcs/userGet.js.map +1 -1
- package/dist/commonjs/hooks/hooks.d.ts.map +1 -1
- package/dist/commonjs/hooks/hooks.js +0 -2
- package/dist/commonjs/hooks/hooks.js.map +1 -1
- package/dist/commonjs/lib/base64.d.ts +1 -1
- package/dist/commonjs/lib/base64.d.ts.map +1 -1
- package/dist/commonjs/lib/base64.js +1 -1
- package/dist/commonjs/lib/base64.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +4 -4
- package/dist/commonjs/lib/config.d.ts.map +1 -1
- package/dist/commonjs/lib/config.js +5 -5
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/lib/encodings.d.ts +1 -0
- package/dist/commonjs/lib/encodings.d.ts.map +1 -1
- package/dist/commonjs/lib/encodings.js +12 -1
- package/dist/commonjs/lib/encodings.js.map +1 -1
- package/dist/commonjs/lib/env.d.ts +1 -1
- package/dist/commonjs/lib/env.d.ts.map +1 -1
- package/dist/commonjs/lib/env.js +19 -2
- package/dist/commonjs/lib/env.js.map +1 -1
- package/dist/commonjs/lib/schemas.d.ts +1 -1
- package/dist/commonjs/lib/schemas.d.ts.map +1 -1
- package/dist/commonjs/lib/schemas.js +2 -2
- package/dist/commonjs/lib/schemas.js.map +1 -1
- package/dist/commonjs/lib/security.d.ts.map +1 -1
- package/dist/commonjs/lib/security.js.map +1 -1
- package/dist/commonjs/lib/url.js +1 -1
- package/dist/commonjs/lib/url.js.map +1 -1
- package/dist/commonjs/models/account.d.ts +4 -29
- package/dist/commonjs/models/account.d.ts.map +1 -1
- package/dist/commonjs/models/account.js +2 -34
- package/dist/commonjs/models/account.js.map +1 -1
- package/dist/commonjs/models/accountslim.d.ts +1 -22
- package/dist/commonjs/models/accountslim.d.ts.map +1 -1
- package/dist/commonjs/models/accountslim.js +2 -23
- package/dist/commonjs/models/accountslim.js.map +1 -1
- package/dist/commonjs/models/checkoutrequest.d.ts +1 -48
- package/dist/commonjs/models/checkoutrequest.d.ts.map +1 -1
- package/dist/commonjs/models/checkoutrequest.js +2 -78
- package/dist/commonjs/models/checkoutrequest.js.map +1 -1
- package/dist/commonjs/models/checkoutresponse.d.ts +1 -21
- package/dist/commonjs/models/checkoutresponse.d.ts.map +1 -1
- package/dist/commonjs/models/checkoutresponse.js +2 -27
- package/dist/commonjs/models/checkoutresponse.js.map +1 -1
- package/dist/commonjs/models/errors/error.d.ts +1 -20
- package/dist/commonjs/models/errors/error.d.ts.map +1 -1
- package/dist/commonjs/models/errors/error.js +2 -20
- package/dist/commonjs/models/errors/error.js.map +1 -1
- package/dist/commonjs/models/errors/index.d.ts +1 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/models/errors/index.js +1 -0
- package/dist/commonjs/models/errors/index.js.map +1 -1
- package/dist/commonjs/models/errors/responsevalidationerror.js +1 -1
- package/dist/commonjs/models/errors/responsevalidationerror.js.map +1 -1
- package/dist/commonjs/models/errors/sdkvalidationerror.d.ts +1 -1
- package/dist/commonjs/models/errors/sdkvalidationerror.d.ts.map +1 -1
- package/dist/commonjs/models/errors/sdkvalidationerror.js +1 -1
- package/dist/commonjs/models/errors/sdkvalidationerror.js.map +1 -1
- package/dist/commonjs/models/fileattachment.d.ts +1 -24
- package/dist/commonjs/models/fileattachment.d.ts.map +1 -1
- package/dist/commonjs/models/fileattachment.js +2 -30
- package/dist/commonjs/models/fileattachment.js.map +1 -1
- package/dist/commonjs/models/imageattachment.d.ts +1 -24
- package/dist/commonjs/models/imageattachment.d.ts.map +1 -1
- package/dist/commonjs/models/imageattachment.js +2 -30
- package/dist/commonjs/models/imageattachment.js.map +1 -1
- package/dist/commonjs/models/linkinbiopage.d.ts +1 -22
- package/dist/commonjs/models/linkinbiopage.d.ts.map +1 -1
- package/dist/commonjs/models/linkinbiopage.js +2 -23
- package/dist/commonjs/models/linkinbiopage.js.map +1 -1
- package/dist/commonjs/models/operations/delete.d.ts +1 -18
- package/dist/commonjs/models/operations/delete.d.ts.map +1 -1
- package/dist/commonjs/models/operations/delete.js +2 -19
- package/dist/commonjs/models/operations/delete.js.map +1 -1
- package/dist/commonjs/models/operations/getaccount.d.ts +1 -18
- package/dist/commonjs/models/operations/getaccount.d.ts.map +1 -1
- package/dist/commonjs/models/operations/getaccount.js +2 -26
- package/dist/commonjs/models/operations/getaccount.js.map +1 -1
- package/dist/commonjs/models/operations/getproduct.d.ts +1 -18
- package/dist/commonjs/models/operations/getproduct.d.ts.map +1 -1
- package/dist/commonjs/models/operations/getproduct.js +2 -26
- package/dist/commonjs/models/operations/getproduct.js.map +1 -1
- package/dist/commonjs/models/pricevariant.d.ts +1 -27
- package/dist/commonjs/models/pricevariant.d.ts.map +1 -1
- package/dist/commonjs/models/pricevariant.js +2 -32
- package/dist/commonjs/models/pricevariant.js.map +1 -1
- package/dist/commonjs/models/product.d.ts +8 -62
- package/dist/commonjs/models/product.d.ts.map +1 -1
- package/dist/commonjs/models/product.js +3 -61
- package/dist/commonjs/models/product.js.map +1 -1
- package/dist/commonjs/models/review.d.ts +1 -23
- package/dist/commonjs/models/review.d.ts.map +1 -1
- package/dist/commonjs/models/review.js +2 -28
- package/dist/commonjs/models/review.js.map +1 -1
- package/dist/commonjs/models/security.d.ts +1 -18
- package/dist/commonjs/models/security.d.ts.map +1 -1
- package/dist/commonjs/models/security.js +2 -26
- package/dist/commonjs/models/security.js.map +1 -1
- package/dist/commonjs/models/seo.d.ts +1 -22
- package/dist/commonjs/models/seo.d.ts.map +1 -1
- package/dist/commonjs/models/seo.js +2 -24
- package/dist/commonjs/models/seo.js.map +1 -1
- package/dist/commonjs/models/sociallink.d.ts +1 -23
- package/dist/commonjs/models/sociallink.d.ts.map +1 -1
- package/dist/commonjs/models/sociallink.js +2 -24
- package/dist/commonjs/models/sociallink.js.map +1 -1
- package/dist/commonjs/models/user.d.ts +3 -39
- package/dist/commonjs/models/user.d.ts.map +1 -1
- package/dist/commonjs/models/user.js +2 -54
- package/dist/commonjs/models/user.js.map +1 -1
- package/dist/commonjs/types/blobs.d.ts +1 -1
- package/dist/commonjs/types/blobs.d.ts.map +1 -1
- package/dist/commonjs/types/blobs.js +1 -1
- package/dist/commonjs/types/blobs.js.map +1 -1
- package/dist/commonjs/types/constdatetime.d.ts +1 -1
- package/dist/commonjs/types/constdatetime.d.ts.map +1 -1
- package/dist/commonjs/types/constdatetime.js +1 -1
- package/dist/commonjs/types/constdatetime.js.map +1 -1
- package/dist/commonjs/types/enums.d.ts +8 -11
- package/dist/commonjs/types/enums.d.ts.map +1 -1
- package/dist/commonjs/types/enums.js +59 -3
- package/dist/commonjs/types/enums.js.map +1 -1
- package/dist/commonjs/types/index.d.ts +2 -2
- package/dist/commonjs/types/index.d.ts.map +1 -1
- package/dist/commonjs/types/index.js +16 -3
- package/dist/commonjs/types/index.js.map +1 -1
- package/dist/commonjs/types/unrecognized.d.ts +16 -0
- package/dist/commonjs/types/unrecognized.d.ts.map +1 -0
- package/dist/commonjs/types/unrecognized.js +34 -0
- package/dist/commonjs/types/unrecognized.js.map +1 -0
- package/dist/esm/funcs/accountsGet.js +1 -1
- package/dist/esm/funcs/accountsGet.js.map +1 -1
- package/dist/esm/funcs/checkoutsCreate.js +1 -1
- package/dist/esm/funcs/checkoutsCreate.js.map +1 -1
- package/dist/esm/funcs/productsGet.js +1 -1
- package/dist/esm/funcs/productsGet.js.map +1 -1
- package/dist/esm/funcs/productsList.js +2 -2
- package/dist/esm/funcs/productsList.js.map +1 -1
- package/dist/esm/funcs/userDelete.js +1 -1
- package/dist/esm/funcs/userDelete.js.map +1 -1
- package/dist/esm/funcs/userGet.js +1 -1
- package/dist/esm/funcs/userGet.js.map +1 -1
- package/dist/esm/hooks/hooks.d.ts.map +1 -1
- package/dist/esm/hooks/hooks.js +0 -2
- package/dist/esm/hooks/hooks.js.map +1 -1
- package/dist/esm/lib/base64.d.ts +1 -1
- package/dist/esm/lib/base64.d.ts.map +1 -1
- package/dist/esm/lib/base64.js +1 -1
- package/dist/esm/lib/base64.js.map +1 -1
- package/dist/esm/lib/config.d.ts +4 -4
- package/dist/esm/lib/config.d.ts.map +1 -1
- package/dist/esm/lib/config.js +5 -5
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/lib/encodings.d.ts +1 -0
- package/dist/esm/lib/encodings.d.ts.map +1 -1
- package/dist/esm/lib/encodings.js +12 -1
- package/dist/esm/lib/encodings.js.map +1 -1
- package/dist/esm/lib/env.d.ts +1 -1
- package/dist/esm/lib/env.d.ts.map +1 -1
- package/dist/esm/lib/env.js +19 -2
- package/dist/esm/lib/env.js.map +1 -1
- package/dist/esm/lib/schemas.d.ts +1 -1
- package/dist/esm/lib/schemas.d.ts.map +1 -1
- package/dist/esm/lib/schemas.js +1 -1
- package/dist/esm/lib/schemas.js.map +1 -1
- package/dist/esm/lib/security.d.ts.map +1 -1
- package/dist/esm/lib/security.js.map +1 -1
- package/dist/esm/lib/url.js +1 -1
- package/dist/esm/lib/url.js.map +1 -1
- package/dist/esm/models/account.d.ts +4 -29
- package/dist/esm/models/account.d.ts.map +1 -1
- package/dist/esm/models/account.js +4 -35
- package/dist/esm/models/account.js.map +1 -1
- package/dist/esm/models/accountslim.d.ts +1 -22
- package/dist/esm/models/accountslim.d.ts.map +1 -1
- package/dist/esm/models/accountslim.js +1 -21
- package/dist/esm/models/accountslim.js.map +1 -1
- package/dist/esm/models/checkoutrequest.d.ts +1 -48
- package/dist/esm/models/checkoutrequest.d.ts.map +1 -1
- package/dist/esm/models/checkoutrequest.js +1 -74
- package/dist/esm/models/checkoutrequest.js.map +1 -1
- package/dist/esm/models/checkoutresponse.d.ts +1 -21
- package/dist/esm/models/checkoutresponse.d.ts.map +1 -1
- package/dist/esm/models/checkoutresponse.js +1 -25
- package/dist/esm/models/checkoutresponse.js.map +1 -1
- package/dist/esm/models/errors/error.d.ts +1 -20
- package/dist/esm/models/errors/error.d.ts.map +1 -1
- package/dist/esm/models/errors/error.js +1 -19
- package/dist/esm/models/errors/error.js.map +1 -1
- package/dist/esm/models/errors/index.d.ts +1 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -1
- package/dist/esm/models/errors/index.js +1 -0
- package/dist/esm/models/errors/index.js.map +1 -1
- package/dist/esm/models/errors/responsevalidationerror.js +1 -1
- package/dist/esm/models/errors/responsevalidationerror.js.map +1 -1
- package/dist/esm/models/errors/sdkvalidationerror.d.ts +1 -1
- package/dist/esm/models/errors/sdkvalidationerror.d.ts.map +1 -1
- package/dist/esm/models/errors/sdkvalidationerror.js +1 -1
- package/dist/esm/models/errors/sdkvalidationerror.js.map +1 -1
- package/dist/esm/models/fileattachment.d.ts +1 -24
- package/dist/esm/models/fileattachment.d.ts.map +1 -1
- package/dist/esm/models/fileattachment.js +1 -28
- package/dist/esm/models/fileattachment.js.map +1 -1
- package/dist/esm/models/imageattachment.d.ts +1 -24
- package/dist/esm/models/imageattachment.d.ts.map +1 -1
- package/dist/esm/models/imageattachment.js +1 -28
- package/dist/esm/models/imageattachment.js.map +1 -1
- package/dist/esm/models/linkinbiopage.d.ts +1 -22
- package/dist/esm/models/linkinbiopage.d.ts.map +1 -1
- package/dist/esm/models/linkinbiopage.js +1 -21
- package/dist/esm/models/linkinbiopage.js.map +1 -1
- package/dist/esm/models/operations/delete.d.ts +1 -18
- package/dist/esm/models/operations/delete.d.ts.map +1 -1
- package/dist/esm/models/operations/delete.js +1 -17
- package/dist/esm/models/operations/delete.js.map +1 -1
- package/dist/esm/models/operations/getaccount.d.ts +1 -18
- package/dist/esm/models/operations/getaccount.d.ts.map +1 -1
- package/dist/esm/models/operations/getaccount.js +1 -24
- package/dist/esm/models/operations/getaccount.js.map +1 -1
- package/dist/esm/models/operations/getproduct.d.ts +1 -18
- package/dist/esm/models/operations/getproduct.d.ts.map +1 -1
- package/dist/esm/models/operations/getproduct.js +1 -24
- package/dist/esm/models/operations/getproduct.js.map +1 -1
- package/dist/esm/models/pricevariant.d.ts +1 -27
- package/dist/esm/models/pricevariant.d.ts.map +1 -1
- package/dist/esm/models/pricevariant.js +1 -30
- package/dist/esm/models/pricevariant.js.map +1 -1
- package/dist/esm/models/product.d.ts +8 -62
- package/dist/esm/models/product.d.ts.map +1 -1
- package/dist/esm/models/product.js +8 -65
- package/dist/esm/models/product.js.map +1 -1
- package/dist/esm/models/review.d.ts +1 -23
- package/dist/esm/models/review.d.ts.map +1 -1
- package/dist/esm/models/review.js +1 -26
- package/dist/esm/models/review.js.map +1 -1
- package/dist/esm/models/security.d.ts +1 -18
- package/dist/esm/models/security.d.ts.map +1 -1
- package/dist/esm/models/security.js +1 -24
- package/dist/esm/models/security.js.map +1 -1
- package/dist/esm/models/seo.d.ts +1 -22
- package/dist/esm/models/seo.d.ts.map +1 -1
- package/dist/esm/models/seo.js +1 -22
- package/dist/esm/models/seo.js.map +1 -1
- package/dist/esm/models/sociallink.d.ts +1 -23
- package/dist/esm/models/sociallink.d.ts.map +1 -1
- package/dist/esm/models/sociallink.js +1 -22
- package/dist/esm/models/sociallink.js.map +1 -1
- package/dist/esm/models/user.d.ts +3 -39
- package/dist/esm/models/user.d.ts.map +1 -1
- package/dist/esm/models/user.js +3 -54
- package/dist/esm/models/user.js.map +1 -1
- package/dist/esm/types/blobs.d.ts +1 -1
- package/dist/esm/types/blobs.d.ts.map +1 -1
- package/dist/esm/types/blobs.js +1 -1
- package/dist/esm/types/blobs.js.map +1 -1
- package/dist/esm/types/constdatetime.d.ts +1 -1
- package/dist/esm/types/constdatetime.d.ts.map +1 -1
- package/dist/esm/types/constdatetime.js +1 -1
- package/dist/esm/types/constdatetime.js.map +1 -1
- package/dist/esm/types/enums.d.ts +8 -11
- package/dist/esm/types/enums.d.ts.map +1 -1
- package/dist/esm/types/enums.js +22 -2
- package/dist/esm/types/enums.js.map +1 -1
- package/dist/esm/types/index.d.ts +2 -2
- package/dist/esm/types/index.d.ts.map +1 -1
- package/dist/esm/types/index.js +1 -1
- package/dist/esm/types/index.js.map +1 -1
- package/dist/esm/types/unrecognized.d.ts +16 -0
- package/dist/esm/types/unrecognized.d.ts.map +1 -0
- package/dist/esm/types/unrecognized.js +31 -0
- package/dist/esm/types/unrecognized.js.map +1 -0
- package/examples/package-lock.json +4 -4
- package/examples/userGet.example.ts +2 -2
- package/jsr.json +1 -1
- package/package.json +4 -4
- package/src/funcs/accountsGet.ts +1 -1
- package/src/funcs/checkoutsCreate.ts +1 -1
- package/src/funcs/productsGet.ts +1 -1
- package/src/funcs/productsList.ts +2 -2
- package/src/funcs/userDelete.ts +1 -1
- package/src/funcs/userGet.ts +1 -1
- package/src/hooks/hooks.ts +0 -3
- package/src/lib/base64.ts +1 -1
- package/src/lib/config.ts +5 -5
- package/src/lib/encodings.ts +17 -3
- package/src/lib/env.ts +21 -5
- package/src/lib/schemas.ts +1 -1
- package/src/lib/security.ts +4 -1
- package/src/lib/url.ts +1 -1
- package/src/models/account.ts +3 -65
- package/src/models/accountslim.ts +1 -36
- package/src/models/checkoutrequest.ts +1 -120
- package/src/models/checkoutresponse.ts +1 -43
- package/src/models/errors/error.ts +1 -32
- package/src/models/errors/index.ts +1 -0
- package/src/models/errors/responsevalidationerror.ts +1 -1
- package/src/models/errors/sdkvalidationerror.ts +1 -1
- package/src/models/fileattachment.ts +1 -45
- package/src/models/imageattachment.ts +1 -47
- package/src/models/linkinbiopage.ts +1 -36
- package/src/models/operations/delete.ts +1 -28
- package/src/models/operations/getaccount.ts +1 -40
- package/src/models/operations/getproduct.ts +1 -40
- package/src/models/pricevariant.ts +1 -50
- package/src/models/product.ts +6 -117
- package/src/models/review.ts +1 -42
- package/src/models/security.ts +1 -40
- package/src/models/seo.ts +1 -33
- package/src/models/sociallink.ts +1 -38
- package/src/models/user.ts +2 -87
- package/src/types/blobs.ts +7 -6
- package/src/types/constdatetime.ts +1 -1
- package/src/types/enums.ts +38 -9
- package/src/types/index.ts +2 -2
- package/src/types/unrecognized.ts +35 -0
- package/tsconfig.json +0 -1
- package/.devcontainer/README.md +0 -30
- package/docs/sdks/accounts/README.md +0 -84
- package/docs/sdks/checkouts/README.md +0 -96
- package/docs/sdks/crevio/README.md +0 -7
- package/docs/sdks/products/README.md +0 -154
- package/docs/sdks/user/README.md +0 -149
- package/examples/README.md +0 -31
|
@@ -1,154 +0,0 @@
|
|
|
1
|
-
# Products
|
|
2
|
-
(*products*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
Digital product catalog
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [list](#list) - List products
|
|
11
|
-
* [get](#get) - Get product details
|
|
12
|
-
|
|
13
|
-
## list
|
|
14
|
-
|
|
15
|
-
Returns a list of published products for the current account
|
|
16
|
-
|
|
17
|
-
### Example Usage
|
|
18
|
-
|
|
19
|
-
<!-- UsageSnippet language="typescript" operationID="list" method="get" path="/products" -->
|
|
20
|
-
```typescript
|
|
21
|
-
import { Crevio } from "@crevio/sdk";
|
|
22
|
-
|
|
23
|
-
const crevio = new Crevio({
|
|
24
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
async function run() {
|
|
28
|
-
const result = await crevio.products.list();
|
|
29
|
-
|
|
30
|
-
console.log(result);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
run();
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
### Standalone function
|
|
37
|
-
|
|
38
|
-
The standalone function version of this method:
|
|
39
|
-
|
|
40
|
-
```typescript
|
|
41
|
-
import { CrevioCore } from "@crevio/sdk/core.js";
|
|
42
|
-
import { productsList } from "@crevio/sdk/funcs/productsList.js";
|
|
43
|
-
|
|
44
|
-
// Use `CrevioCore` for best tree-shaking performance.
|
|
45
|
-
// You can create one instance of it to use across an application.
|
|
46
|
-
const crevio = new CrevioCore({
|
|
47
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
async function run() {
|
|
51
|
-
const res = await productsList(crevio);
|
|
52
|
-
if (res.ok) {
|
|
53
|
-
const { value: result } = res;
|
|
54
|
-
console.log(result);
|
|
55
|
-
} else {
|
|
56
|
-
console.log("productsList failed:", res.error);
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
run();
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
### Parameters
|
|
64
|
-
|
|
65
|
-
| Parameter | Type | Required | Description |
|
|
66
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
67
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
68
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
69
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
70
|
-
|
|
71
|
-
### Response
|
|
72
|
-
|
|
73
|
-
**Promise\<[models.Product[]](../../models/.md)\>**
|
|
74
|
-
|
|
75
|
-
### Errors
|
|
76
|
-
|
|
77
|
-
| Error Type | Status Code | Content Type |
|
|
78
|
-
| ------------------------- | ------------------------- | ------------------------- |
|
|
79
|
-
| errors.ErrorT | 401, 404 | application/json |
|
|
80
|
-
| errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
|
|
81
|
-
|
|
82
|
-
## get
|
|
83
|
-
|
|
84
|
-
Returns detailed information about a specific product
|
|
85
|
-
|
|
86
|
-
### Example Usage
|
|
87
|
-
|
|
88
|
-
<!-- UsageSnippet language="typescript" operationID="getProduct" method="get" path="/products/{prefix_id}" -->
|
|
89
|
-
```typescript
|
|
90
|
-
import { Crevio } from "@crevio/sdk";
|
|
91
|
-
|
|
92
|
-
const crevio = new Crevio({
|
|
93
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
async function run() {
|
|
97
|
-
const result = await crevio.products.get({
|
|
98
|
-
prefixId: "prod_xyz456",
|
|
99
|
-
});
|
|
100
|
-
|
|
101
|
-
console.log(result);
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
run();
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### Standalone function
|
|
108
|
-
|
|
109
|
-
The standalone function version of this method:
|
|
110
|
-
|
|
111
|
-
```typescript
|
|
112
|
-
import { CrevioCore } from "@crevio/sdk/core.js";
|
|
113
|
-
import { productsGet } from "@crevio/sdk/funcs/productsGet.js";
|
|
114
|
-
|
|
115
|
-
// Use `CrevioCore` for best tree-shaking performance.
|
|
116
|
-
// You can create one instance of it to use across an application.
|
|
117
|
-
const crevio = new CrevioCore({
|
|
118
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
async function run() {
|
|
122
|
-
const res = await productsGet(crevio, {
|
|
123
|
-
prefixId: "prod_xyz456",
|
|
124
|
-
});
|
|
125
|
-
if (res.ok) {
|
|
126
|
-
const { value: result } = res;
|
|
127
|
-
console.log(result);
|
|
128
|
-
} else {
|
|
129
|
-
console.log("productsGet failed:", res.error);
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
run();
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Parameters
|
|
137
|
-
|
|
138
|
-
| Parameter | Type | Required | Description |
|
|
139
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
140
|
-
| `request` | [operations.GetProductRequest](../../models/operations/getproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
141
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
142
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
143
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
144
|
-
|
|
145
|
-
### Response
|
|
146
|
-
|
|
147
|
-
**Promise\<[models.Product](../../models/product.md)\>**
|
|
148
|
-
|
|
149
|
-
### Errors
|
|
150
|
-
|
|
151
|
-
| Error Type | Status Code | Content Type |
|
|
152
|
-
| ------------------------- | ------------------------- | ------------------------- |
|
|
153
|
-
| errors.ErrorT | 401, 404 | application/json |
|
|
154
|
-
| errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
|
package/docs/sdks/user/README.md
DELETED
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
# User
|
|
2
|
-
(*user*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
User account management
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [get](#get) - Get current user information
|
|
11
|
-
* [delete](#delete) - Delete current user account
|
|
12
|
-
|
|
13
|
-
## get
|
|
14
|
-
|
|
15
|
-
Returns the profile information of the authenticated user
|
|
16
|
-
|
|
17
|
-
### Example Usage
|
|
18
|
-
|
|
19
|
-
<!-- UsageSnippet language="typescript" operationID="getMe" method="get" path="/me" -->
|
|
20
|
-
```typescript
|
|
21
|
-
import { Crevio } from "@crevio/sdk";
|
|
22
|
-
|
|
23
|
-
const crevio = new Crevio({
|
|
24
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
async function run() {
|
|
28
|
-
const result = await crevio.user.get();
|
|
29
|
-
|
|
30
|
-
console.log(result);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
run();
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
### Standalone function
|
|
37
|
-
|
|
38
|
-
The standalone function version of this method:
|
|
39
|
-
|
|
40
|
-
```typescript
|
|
41
|
-
import { CrevioCore } from "@crevio/sdk/core.js";
|
|
42
|
-
import { userGet } from "@crevio/sdk/funcs/userGet.js";
|
|
43
|
-
|
|
44
|
-
// Use `CrevioCore` for best tree-shaking performance.
|
|
45
|
-
// You can create one instance of it to use across an application.
|
|
46
|
-
const crevio = new CrevioCore({
|
|
47
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
48
|
-
});
|
|
49
|
-
|
|
50
|
-
async function run() {
|
|
51
|
-
const res = await userGet(crevio);
|
|
52
|
-
if (res.ok) {
|
|
53
|
-
const { value: result } = res;
|
|
54
|
-
console.log(result);
|
|
55
|
-
} else {
|
|
56
|
-
console.log("userGet failed:", res.error);
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
run();
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
### Parameters
|
|
64
|
-
|
|
65
|
-
| Parameter | Type | Required | Description |
|
|
66
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
67
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
68
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
69
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
70
|
-
|
|
71
|
-
### Response
|
|
72
|
-
|
|
73
|
-
**Promise\<[models.User](../../models/user.md)\>**
|
|
74
|
-
|
|
75
|
-
### Errors
|
|
76
|
-
|
|
77
|
-
| Error Type | Status Code | Content Type |
|
|
78
|
-
| ------------------------- | ------------------------- | ------------------------- |
|
|
79
|
-
| errors.ErrorT | 401 | application/json |
|
|
80
|
-
| errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
|
|
81
|
-
|
|
82
|
-
## delete
|
|
83
|
-
|
|
84
|
-
Permanently deletes the authenticated user account
|
|
85
|
-
|
|
86
|
-
### Example Usage
|
|
87
|
-
|
|
88
|
-
<!-- UsageSnippet language="typescript" operationID="delete" method="delete" path="/me" -->
|
|
89
|
-
```typescript
|
|
90
|
-
import { Crevio } from "@crevio/sdk";
|
|
91
|
-
|
|
92
|
-
const crevio = new Crevio({
|
|
93
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
async function run() {
|
|
97
|
-
const result = await crevio.user.delete();
|
|
98
|
-
|
|
99
|
-
console.log(result);
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
run();
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### Standalone function
|
|
106
|
-
|
|
107
|
-
The standalone function version of this method:
|
|
108
|
-
|
|
109
|
-
```typescript
|
|
110
|
-
import { CrevioCore } from "@crevio/sdk/core.js";
|
|
111
|
-
import { userDelete } from "@crevio/sdk/funcs/userDelete.js";
|
|
112
|
-
|
|
113
|
-
// Use `CrevioCore` for best tree-shaking performance.
|
|
114
|
-
// You can create one instance of it to use across an application.
|
|
115
|
-
const crevio = new CrevioCore({
|
|
116
|
-
apiKeyAuth: process.env["CREVIO_API_KEY_AUTH"] ?? "",
|
|
117
|
-
});
|
|
118
|
-
|
|
119
|
-
async function run() {
|
|
120
|
-
const res = await userDelete(crevio);
|
|
121
|
-
if (res.ok) {
|
|
122
|
-
const { value: result } = res;
|
|
123
|
-
console.log(result);
|
|
124
|
-
} else {
|
|
125
|
-
console.log("userDelete failed:", res.error);
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
run();
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
### Parameters
|
|
133
|
-
|
|
134
|
-
| Parameter | Type | Required | Description |
|
|
135
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
136
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
137
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
138
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
139
|
-
|
|
140
|
-
### Response
|
|
141
|
-
|
|
142
|
-
**Promise\<[operations.DeleteResponse](../../models/operations/deleteresponse.md)\>**
|
|
143
|
-
|
|
144
|
-
### Errors
|
|
145
|
-
|
|
146
|
-
| Error Type | Status Code | Content Type |
|
|
147
|
-
| ------------------------- | ------------------------- | ------------------------- |
|
|
148
|
-
| errors.ErrorT | 401 | application/json |
|
|
149
|
-
| errors.CrevioDefaultError | 4XX, 5XX | \*/\* |
|
package/examples/README.md
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# @crevio/sdk Examples
|
|
2
|
-
|
|
3
|
-
This directory contains example scripts demonstrating how to use the @crevio/sdk SDK.
|
|
4
|
-
|
|
5
|
-
## Prerequisites
|
|
6
|
-
|
|
7
|
-
- Node.js (v18 or higher)
|
|
8
|
-
- npm
|
|
9
|
-
|
|
10
|
-
## Setup
|
|
11
|
-
|
|
12
|
-
1. Copy `.env.template` to `.env`:
|
|
13
|
-
```bash
|
|
14
|
-
cp .env.template .env
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
|
|
18
|
-
|
|
19
|
-
## Running the Examples
|
|
20
|
-
|
|
21
|
-
To run an example file from the examples directory:
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npm run build && npx tsx example.ts
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Creating new examples
|
|
28
|
-
|
|
29
|
-
Duplicate an existing example file, they won't be overwritten by the generation process.
|
|
30
|
-
|
|
31
|
-
|