@usethrottle/api-client 2.0.0 → 2.1.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 +3 -3
- package/dist/generated/index.d.ts +2 -0
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js +1 -0
- package/dist/generated/index.js.map +1 -1
- package/dist/generated/models/EnvironmentIdHeader.d.ts +5 -0
- package/dist/generated/models/EnvironmentIdHeader.d.ts.map +1 -0
- package/dist/generated/models/EnvironmentIdHeader.js +2 -0
- package/dist/generated/models/EnvironmentIdHeader.js.map +1 -0
- package/dist/generated/services/AffiliatesService.d.ts +8 -4
- package/dist/generated/services/AffiliatesService.d.ts.map +1 -1
- package/dist/generated/services/AffiliatesService.js +20 -4
- package/dist/generated/services/AffiliatesService.js.map +1 -1
- package/dist/generated/services/ApiKeysService.d.ts +6 -3
- package/dist/generated/services/ApiKeysService.d.ts.map +1 -1
- package/dist/generated/services/ApiKeysService.js +15 -3
- package/dist/generated/services/ApiKeysService.js.map +1 -1
- package/dist/generated/services/ApplicationEmailSettingsService.d.ts +12 -6
- package/dist/generated/services/ApplicationEmailSettingsService.d.ts.map +1 -1
- package/dist/generated/services/ApplicationEmailSettingsService.js +30 -6
- package/dist/generated/services/ApplicationEmailSettingsService.js.map +1 -1
- package/dist/generated/services/ApplicationEmailTemplatesService.d.ts +14 -7
- package/dist/generated/services/ApplicationEmailTemplatesService.d.ts.map +1 -1
- package/dist/generated/services/ApplicationEmailTemplatesService.js +35 -7
- package/dist/generated/services/ApplicationEmailTemplatesService.js.map +1 -1
- package/dist/generated/services/ApplicationsService.d.ts +14 -7
- package/dist/generated/services/ApplicationsService.d.ts.map +1 -1
- package/dist/generated/services/ApplicationsService.js +35 -7
- package/dist/generated/services/ApplicationsService.js.map +1 -1
- package/dist/generated/services/AuditService.d.ts +2 -1
- package/dist/generated/services/AuditService.d.ts.map +1 -1
- package/dist/generated/services/AuditService.js +5 -1
- package/dist/generated/services/AuditService.js.map +1 -1
- package/dist/generated/services/AuthService.d.ts +2 -1
- package/dist/generated/services/AuthService.d.ts.map +1 -1
- package/dist/generated/services/AuthService.js +5 -1
- package/dist/generated/services/AuthService.js.map +1 -1
- package/dist/generated/services/BigCommerceService.d.ts +8 -4
- package/dist/generated/services/BigCommerceService.d.ts.map +1 -1
- package/dist/generated/services/BigCommerceService.js +20 -4
- package/dist/generated/services/BigCommerceService.js.map +1 -1
- package/dist/generated/services/CartsService.d.ts +30 -15
- package/dist/generated/services/CartsService.d.ts.map +1 -1
- package/dist/generated/services/CartsService.js +75 -15
- package/dist/generated/services/CartsService.js.map +1 -1
- package/dist/generated/services/CheckoutSessionsService.d.ts +24 -12
- package/dist/generated/services/CheckoutSessionsService.d.ts.map +1 -1
- package/dist/generated/services/CheckoutSessionsService.js +60 -12
- package/dist/generated/services/CheckoutSessionsService.js.map +1 -1
- package/dist/generated/services/ConnectorsService.d.ts +26 -13
- package/dist/generated/services/ConnectorsService.d.ts.map +1 -1
- package/dist/generated/services/ConnectorsService.js +65 -13
- package/dist/generated/services/ConnectorsService.js.map +1 -1
- package/dist/generated/services/CustomersService.d.ts +34 -17
- package/dist/generated/services/CustomersService.d.ts.map +1 -1
- package/dist/generated/services/CustomersService.js +85 -17
- package/dist/generated/services/CustomersService.js.map +1 -1
- package/dist/generated/services/DefaultService.d.ts +98 -49
- package/dist/generated/services/DefaultService.d.ts.map +1 -1
- package/dist/generated/services/DefaultService.js +245 -49
- package/dist/generated/services/DefaultService.js.map +1 -1
- package/dist/generated/services/DiscountsService.d.ts +14 -7
- package/dist/generated/services/DiscountsService.d.ts.map +1 -1
- package/dist/generated/services/DiscountsService.js +35 -7
- package/dist/generated/services/DiscountsService.js.map +1 -1
- package/dist/generated/services/EmailSettingsService.d.ts +12 -6
- package/dist/generated/services/EmailSettingsService.d.ts.map +1 -1
- package/dist/generated/services/EmailSettingsService.js +30 -6
- package/dist/generated/services/EmailSettingsService.js.map +1 -1
- package/dist/generated/services/EmailTemplatesService.d.ts +16 -8
- package/dist/generated/services/EmailTemplatesService.d.ts.map +1 -1
- package/dist/generated/services/EmailTemplatesService.js +40 -8
- package/dist/generated/services/EmailTemplatesService.js.map +1 -1
- package/dist/generated/services/EmbedService.d.ts +4 -2
- package/dist/generated/services/EmbedService.d.ts.map +1 -1
- package/dist/generated/services/EmbedService.js +10 -2
- package/dist/generated/services/EmbedService.js.map +1 -1
- package/dist/generated/services/EventsService.d.ts +4 -2
- package/dist/generated/services/EventsService.d.ts.map +1 -1
- package/dist/generated/services/EventsService.js +10 -2
- package/dist/generated/services/EventsService.js.map +1 -1
- package/dist/generated/services/ExtensionsService.d.ts +28 -10
- package/dist/generated/services/ExtensionsService.d.ts.map +1 -1
- package/dist/generated/services/ExtensionsService.js +50 -10
- package/dist/generated/services/ExtensionsService.js.map +1 -1
- package/dist/generated/services/FulfillmentsService.d.ts +20 -10
- package/dist/generated/services/FulfillmentsService.d.ts.map +1 -1
- package/dist/generated/services/FulfillmentsService.js +50 -10
- package/dist/generated/services/FulfillmentsService.js.map +1 -1
- package/dist/generated/services/MerchantService.d.ts +10 -5
- package/dist/generated/services/MerchantService.d.ts.map +1 -1
- package/dist/generated/services/MerchantService.js +25 -5
- package/dist/generated/services/MerchantService.js.map +1 -1
- package/dist/generated/services/MerchantsService.d.ts +2 -1
- package/dist/generated/services/MerchantsService.d.ts.map +1 -1
- package/dist/generated/services/MerchantsService.js +5 -1
- package/dist/generated/services/MerchantsService.js.map +1 -1
- package/dist/generated/services/OrdersService.d.ts +22 -11
- package/dist/generated/services/OrdersService.d.ts.map +1 -1
- package/dist/generated/services/OrdersService.js +55 -11
- package/dist/generated/services/OrdersService.js.map +1 -1
- package/dist/generated/services/OrganizationsService.d.ts +8 -4
- package/dist/generated/services/OrganizationsService.d.ts.map +1 -1
- package/dist/generated/services/OrganizationsService.js +20 -4
- package/dist/generated/services/OrganizationsService.js.map +1 -1
- package/dist/generated/services/PartnerSeatsService.d.ts +6 -3
- package/dist/generated/services/PartnerSeatsService.d.ts.map +1 -1
- package/dist/generated/services/PartnerSeatsService.js +15 -3
- package/dist/generated/services/PartnerSeatsService.js.map +1 -1
- package/dist/generated/services/PartnersService.d.ts +16 -8
- package/dist/generated/services/PartnersService.d.ts.map +1 -1
- package/dist/generated/services/PartnersService.js +40 -8
- package/dist/generated/services/PartnersService.js.map +1 -1
- package/dist/generated/services/PaymentMethodsService.d.ts +4 -2
- package/dist/generated/services/PaymentMethodsService.d.ts.map +1 -1
- package/dist/generated/services/PaymentMethodsService.js +10 -2
- package/dist/generated/services/PaymentMethodsService.js.map +1 -1
- package/dist/generated/services/PaymentsService.d.ts +38 -19
- package/dist/generated/services/PaymentsService.d.ts.map +1 -1
- package/dist/generated/services/PaymentsService.js +95 -19
- package/dist/generated/services/PaymentsService.js.map +1 -1
- package/dist/generated/services/StoresService.d.ts +8 -4
- package/dist/generated/services/StoresService.d.ts.map +1 -1
- package/dist/generated/services/StoresService.js +20 -4
- package/dist/generated/services/StoresService.js.map +1 -1
- package/dist/generated/services/SubscriptionsService.d.ts +16 -8
- package/dist/generated/services/SubscriptionsService.d.ts.map +1 -1
- package/dist/generated/services/SubscriptionsService.js +40 -8
- package/dist/generated/services/SubscriptionsService.js.map +1 -1
- package/dist/generated/services/TeamService.d.ts +30 -15
- package/dist/generated/services/TeamService.d.ts.map +1 -1
- package/dist/generated/services/TeamService.js +75 -15
- package/dist/generated/services/TeamService.js.map +1 -1
- package/dist/generated/services/WebhooksInboundService.d.ts +2 -1
- package/dist/generated/services/WebhooksInboundService.d.ts.map +1 -1
- package/dist/generated/services/WebhooksInboundService.js +5 -1
- package/dist/generated/services/WebhooksInboundService.js.map +1 -1
- package/dist/generated/services/WebhooksOutboundService.d.ts +14 -7
- package/dist/generated/services/WebhooksOutboundService.d.ts.map +1 -1
- package/dist/generated/services/WebhooksOutboundService.js +35 -7
- package/dist/generated/services/WebhooksOutboundService.js.map +1 -1
- package/dist/generated/services/WebhooksService.d.ts +20 -7
- package/dist/generated/services/WebhooksService.d.ts.map +1 -1
- package/dist/generated/services/WebhooksService.js +35 -7
- package/dist/generated/services/WebhooksService.js.map +1 -1
- package/dist/generated/services/WorkspaceEnvironmentsService.d.ts +97 -0
- package/dist/generated/services/WorkspaceEnvironmentsService.d.ts.map +1 -0
- package/dist/generated/services/WorkspaceEnvironmentsService.js +86 -0
- package/dist/generated/services/WorkspaceEnvironmentsService.js.map +1 -0
- package/dist/generated/services/WorkspaceService.d.ts +2 -1
- package/dist/generated/services/WorkspaceService.d.ts.map +1 -1
- package/dist/generated/services/WorkspaceService.js +5 -1
- package/dist/generated/services/WorkspaceService.js.map +1 -1
- package/dist/generated/services/WorkspacesService.d.ts +10 -5
- package/dist/generated/services/WorkspacesService.d.ts.map +1 -1
- package/dist/generated/services/WorkspacesService.js +25 -5
- package/dist/generated/services/WorkspacesService.js.map +1 -1
- package/package.json +10 -10
|
@@ -4,13 +4,17 @@ export class WorkspacesService {
|
|
|
4
4
|
/**
|
|
5
5
|
* Create a new workspace; the calling user becomes owner
|
|
6
6
|
* @param requestBody
|
|
7
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
7
8
|
* @returns any Default Response
|
|
8
9
|
* @throws ApiError
|
|
9
10
|
*/
|
|
10
|
-
static postApiV1Workspaces(requestBody) {
|
|
11
|
+
static postApiV1Workspaces(requestBody, xThrottleEnvironmentId) {
|
|
11
12
|
return __request(OpenAPI, {
|
|
12
13
|
method: 'POST',
|
|
13
14
|
url: '/api/v1/workspaces',
|
|
15
|
+
headers: {
|
|
16
|
+
'X-Throttle-Environment-Id': xThrottleEnvironmentId,
|
|
17
|
+
},
|
|
14
18
|
body: requestBody,
|
|
15
19
|
mediaType: 'application/json',
|
|
16
20
|
errors: {
|
|
@@ -21,28 +25,36 @@ export class WorkspacesService {
|
|
|
21
25
|
}
|
|
22
26
|
/**
|
|
23
27
|
* List workspaces the authenticated user is a member of
|
|
28
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
24
29
|
* @returns any Default Response
|
|
25
30
|
* @throws ApiError
|
|
26
31
|
*/
|
|
27
|
-
static getApiV1Workspaces() {
|
|
32
|
+
static getApiV1Workspaces(xThrottleEnvironmentId) {
|
|
28
33
|
return __request(OpenAPI, {
|
|
29
34
|
method: 'GET',
|
|
30
35
|
url: '/api/v1/workspaces',
|
|
36
|
+
headers: {
|
|
37
|
+
'X-Throttle-Environment-Id': xThrottleEnvironmentId,
|
|
38
|
+
},
|
|
31
39
|
});
|
|
32
40
|
}
|
|
33
41
|
/**
|
|
34
42
|
* Get a single workspace by ID (must be a member)
|
|
35
43
|
* @param workspaceId
|
|
44
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
36
45
|
* @returns any Default Response
|
|
37
46
|
* @throws ApiError
|
|
38
47
|
*/
|
|
39
|
-
static getApiV1Workspaces1(workspaceId) {
|
|
48
|
+
static getApiV1Workspaces1(workspaceId, xThrottleEnvironmentId) {
|
|
40
49
|
return __request(OpenAPI, {
|
|
41
50
|
method: 'GET',
|
|
42
51
|
url: '/api/v1/workspaces/{workspaceId}',
|
|
43
52
|
path: {
|
|
44
53
|
'workspaceId': workspaceId,
|
|
45
54
|
},
|
|
55
|
+
headers: {
|
|
56
|
+
'X-Throttle-Environment-Id': xThrottleEnvironmentId,
|
|
57
|
+
},
|
|
46
58
|
errors: {
|
|
47
59
|
403: `Default Response`,
|
|
48
60
|
404: `Default Response`,
|
|
@@ -53,16 +65,20 @@ export class WorkspacesService {
|
|
|
53
65
|
* Update workspace name or slug (must be a member)
|
|
54
66
|
* @param workspaceId
|
|
55
67
|
* @param requestBody
|
|
68
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
56
69
|
* @returns any Default Response
|
|
57
70
|
* @throws ApiError
|
|
58
71
|
*/
|
|
59
|
-
static patchApiV1Workspaces(workspaceId, requestBody) {
|
|
72
|
+
static patchApiV1Workspaces(workspaceId, requestBody, xThrottleEnvironmentId) {
|
|
60
73
|
return __request(OpenAPI, {
|
|
61
74
|
method: 'PATCH',
|
|
62
75
|
url: '/api/v1/workspaces/{workspaceId}',
|
|
63
76
|
path: {
|
|
64
77
|
'workspaceId': workspaceId,
|
|
65
78
|
},
|
|
79
|
+
headers: {
|
|
80
|
+
'X-Throttle-Environment-Id': xThrottleEnvironmentId,
|
|
81
|
+
},
|
|
66
82
|
body: requestBody,
|
|
67
83
|
mediaType: 'application/json',
|
|
68
84
|
errors: {
|
|
@@ -75,17 +91,21 @@ export class WorkspacesService {
|
|
|
75
91
|
/**
|
|
76
92
|
* Delete a workspace (must be a member; pass ?force=true to cascade-delete applications)
|
|
77
93
|
* @param workspaceId
|
|
94
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
78
95
|
* @param force
|
|
79
96
|
* @returns void
|
|
80
97
|
* @throws ApiError
|
|
81
98
|
*/
|
|
82
|
-
static deleteApiV1Workspaces(workspaceId, force) {
|
|
99
|
+
static deleteApiV1Workspaces(workspaceId, xThrottleEnvironmentId, force) {
|
|
83
100
|
return __request(OpenAPI, {
|
|
84
101
|
method: 'DELETE',
|
|
85
102
|
url: '/api/v1/workspaces/{workspaceId}',
|
|
86
103
|
path: {
|
|
87
104
|
'workspaceId': workspaceId,
|
|
88
105
|
},
|
|
106
|
+
headers: {
|
|
107
|
+
'X-Throttle-Environment-Id': xThrottleEnvironmentId,
|
|
108
|
+
},
|
|
89
109
|
query: {
|
|
90
110
|
'force': force,
|
|
91
111
|
},
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WorkspacesService.js","sourceRoot":"","sources":["../../../src/generated/services/WorkspacesService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,iBAAiB;IAC1B
|
|
1
|
+
{"version":3,"file":"WorkspacesService.js","sourceRoot":"","sources":["../../../src/generated/services/WorkspacesService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,iBAAiB;IAC1B;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAC7B,WAUC,EACD,sBAA+B;QAiB/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,oBAAoB;YACzB,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,kBAAkB;aAC1B;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAC5B,sBAA+B;QAkB/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,oBAAoB;YACzB,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAC7B,WAAmB,EACnB,sBAA+B;QAiB/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,kCAAkC;YACvC,IAAI,EAAE;gBACF,aAAa,EAAE,WAAW;aAC7B;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,kBAAkB;aAC1B;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,oBAAoB,CAC9B,WAAmB,EACnB,WAGC,EACD,sBAA+B;QAiB/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,OAAO;YACf,GAAG,EAAE,kCAAkC;YACvC,IAAI,EAAE;gBACF,aAAa,EAAE,WAAW;aAC7B;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACJ,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,kBAAkB;aAC1B;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAC/B,WAAmB,EACnB,sBAA+B,EAC/B,KAAwB;QAExB,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,kCAAkC;YACvC,IAAI,EAAE;gBACF,aAAa,EAAE,WAAW;aAC7B;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,KAAK,EAAE;gBACH,OAAO,EAAE,KAAK;aACjB;YACD,MAAM,EAAE;gBACJ,GAAG,EAAE,kBAAkB;gBACvB,GAAG,EAAE,kBAAkB;aAC1B;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@usethrottle/api-client",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Typed REST client for the Throttle API (auto-generated from OpenAPI 3.1)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -10,14 +10,6 @@
|
|
|
10
10
|
"dist",
|
|
11
11
|
"README.md"
|
|
12
12
|
],
|
|
13
|
-
"scripts": {
|
|
14
|
-
"generate": "node scripts/generate.mjs",
|
|
15
|
-
"generate:live": "THROTTLE_OPENAPI_URL=https://api.usethrottle.dev/docs/json pnpm run generate",
|
|
16
|
-
"build": "pnpm run generate && tsc",
|
|
17
|
-
"dev": "tsc --watch",
|
|
18
|
-
"smoke:native-esm": "pnpm run build && node scripts/native-esm-smoke.mjs",
|
|
19
|
-
"test": "pnpm run generate && tsc --noEmit && vitest run --passWithNoTests"
|
|
20
|
-
},
|
|
21
13
|
"devDependencies": {
|
|
22
14
|
"@types/node": "^20.0.0",
|
|
23
15
|
"openapi-typescript-codegen": "^0.29.0",
|
|
@@ -29,5 +21,13 @@
|
|
|
29
21
|
},
|
|
30
22
|
"engines": {
|
|
31
23
|
"node": ">=20"
|
|
24
|
+
},
|
|
25
|
+
"scripts": {
|
|
26
|
+
"generate": "node scripts/generate.mjs",
|
|
27
|
+
"generate:live": "THROTTLE_OPENAPI_URL=https://api.usethrottle.dev/docs/json pnpm run generate",
|
|
28
|
+
"build": "node scripts/with-generated-client.mjs build",
|
|
29
|
+
"dev": "tsc --watch",
|
|
30
|
+
"smoke:native-esm": "pnpm run build && node scripts/native-esm-smoke.mjs",
|
|
31
|
+
"test": "node scripts/with-generated-client.mjs test"
|
|
32
32
|
}
|
|
33
|
-
}
|
|
33
|
+
}
|