@spicyapi/sdk 0.3.0 → 0.5.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 +183 -92
- package/contracts/openapi.yaml +418 -17
- package/dist/src/docs/index.d.ts.map +1 -1
- package/dist/src/docs/index.js +15 -21
- package/dist/src/docs/index.js.map +1 -1
- package/dist/src/generated/openapi.d.ts +420 -16
- package/dist/src/generated/openapi.d.ts.map +1 -1
- package/dist/src/generated/package-version.d.ts +1 -1
- package/dist/src/generated/package-version.js +1 -1
- package/dist/src/sdk/base64.d.ts.map +1 -1
- package/dist/src/sdk/base64.js +5 -1
- package/dist/src/sdk/base64.js.map +1 -1
- package/dist/src/sdk/client.d.ts +22 -2
- package/dist/src/sdk/client.d.ts.map +1 -1
- package/dist/src/sdk/client.js +66 -7
- package/dist/src/sdk/client.js.map +1 -1
- package/dist/src/sdk/response-body.d.ts +1 -1
- package/dist/src/sdk/response-body.d.ts.map +1 -1
- package/dist/src/sdk/response-body.js +1 -1
- package/dist/src/sdk/response-body.js.map +1 -1
- package/dist/src/sdk/types.d.ts +40 -7
- package/dist/src/sdk/types.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/src/docs/index.js
CHANGED
|
@@ -4,55 +4,55 @@ const definitions = [
|
|
|
4
4
|
slug: "",
|
|
5
5
|
title: "Quickstart",
|
|
6
6
|
summary: "Create a task, follow its state, and retrieve generated media.",
|
|
7
|
-
keywords: ["start", "guide", "quickstart", "
|
|
7
|
+
keywords: ["start", "guide", "quickstart", "introduction", "tutorial"],
|
|
8
8
|
},
|
|
9
9
|
{
|
|
10
10
|
slug: "authentication",
|
|
11
11
|
title: "Authentication",
|
|
12
12
|
summary: "API keys, per-key controls, rotation, and incident response.",
|
|
13
|
-
keywords: ["api key", "bearer", "security"
|
|
13
|
+
keywords: ["api key", "bearer", "security"],
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
16
|
slug: "models",
|
|
17
17
|
title: "Models and parameters",
|
|
18
18
|
summary: "Live model IDs, account-specific pricing, input schemas, and examples.",
|
|
19
|
-
keywords: ["catalog", "schema", "price", "model"
|
|
19
|
+
keywords: ["catalog", "schema", "price", "model"],
|
|
20
20
|
},
|
|
21
21
|
{
|
|
22
22
|
slug: "tasks",
|
|
23
23
|
title: "Asynchronous tasks",
|
|
24
24
|
summary: "Create tasks, inspect task records, states, costs, and outputs.",
|
|
25
|
-
keywords: ["createTask", "recordInfo", "poll", "
|
|
25
|
+
keywords: ["createTask", "recordInfo", "poll", "polling", "state"],
|
|
26
26
|
},
|
|
27
27
|
{
|
|
28
28
|
slug: "task-actions",
|
|
29
29
|
title: "Task actions",
|
|
30
30
|
summary: "Retry failed or expired tasks safely and understand unsupported actions.",
|
|
31
|
-
keywords: ["retry", "cancel"
|
|
31
|
+
keywords: ["retry", "cancel"],
|
|
32
32
|
},
|
|
33
33
|
{
|
|
34
34
|
slug: "media",
|
|
35
35
|
title: "Media transfer",
|
|
36
36
|
summary: "Public HTTPS media inputs, optional local uploads, and direct signed result URLs.",
|
|
37
|
-
keywords: ["upload", "download", "file", "image"
|
|
37
|
+
keywords: ["upload", "download", "file", "image"],
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
slug: "billing",
|
|
41
41
|
title: "Billing",
|
|
42
42
|
summary: "Prices, holds, settlement, failures, refunds, and balance fields.",
|
|
43
|
-
keywords: ["cost", "credit", "balance", "payment", "billing"
|
|
43
|
+
keywords: ["cost", "credit", "balance", "payment", "billing"],
|
|
44
44
|
},
|
|
45
45
|
{
|
|
46
46
|
slug: "idempotency",
|
|
47
47
|
title: "Idempotency",
|
|
48
48
|
summary: "Retry one logical generation without duplicate work or duplicate holds.",
|
|
49
|
-
keywords: ["idempotency-key", "retry", "duplicate"
|
|
49
|
+
keywords: ["idempotency-key", "retry", "duplicate"],
|
|
50
50
|
},
|
|
51
51
|
{
|
|
52
52
|
slug: "webhooks",
|
|
53
53
|
title: "Webhooks",
|
|
54
54
|
summary: "Payload versions, raw-body signatures, delivery IDs, and retries.",
|
|
55
|
-
keywords: ["callback", "hmac", "signature", "webhook"
|
|
55
|
+
keywords: ["callback", "hmac", "signature", "webhook"],
|
|
56
56
|
},
|
|
57
57
|
{
|
|
58
58
|
slug: "errors",
|
|
@@ -67,34 +67,31 @@ const definitions = [
|
|
|
67
67
|
"service unavailable",
|
|
68
68
|
"no route",
|
|
69
69
|
"customer price",
|
|
70
|
-
"错误",
|
|
71
|
-
"不可用",
|
|
72
|
-
"重试",
|
|
73
70
|
],
|
|
74
71
|
},
|
|
75
72
|
{
|
|
76
73
|
slug: "limits",
|
|
77
74
|
title: "Rate limits",
|
|
78
75
|
summary: "Shared account rate limits and recommended backoff behavior.",
|
|
79
|
-
keywords: ["rate", "quota", "retry-after", "
|
|
76
|
+
keywords: ["rate", "quota", "retry-after", "throttling"],
|
|
80
77
|
},
|
|
81
78
|
{
|
|
82
79
|
slug: "retention",
|
|
83
80
|
title: "Data retention",
|
|
84
|
-
summary: "
|
|
85
|
-
keywords: ["privacy", "delete", "storage", "retention", "
|
|
81
|
+
summary: "Retention boundaries, per-request retention, and destroying one task's stored content.",
|
|
82
|
+
keywords: ["privacy", "delete", "storage", "retention", "purge", "destroy"],
|
|
86
83
|
},
|
|
87
84
|
{
|
|
88
85
|
slug: "policy",
|
|
89
86
|
title: "Content policy",
|
|
90
87
|
summary: "Model capabilities, no per-request platform content review, and caller responsibility.",
|
|
91
|
-
keywords: ["model capabilities", "content review", "content", "policy"
|
|
88
|
+
keywords: ["model capabilities", "content review", "content", "policy"],
|
|
92
89
|
},
|
|
93
90
|
{
|
|
94
91
|
slug: "agents",
|
|
95
92
|
title: "Agent integrations",
|
|
96
93
|
summary: "Safe patterns for AI agents using the public API contract.",
|
|
97
|
-
keywords: ["agent", "mcp", "tool"
|
|
94
|
+
keywords: ["agent", "mcp", "tool"],
|
|
98
95
|
},
|
|
99
96
|
{
|
|
100
97
|
slug: "quotes-and-compatibility",
|
|
@@ -109,16 +106,13 @@ const definitions = [
|
|
|
109
106
|
"openai",
|
|
110
107
|
"responses",
|
|
111
108
|
"chat completions",
|
|
112
|
-
"报价",
|
|
113
|
-
"价格变化",
|
|
114
|
-
"文本",
|
|
115
109
|
],
|
|
116
110
|
},
|
|
117
111
|
{
|
|
118
112
|
slug: "api-reference",
|
|
119
113
|
title: "API reference",
|
|
120
114
|
summary: "The complete public endpoint and envelope reference.",
|
|
121
|
-
keywords: ["openapi", "endpoint", "reference"
|
|
115
|
+
keywords: ["openapi", "endpoint", "reference"],
|
|
122
116
|
},
|
|
123
117
|
];
|
|
124
118
|
export const DOCUMENTATION = definitions.map((entry) => ({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/docs/index.ts"],"names":[],"mappings":"AAQA,MAAM,aAAa,GAAG,6BAA6B,CAAC;AAEpD,MAAM,WAAW,GAA2C;IAC1D;QACE,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,gEAAgE;QACzE,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/docs/index.ts"],"names":[],"mappings":"AAQA,MAAM,aAAa,GAAG,6BAA6B,CAAC;AAEpD,MAAM,WAAW,GAA2C;IAC1D;QACE,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,YAAY;QACnB,OAAO,EAAE,gEAAgE;QACzE,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,CAAC;KACvE;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,8DAA8D;QACvE,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC;KAC5C;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,uBAAuB;QAC9B,OAAO,EAAE,wEAAwE;QACjF,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC;KAClD;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,iEAAiE;QAC1E,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;KACnE;IACD;QACE,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,0EAA0E;QACnF,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;KAC9B;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,mFAAmF;QAC5F,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC;KAClD;IACD;QACE,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,mEAAmE;QAC5E,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;KAC9D;IACD;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,aAAa;QACpB,OAAO,EAAE,yEAAyE;QAClF,QAAQ,EAAE,CAAC,iBAAiB,EAAE,OAAO,EAAE,WAAW,CAAC;KACpD;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,mEAAmE;QAC5E,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,CAAC;KACvD;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,sEAAsE;QAC/E,QAAQ,EAAE;YACR,MAAM;YACN,YAAY;YACZ,KAAK;YACL,KAAK;YACL,aAAa;YACb,qBAAqB;YACrB,UAAU;YACV,gBAAgB;SACjB;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,aAAa;QACpB,OAAO,EAAE,8DAA8D;QACvE,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC;KACzD;IACD;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,gBAAgB;QACvB,OAAO,EACL,wFAAwF;QAC1F,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC;KAC5E;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,gBAAgB;QACvB,OAAO,EACL,wFAAwF;QAC1F,QAAQ,EAAE,CAAC,oBAAoB,EAAE,gBAAgB,EAAE,SAAS,EAAE,QAAQ,CAAC;KACxE;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,4DAA4D;QACrE,QAAQ,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC;KACnC;IACD;QACE,IAAI,EAAE,0BAA0B;QAChC,KAAK,EAAE,mCAAmC;QAC1C,OAAO,EACL,4GAA4G;QAC9G,QAAQ,EAAE;YACR,OAAO;YACP,WAAW;YACX,eAAe;YACf,WAAW;YACX,OAAO;YACP,QAAQ;YACR,WAAW;YACX,kBAAkB;SACnB;KACF;IACD;QACE,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE,sDAAsD;QAC/D,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC;KAC/C;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAyB,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC7E,GAAG,KAAK;IACR,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,aAAa,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,aAAa;CACnE,CAAC,CAAC,CAAC;AAEJ,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IAChC,GAAG;IACH,OAAO;IACP,QAAQ;IACR,OAAO;IACP,IAAI;IACJ,KAAK;IACL,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,QAAQ;IACR,IAAI;IACJ,KAAK;IACL,MAAM;IACN,KAAK;IACL,IAAI;IACJ,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,KAAK;IACL,KAAK;IACL,MAAM;IACN,SAAS;CACV,CAAC,CAAC;AAEH,SAAS,mBAAmB,CAAC,KAAa;IACxC,OAAO,KAAK;SACT,SAAS,CAAC,MAAM,CAAC;SACjB,WAAW,EAAE;SACb,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC;SAChC,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAK,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE;IACxD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,EAAE,CAAC;QACxD,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;IACnE,CAAC;IACD,MAAM,eAAe,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC;IACtE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAE7D,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACxC,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,IAAI,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC3D,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAChE,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAC1B,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACd,KAAK;YACL,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC,EACH,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAC5C,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAC1D,CAAC,CAAC;SACC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,GAAG,CAAC,CAAC;SAC5C,IAAI,CACH,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACd,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CACvF;SACA,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;SACf,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC"}
|