@stigg/typescript-mcp 0.1.0-beta.1 → 0.1.0-beta.2
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/code-tool-worker.js +12 -12
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +12 -12
- package/code-tool-worker.mjs.map +1 -1
- package/local-docs-search.d.mts.map +1 -1
- package/local-docs-search.d.ts.map +1 -1
- package/local-docs-search.js +221 -221
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +221 -221
- package/local-docs-search.mjs.map +1 -1
- package/methods.js +28 -28
- package/methods.js.map +1 -1
- package/methods.mjs +28 -28
- package/methods.mjs.map +1 -1
- package/package.json +2 -2
- package/server.js +1 -1
- package/server.mjs +1 -1
- package/src/code-tool-worker.ts +12 -12
- package/src/local-docs-search.ts +232 -235
- package/src/methods.ts +28 -28
- package/src/server.ts +1 -1
package/src/local-docs-search.ts
CHANGED
|
@@ -2461,8 +2461,8 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2461
2461
|
summary: 'Get credit usage',
|
|
2462
2462
|
description:
|
|
2463
2463
|
'Retrieves credit usage time-series data for a customer, grouped by feature, over a specified time range.',
|
|
2464
|
-
stainlessPath: '(resource) v1.
|
|
2465
|
-
qualified: 'client.v1.
|
|
2464
|
+
stainlessPath: '(resource) v1.credits > (method) get_usage',
|
|
2465
|
+
qualified: 'client.v1.credits.getUsage',
|
|
2466
2466
|
params: [
|
|
2467
2467
|
'customerId: string;',
|
|
2468
2468
|
'currencyId?: string;',
|
|
@@ -2474,112 +2474,55 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2474
2474
|
response:
|
|
2475
2475
|
'{ data: { currency: { currencyId: string; displayName: string; plural: string; singular: string; symbol: string; }; series: { featureId: string; featureName: string; points: object[]; totalCredits: number; }[]; }; }',
|
|
2476
2476
|
markdown:
|
|
2477
|
-
"## get_usage\n\n`client.v1.
|
|
2477
|
+
"## get_usage\n\n`client.v1.credits.getUsage(customerId: string, currencyId?: string, endDate?: string, resourceId?: string, startDate?: string, timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR'): { data: object; }`\n\n**get** `/api/v1/credits/usage`\n\nRetrieves credit usage time-series data for a customer, grouped by feature, over a specified time range.\n\n### Parameters\n\n- `customerId: string`\n Filter by customer ID (required)\n\n- `currencyId?: string`\n Filter by currency ID\n\n- `endDate?: string`\n End date for the credit usage time range (ISO 8601). Defaults to now when startDate is provided\n\n- `resourceId?: string`\n Filter by resource ID\n\n- `startDate?: string`\n Start date for the credit usage time range (ISO 8601). Takes precedence over timeRange when provided\n\n- `timeRange?: 'LAST_DAY' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_YEAR'`\n Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults to LAST_MONTH\n\n### Returns\n\n- `{ data: { currency: { currencyId: string; displayName: string; plural: string; singular: string; symbol: string; }; series: { featureId: string; featureName: string; points: object[]; totalCredits: number; }[]; }; }`\n Response object\n\n - `data: { currency: { currencyId: string; displayName: string; plural: string; singular: string; symbol: string; }; series: { featureId: string; featureName: string; points: { timestamp: string; value: number; }[]; totalCredits: number; }[]; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.credits.getUsage({ customerId: 'customerId' });\n\nconsole.log(response);\n```",
|
|
2478
2478
|
perLanguage: {
|
|
2479
2479
|
typescript: {
|
|
2480
|
-
method: 'client.v1.
|
|
2480
|
+
method: 'client.v1.credits.getUsage',
|
|
2481
2481
|
example:
|
|
2482
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.
|
|
2482
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.credits.getUsage({ customerId: 'customerId' });\n\nconsole.log(response.data);",
|
|
2483
2483
|
},
|
|
2484
2484
|
python: {
|
|
2485
|
-
method: 'v1.
|
|
2485
|
+
method: 'v1.credits.get_usage',
|
|
2486
2486
|
example:
|
|
2487
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.v1.
|
|
2487
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.v1.credits.get_usage(\n customer_id="customerId",\n)\nprint(response.data)',
|
|
2488
2488
|
},
|
|
2489
2489
|
java: {
|
|
2490
|
-
method: 'v1().
|
|
2490
|
+
method: 'v1().credits().getUsage',
|
|
2491
2491
|
example:
|
|
2492
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2492
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.CreditGetUsageParams;\nimport io.stigg.models.v1.credits.CreditGetUsageResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CreditGetUsageParams params = CreditGetUsageParams.builder()\n .customerId("customerId")\n .build();\n CreditGetUsageResponse response = client.v1().credits().getUsage(params);\n }\n}',
|
|
2493
2493
|
},
|
|
2494
2494
|
go: {
|
|
2495
|
-
method: 'client.V1.
|
|
2495
|
+
method: 'client.V1.Credits.GetUsage',
|
|
2496
2496
|
example:
|
|
2497
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.V1.
|
|
2497
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.V1.Credits.GetUsage(context.TODO(), stigg.V1CreditGetUsageParams{\n\t\tCustomerID: "customerId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Data)\n}\n',
|
|
2498
2498
|
},
|
|
2499
2499
|
ruby: {
|
|
2500
|
-
method: 'v1.
|
|
2500
|
+
method: 'v1.credits.get_usage',
|
|
2501
2501
|
example:
|
|
2502
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nresponse = stigg.v1.
|
|
2502
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nresponse = stigg.v1.credits.get_usage(customer_id: "customerId")\n\nputs(response)',
|
|
2503
2503
|
},
|
|
2504
2504
|
cli: {
|
|
2505
2505
|
method: 'credits get_usage',
|
|
2506
|
-
example:
|
|
2507
|
-
"stigg v1:events:credits get-usage \\\n --api-key 'My API Key' \\\n --customer-id customerId",
|
|
2506
|
+
example: "stigg v1:credits get-usage \\\n --api-key 'My API Key' \\\n --customer-id customerId",
|
|
2508
2507
|
},
|
|
2509
2508
|
csharp: {
|
|
2510
|
-
method: 'V1.
|
|
2509
|
+
method: 'V1.Credits.GetUsage',
|
|
2511
2510
|
example:
|
|
2512
|
-
'CreditGetUsageParams parameters = new() { CustomerID = "customerId" };\n\nvar response = await client.V1.
|
|
2511
|
+
'CreditGetUsageParams parameters = new() { CustomerID = "customerId" };\n\nvar response = await client.V1.Credits.GetUsage(parameters);\n\nConsole.WriteLine(response);',
|
|
2513
2512
|
},
|
|
2514
2513
|
http: {
|
|
2515
2514
|
example: 'curl https://api.stigg.io/api/v1/credits/usage \\\n -H "X-API-KEY: $STIGG_API_KEY"',
|
|
2516
2515
|
},
|
|
2517
2516
|
},
|
|
2518
2517
|
},
|
|
2519
|
-
{
|
|
2520
|
-
name: 'get_auto_recharge',
|
|
2521
|
-
endpoint: '/api/v1/credits/auto-recharge',
|
|
2522
|
-
httpMethod: 'get',
|
|
2523
|
-
summary: 'Get automatic recharge configuration',
|
|
2524
|
-
description:
|
|
2525
|
-
'Retrieves the automatic recharge configuration for a customer and currency. Returns default settings if no configuration exists.',
|
|
2526
|
-
stainlessPath: '(resource) v1.events.credits > (method) get_auto_recharge',
|
|
2527
|
-
qualified: 'client.v1.events.credits.getAutoRecharge',
|
|
2528
|
-
params: ['currencyId: string;', 'customerId: string;'],
|
|
2529
|
-
response:
|
|
2530
|
-
"{ data: { id: string; createdAt: string; currencyId: string; customerId: string; grantExpirationPeriod: '1_MONTH' | '1_YEAR'; isEnabled: boolean; maxSpendLimit: number; targetBalance: number; thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT'; thresholdValue: number; updatedAt: string; }; }",
|
|
2531
|
-
markdown:
|
|
2532
|
-
"## get_auto_recharge\n\n`client.v1.events.credits.getAutoRecharge(currencyId: string, customerId: string): { data: object; }`\n\n**get** `/api/v1/credits/auto-recharge`\n\nRetrieves the automatic recharge configuration for a customer and currency. Returns default settings if no configuration exists.\n\n### Parameters\n\n- `currencyId: string`\n Filter by currency ID (required)\n\n- `customerId: string`\n Filter by customer ID (required)\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; currencyId: string; customerId: string; grantExpirationPeriod: '1_MONTH' | '1_YEAR'; isEnabled: boolean; maxSpendLimit: number; targetBalance: number; thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT'; thresholdValue: number; updatedAt: string; }; }`\n Response object\n\n - `data: { id: string; createdAt: string; currencyId: string; customerId: string; grantExpirationPeriod: '1_MONTH' | '1_YEAR'; isEnabled: boolean; maxSpendLimit: number; targetBalance: number; thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT'; thresholdValue: number; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.events.credits.getAutoRecharge({ currencyId: 'currencyId', customerId: 'customerId' });\n\nconsole.log(response);\n```",
|
|
2533
|
-
perLanguage: {
|
|
2534
|
-
typescript: {
|
|
2535
|
-
method: 'client.v1.events.credits.getAutoRecharge',
|
|
2536
|
-
example:
|
|
2537
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.events.credits.getAutoRecharge({\n currencyId: 'currencyId',\n customerId: 'customerId',\n});\n\nconsole.log(response.data);",
|
|
2538
|
-
},
|
|
2539
|
-
python: {
|
|
2540
|
-
method: 'v1.events.credits.get_auto_recharge',
|
|
2541
|
-
example:
|
|
2542
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.v1.events.credits.get_auto_recharge(\n currency_id="currencyId",\n customer_id="customerId",\n)\nprint(response.data)',
|
|
2543
|
-
},
|
|
2544
|
-
java: {
|
|
2545
|
-
method: 'v1().events().credits().getAutoRecharge',
|
|
2546
|
-
example:
|
|
2547
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.events.credits.CreditGetAutoRechargeParams;\nimport io.stigg.models.v1.events.credits.CreditGetAutoRechargeResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CreditGetAutoRechargeParams params = CreditGetAutoRechargeParams.builder()\n .currencyId("currencyId")\n .customerId("customerId")\n .build();\n CreditGetAutoRechargeResponse response = client.v1().events().credits().getAutoRecharge(params);\n }\n}',
|
|
2548
|
-
},
|
|
2549
|
-
go: {
|
|
2550
|
-
method: 'client.V1.Events.Credits.GetAutoRecharge',
|
|
2551
|
-
example:
|
|
2552
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.V1.Events.Credits.GetAutoRecharge(context.TODO(), stigg.V1EventCreditGetAutoRechargeParams{\n\t\tCurrencyID: "currencyId",\n\t\tCustomerID: "customerId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Data)\n}\n',
|
|
2553
|
-
},
|
|
2554
|
-
ruby: {
|
|
2555
|
-
method: 'v1.events.credits.get_auto_recharge',
|
|
2556
|
-
example:
|
|
2557
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nresponse = stigg.v1.events.credits.get_auto_recharge(currency_id: "currencyId", customer_id: "customerId")\n\nputs(response)',
|
|
2558
|
-
},
|
|
2559
|
-
cli: {
|
|
2560
|
-
method: 'credits get_auto_recharge',
|
|
2561
|
-
example:
|
|
2562
|
-
"stigg v1:events:credits get-auto-recharge \\\n --api-key 'My API Key' \\\n --currency-id currencyId \\\n --customer-id customerId",
|
|
2563
|
-
},
|
|
2564
|
-
csharp: {
|
|
2565
|
-
method: 'V1.Events.Credits.GetAutoRecharge',
|
|
2566
|
-
example:
|
|
2567
|
-
'CreditGetAutoRechargeParams parameters = new()\n{\n CurrencyID = "currencyId",\n CustomerID = "customerId",\n};\n\nvar response = await client.V1.Events.Credits.GetAutoRecharge(parameters);\n\nConsole.WriteLine(response);',
|
|
2568
|
-
},
|
|
2569
|
-
http: {
|
|
2570
|
-
example:
|
|
2571
|
-
'curl https://api.stigg.io/api/v1/credits/auto-recharge \\\n -H "X-API-KEY: $STIGG_API_KEY"',
|
|
2572
|
-
},
|
|
2573
|
-
},
|
|
2574
|
-
},
|
|
2575
2518
|
{
|
|
2576
2519
|
name: 'list_ledger',
|
|
2577
2520
|
endpoint: '/api/v1/credits/ledger',
|
|
2578
2521
|
httpMethod: 'get',
|
|
2579
2522
|
summary: 'Get a list of credit ledger events',
|
|
2580
2523
|
description: 'Retrieves a paginated list of credit ledger events for a customer.',
|
|
2581
|
-
stainlessPath: '(resource) v1.
|
|
2582
|
-
qualified: 'client.v1.
|
|
2524
|
+
stainlessPath: '(resource) v1.credits > (method) list_ledger',
|
|
2525
|
+
qualified: 'client.v1.credits.listLedger',
|
|
2583
2526
|
params: [
|
|
2584
2527
|
'customerId: string;',
|
|
2585
2528
|
'after?: string;',
|
|
@@ -2591,42 +2534,41 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2591
2534
|
response:
|
|
2592
2535
|
'{ amount: number; creditCurrencyId: string; creditGrantId: string; customerId: string; eventId: string; eventType: string; featureId: string; resourceId: string; timestamp: string; }',
|
|
2593
2536
|
markdown:
|
|
2594
|
-
"## list_ledger\n\n`client.v1.
|
|
2537
|
+
"## list_ledger\n\n`client.v1.credits.listLedger(customerId: string, after?: string, before?: string, currencyId?: string, limit?: number, resourceId?: string): { amount: number; creditCurrencyId: string; creditGrantId: string; customerId: string; eventId: string; eventType: string; featureId: string; resourceId: string; timestamp: string; }`\n\n**get** `/api/v1/credits/ledger`\n\nRetrieves a paginated list of credit ledger events for a customer.\n\n### Parameters\n\n- `customerId: string`\n Filter by customer ID (required)\n\n- `after?: string`\n Return items that come after this cursor\n\n- `before?: string`\n Return items that come before this cursor\n\n- `currencyId?: string`\n Filter by currency ID\n\n- `limit?: number`\n Maximum number of items to return\n\n- `resourceId?: string`\n Filter by resource ID\n\n### Returns\n\n- `{ amount: number; creditCurrencyId: string; creditGrantId: string; customerId: string; eventId: string; eventType: string; featureId: string; resourceId: string; timestamp: string; }`\n A credit ledger event representing a change to credit balance\n\n - `amount: number`\n - `creditCurrencyId: string`\n - `creditGrantId: string`\n - `customerId: string`\n - `eventId: string`\n - `eventType: string`\n - `featureId: string`\n - `resourceId: string`\n - `timestamp: string`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\n// Automatically fetches more pages as needed.\nfor await (const creditListLedgerResponse of client.v1.credits.listLedger({ customerId: 'customerId' })) {\n console.log(creditListLedgerResponse);\n}\n```",
|
|
2595
2538
|
perLanguage: {
|
|
2596
2539
|
typescript: {
|
|
2597
|
-
method: 'client.v1.
|
|
2540
|
+
method: 'client.v1.credits.listLedger',
|
|
2598
2541
|
example:
|
|
2599
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const creditListLedgerResponse of client.v1.
|
|
2542
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const creditListLedgerResponse of client.v1.credits.listLedger({\n customerId: 'customerId',\n})) {\n console.log(creditListLedgerResponse.amount);\n}",
|
|
2600
2543
|
},
|
|
2601
2544
|
python: {
|
|
2602
|
-
method: 'v1.
|
|
2545
|
+
method: 'v1.credits.list_ledger',
|
|
2603
2546
|
example:
|
|
2604
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\npage = client.v1.
|
|
2547
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\npage = client.v1.credits.list_ledger(\n customer_id="customerId",\n)\npage = page.data[0]\nprint(page.amount)',
|
|
2605
2548
|
},
|
|
2606
2549
|
java: {
|
|
2607
|
-
method: 'v1().
|
|
2550
|
+
method: 'v1().credits().listLedger',
|
|
2608
2551
|
example:
|
|
2609
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2552
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.CreditListLedgerPage;\nimport io.stigg.models.v1.credits.CreditListLedgerParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CreditListLedgerParams params = CreditListLedgerParams.builder()\n .customerId("customerId")\n .build();\n CreditListLedgerPage page = client.v1().credits().listLedger(params);\n }\n}',
|
|
2610
2553
|
},
|
|
2611
2554
|
go: {
|
|
2612
|
-
method: 'client.V1.
|
|
2555
|
+
method: 'client.V1.Credits.ListLedger',
|
|
2613
2556
|
example:
|
|
2614
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.V1.
|
|
2557
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.V1.Credits.ListLedger(context.TODO(), stigg.V1CreditListLedgerParams{\n\t\tCustomerID: "customerId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
|
|
2615
2558
|
},
|
|
2616
2559
|
ruby: {
|
|
2617
|
-
method: 'v1.
|
|
2560
|
+
method: 'v1.credits.list_ledger',
|
|
2618
2561
|
example:
|
|
2619
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\npage = stigg.v1.
|
|
2562
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\npage = stigg.v1.credits.list_ledger(customer_id: "customerId")\n\nputs(page)',
|
|
2620
2563
|
},
|
|
2621
2564
|
cli: {
|
|
2622
2565
|
method: 'credits list_ledger',
|
|
2623
|
-
example:
|
|
2624
|
-
"stigg v1:events:credits list-ledger \\\n --api-key 'My API Key' \\\n --customer-id customerId",
|
|
2566
|
+
example: "stigg v1:credits list-ledger \\\n --api-key 'My API Key' \\\n --customer-id customerId",
|
|
2625
2567
|
},
|
|
2626
2568
|
csharp: {
|
|
2627
|
-
method: 'V1.
|
|
2569
|
+
method: 'V1.Credits.ListLedger',
|
|
2628
2570
|
example:
|
|
2629
|
-
'CreditListLedgerParams parameters = new() { CustomerID = "customerId" };\n\nvar page = await client.V1.
|
|
2571
|
+
'CreditListLedgerParams parameters = new() { CustomerID = "customerId" };\n\nvar page = await client.V1.Credits.ListLedger(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
|
|
2630
2572
|
},
|
|
2631
2573
|
http: {
|
|
2632
2574
|
example: 'curl https://api.stigg.io/api/v1/credits/ledger \\\n -H "X-API-KEY: $STIGG_API_KEY"',
|
|
@@ -2639,8 +2581,8 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2639
2581
|
httpMethod: 'get',
|
|
2640
2582
|
summary: 'Get a list of credit grants',
|
|
2641
2583
|
description: 'Retrieves a paginated list of credit grants for a customer.',
|
|
2642
|
-
stainlessPath: '(resource) v1.
|
|
2643
|
-
qualified: 'client.v1.
|
|
2584
|
+
stainlessPath: '(resource) v1.credits.grants > (method) list',
|
|
2585
|
+
qualified: 'client.v1.credits.grants.list',
|
|
2644
2586
|
params: [
|
|
2645
2587
|
'customerId: string;',
|
|
2646
2588
|
'after?: string;',
|
|
@@ -2653,42 +2595,41 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2653
2595
|
response:
|
|
2654
2596
|
"{ id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }",
|
|
2655
2597
|
markdown:
|
|
2656
|
-
"## list\n\n`client.v1.
|
|
2598
|
+
"## list\n\n`client.v1.credits.grants.list(customerId: string, after?: string, before?: string, createdAt?: { gt?: string; gte?: string; lt?: string; lte?: string; }, currencyId?: string, limit?: number, resourceId?: string): { id: string; amount: number; comment: string; consumedAmount: number; cost: object; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: object; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }`\n\n**get** `/api/v1/credits/grants`\n\nRetrieves a paginated list of credit grants for a customer.\n\n### Parameters\n\n- `customerId: string`\n Filter by customer ID (required)\n\n- `after?: string`\n Return items that come after this cursor\n\n- `before?: string`\n Return items that come before this cursor\n\n- `createdAt?: { gt?: string; gte?: string; lt?: string; lte?: string; }`\n Filter by creation date using range operators: gt, gte, lt, lte\n - `gt?: string`\n Greater than the specified createdAt value\n - `gte?: string`\n Greater than or equal to the specified createdAt value\n - `lt?: string`\n Less than the specified createdAt value\n - `lte?: string`\n Less than or equal to the specified createdAt value\n\n- `currencyId?: string`\n Filter by currency ID\n\n- `limit?: number`\n Maximum number of items to return\n\n- `resourceId?: string`\n Filter by resource ID. When omitted, only grants without a resource are returned\n\n### Returns\n\n- `{ id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }`\n Credit grant object representing allocated credits for a customer\n\n - `id: string`\n - `amount: number`\n - `comment: string`\n - `consumedAmount: number`\n - `cost: { amount: number; currency: string; }`\n - `createdAt: string`\n - `currencyId: string`\n - `customerId: string`\n - `displayName: string`\n - `effectiveAt: string`\n - `expireAt: string`\n - `grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'`\n - `invoiceId: string`\n - `latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }`\n - `metadata: object`\n - `paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'`\n - `priority: number`\n - `resourceId: string`\n - `sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'`\n - `status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'`\n - `updatedAt: string`\n - `voidedAt: string`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\n// Automatically fetches more pages as needed.\nfor await (const grantListResponse of client.v1.credits.grants.list({ customerId: 'customerId' })) {\n console.log(grantListResponse);\n}\n```",
|
|
2657
2599
|
perLanguage: {
|
|
2658
2600
|
typescript: {
|
|
2659
|
-
method: 'client.v1.
|
|
2601
|
+
method: 'client.v1.credits.grants.list',
|
|
2660
2602
|
example:
|
|
2661
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const grantListResponse of client.v1.
|
|
2603
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const grantListResponse of client.v1.credits.grants.list({ customerId: 'customerId' })) {\n console.log(grantListResponse.id);\n}",
|
|
2662
2604
|
},
|
|
2663
2605
|
python: {
|
|
2664
|
-
method: 'v1.
|
|
2606
|
+
method: 'v1.credits.grants.list',
|
|
2665
2607
|
example:
|
|
2666
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\npage = client.v1.
|
|
2608
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\npage = client.v1.credits.grants.list(\n customer_id="customerId",\n)\npage = page.data[0]\nprint(page.id)',
|
|
2667
2609
|
},
|
|
2668
2610
|
java: {
|
|
2669
|
-
method: 'v1().
|
|
2611
|
+
method: 'v1().credits().grants().list',
|
|
2670
2612
|
example:
|
|
2671
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2613
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.grants.GrantListPage;\nimport io.stigg.models.v1.credits.grants.GrantListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n GrantListParams params = GrantListParams.builder()\n .customerId("customerId")\n .build();\n GrantListPage page = client.v1().credits().grants().list(params);\n }\n}',
|
|
2672
2614
|
},
|
|
2673
2615
|
go: {
|
|
2674
|
-
method: 'client.V1.
|
|
2616
|
+
method: 'client.V1.Credits.Grants.List',
|
|
2675
2617
|
example:
|
|
2676
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.V1.
|
|
2618
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.V1.Credits.Grants.List(context.TODO(), stigg.V1CreditGrantListParams{\n\t\tCustomerID: "customerId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
|
|
2677
2619
|
},
|
|
2678
2620
|
ruby: {
|
|
2679
|
-
method: 'v1.
|
|
2621
|
+
method: 'v1.credits.grants.list',
|
|
2680
2622
|
example:
|
|
2681
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\npage = stigg.v1.
|
|
2623
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\npage = stigg.v1.credits.grants.list(customer_id: "customerId")\n\nputs(page)',
|
|
2682
2624
|
},
|
|
2683
2625
|
cli: {
|
|
2684
2626
|
method: 'grants list',
|
|
2685
|
-
example:
|
|
2686
|
-
"stigg v1:events:credits:grants list \\\n --api-key 'My API Key' \\\n --customer-id customerId",
|
|
2627
|
+
example: "stigg v1:credits:grants list \\\n --api-key 'My API Key' \\\n --customer-id customerId",
|
|
2687
2628
|
},
|
|
2688
2629
|
csharp: {
|
|
2689
|
-
method: 'V1.
|
|
2630
|
+
method: 'V1.Credits.Grants.List',
|
|
2690
2631
|
example:
|
|
2691
|
-
'GrantListParams parameters = new() { CustomerID = "customerId" };\n\nvar page = await client.V1.
|
|
2632
|
+
'GrantListParams parameters = new() { CustomerID = "customerId" };\n\nvar page = await client.V1.Credits.Grants.List(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
|
|
2692
2633
|
},
|
|
2693
2634
|
http: {
|
|
2694
2635
|
example: 'curl https://api.stigg.io/api/v1/credits/grants \\\n -H "X-API-KEY: $STIGG_API_KEY"',
|
|
@@ -2702,8 +2643,8 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2702
2643
|
summary: 'Create a credit grant',
|
|
2703
2644
|
description:
|
|
2704
2645
|
'Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.',
|
|
2705
|
-
stainlessPath: '(resource) v1.
|
|
2706
|
-
qualified: 'client.v1.
|
|
2646
|
+
stainlessPath: '(resource) v1.credits.grants > (method) create',
|
|
2647
|
+
qualified: 'client.v1.credits.grants.create',
|
|
2707
2648
|
params: [
|
|
2708
2649
|
'amount: number;',
|
|
2709
2650
|
'currencyId: string;',
|
|
@@ -2724,42 +2665,42 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2724
2665
|
response:
|
|
2725
2666
|
"{ data: { id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }; }",
|
|
2726
2667
|
markdown:
|
|
2727
|
-
"## create\n\n`client.v1.
|
|
2668
|
+
"## create\n\n`client.v1.credits.grants.create(amount: number, currencyId: string, customerId: string, displayName: string, grantType: 'PAID' | 'PROMOTIONAL', awaitPaymentConfirmation?: boolean, billingInformation?: { billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; postalCode?: string; state?: string; }; invoiceDaysUntilDue?: number; isInvoicePaid?: boolean; }, comment?: string, cost?: { amount: number; currency: string; }, effectiveAt?: string, expireAt?: string, metadata?: object, paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE', priority?: number, resourceId?: string): { data: object; }`\n\n**post** `/api/v1/credits/grants`\n\nCreates a new credit grant for a customer with specified amount, type, and optional billing configuration.\n\n### Parameters\n\n- `amount: number`\n The credit amount to grant\n\n- `currencyId: string`\n The credit currency ID (required)\n\n- `customerId: string`\n The customer ID to grant credits to (required)\n\n- `displayName: string`\n The display name for the credit grant\n\n- `grantType: 'PAID' | 'PROMOTIONAL'`\n The type of credit grant (PAID, PROMOTIONAL)\n\n- `awaitPaymentConfirmation?: boolean`\n Whether to wait for payment confirmation before returning (default: true)\n\n- `billingInformation?: { billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; postalCode?: string; state?: string; }; invoiceDaysUntilDue?: number; isInvoicePaid?: boolean; }`\n Billing information for the credit grant\n - `billingAddress?: { city?: string; country?: string; line1?: string; line2?: string; postalCode?: string; state?: string; }`\n The billing address\n - `invoiceDaysUntilDue?: number`\n Days until the invoice is due\n - `isInvoicePaid?: boolean`\n Whether the invoice is already paid\n\n- `comment?: string`\n An optional comment on the credit grant\n\n- `cost?: { amount: number; currency: string; }`\n The monetary cost of the credit grant\n - `amount: number`\n The price amount\n - `currency: string`\n ISO 4217 currency code\n\n- `effectiveAt?: string`\n The date when the credit grant becomes effective\n\n- `expireAt?: string`\n The date when the credit grant expires\n\n- `metadata?: object`\n Additional metadata for the credit grant\n\n- `paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE'`\n The payment collection method (CHARGE, INVOICE, NONE)\n\n- `priority?: number`\n The priority of the credit grant (lower number = higher priority)\n\n- `resourceId?: string`\n The resource ID to scope the grant to\n\n### Returns\n\n- `{ data: { id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }; }`\n Response object\n\n - `data: { id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst creditGrantResponse = await client.v1.credits.grants.create({\n amount: 0,\n currencyId: 'currencyId',\n customerId: 'customerId',\n displayName: 'displayName',\n grantType: 'PAID',\n});\n\nconsole.log(creditGrantResponse);\n```",
|
|
2728
2669
|
perLanguage: {
|
|
2729
2670
|
typescript: {
|
|
2730
|
-
method: 'client.v1.
|
|
2671
|
+
method: 'client.v1.credits.grants.create',
|
|
2731
2672
|
example:
|
|
2732
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst creditGrantResponse = await client.v1.
|
|
2673
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst creditGrantResponse = await client.v1.credits.grants.create({\n amount: 0,\n currencyId: 'currencyId',\n customerId: 'customerId',\n displayName: 'displayName',\n grantType: 'PAID',\n});\n\nconsole.log(creditGrantResponse.data);",
|
|
2733
2674
|
},
|
|
2734
2675
|
python: {
|
|
2735
|
-
method: 'v1.
|
|
2676
|
+
method: 'v1.credits.grants.create',
|
|
2736
2677
|
example:
|
|
2737
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncredit_grant_response = client.v1.
|
|
2678
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncredit_grant_response = client.v1.credits.grants.create(\n amount=0,\n currency_id="currencyId",\n customer_id="customerId",\n display_name="displayName",\n grant_type="PAID",\n)\nprint(credit_grant_response.data)',
|
|
2738
2679
|
},
|
|
2739
2680
|
java: {
|
|
2740
|
-
method: 'v1().
|
|
2681
|
+
method: 'v1().credits().grants().create',
|
|
2741
2682
|
example:
|
|
2742
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2683
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.grants.CreditGrantResponse;\nimport io.stigg.models.v1.credits.grants.GrantCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n GrantCreateParams params = GrantCreateParams.builder()\n .amount(0.0)\n .currencyId("currencyId")\n .customerId("customerId")\n .displayName("displayName")\n .grantType(GrantCreateParams.GrantType.PAID)\n .build();\n CreditGrantResponse creditGrantResponse = client.v1().credits().grants().create(params);\n }\n}',
|
|
2743
2684
|
},
|
|
2744
2685
|
go: {
|
|
2745
|
-
method: 'client.V1.
|
|
2686
|
+
method: 'client.V1.Credits.Grants.New',
|
|
2746
2687
|
example:
|
|
2747
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcreditGrantResponse, err := client.V1.
|
|
2688
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcreditGrantResponse, err := client.V1.Credits.Grants.New(context.TODO(), stigg.V1CreditGrantNewParams{\n\t\tAmount: 0,\n\t\tCurrencyID: "currencyId",\n\t\tCustomerID: "customerId",\n\t\tDisplayName: "displayName",\n\t\tGrantType: stigg.V1CreditGrantNewParamsGrantTypePaid,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", creditGrantResponse.Data)\n}\n',
|
|
2748
2689
|
},
|
|
2749
2690
|
ruby: {
|
|
2750
|
-
method: 'v1.
|
|
2691
|
+
method: 'v1.credits.grants.create',
|
|
2751
2692
|
example:
|
|
2752
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncredit_grant_response = stigg.v1.
|
|
2693
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncredit_grant_response = stigg.v1.credits.grants.create(\n amount: 0,\n currency_id: "currencyId",\n customer_id: "customerId",\n display_name: "displayName",\n grant_type: :PAID\n)\n\nputs(credit_grant_response)',
|
|
2753
2694
|
},
|
|
2754
2695
|
cli: {
|
|
2755
2696
|
method: 'grants create',
|
|
2756
2697
|
example:
|
|
2757
|
-
"stigg v1:
|
|
2698
|
+
"stigg v1:credits:grants create \\\n --api-key 'My API Key' \\\n --amount 0 \\\n --currency-id currencyId \\\n --customer-id customerId \\\n --display-name displayName \\\n --grant-type PAID",
|
|
2758
2699
|
},
|
|
2759
2700
|
csharp: {
|
|
2760
|
-
method: 'V1.
|
|
2701
|
+
method: 'V1.Credits.Grants.Create',
|
|
2761
2702
|
example:
|
|
2762
|
-
'GrantCreateParams parameters = new()\n{\n Amount = 0,\n CurrencyID = "currencyId",\n CustomerID = "customerId",\n DisplayName = "displayName",\n GrantType = GrantType.Paid,\n};\n\nvar creditGrantResponse = await client.V1.
|
|
2703
|
+
'GrantCreateParams parameters = new()\n{\n Amount = 0,\n CurrencyID = "currencyId",\n CustomerID = "customerId",\n DisplayName = "displayName",\n GrantType = GrantType.Paid,\n};\n\nvar creditGrantResponse = await client.V1.Credits.Grants.Create(parameters);\n\nConsole.WriteLine(creditGrantResponse);',
|
|
2763
2704
|
},
|
|
2764
2705
|
http: {
|
|
2765
2706
|
example:
|
|
@@ -2773,47 +2714,47 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2773
2714
|
httpMethod: 'post',
|
|
2774
2715
|
summary: 'Void credit grant',
|
|
2775
2716
|
description: 'Voids an existing credit grant, preventing further consumption of the remaining credits.',
|
|
2776
|
-
stainlessPath: '(resource) v1.
|
|
2777
|
-
qualified: 'client.v1.
|
|
2717
|
+
stainlessPath: '(resource) v1.credits.grants > (method) void',
|
|
2718
|
+
qualified: 'client.v1.credits.grants.void',
|
|
2778
2719
|
params: ['id: string;'],
|
|
2779
2720
|
response:
|
|
2780
2721
|
"{ data: { id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }; }",
|
|
2781
2722
|
markdown:
|
|
2782
|
-
"## void\n\n`client.v1.
|
|
2723
|
+
"## void\n\n`client.v1.credits.grants.void(id: string): { data: object; }`\n\n**post** `/api/v1/credits/grants/{id}/void`\n\nVoids an existing credit grant, preventing further consumption of the remaining credits.\n\n### Parameters\n\n- `id: string`\n\n### Returns\n\n- `{ data: { id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }; }`\n Response object\n\n - `data: { id: string; amount: number; comment: string; consumedAmount: number; cost: { amount: number; currency: string; }; createdAt: string; currencyId: string; customerId: string; displayName: string; effectiveAt: string; expireAt: string; grantType: 'PAID' | 'PROMOTIONAL' | 'RECURRING' | 'OVERDRAFT'; invoiceId: string; latestInvoice: { billingId: string; billingReason: 'MANUAL' | 'OTHER'; createdAt: string; currency: string; dueDate: string; errorMessage: string; paymentUrl: string; pdfUrl: string; requiresAction: boolean; status: 'OPEN' | 'PAID' | 'CANCELED'; subTotal: number; tax: number; total: number; updatedAt: string; }; metadata: object; paymentCollection: 'NOT_REQUIRED' | 'PROCESSING' | 'FAILED' | 'ACTION_REQUIRED'; priority: number; resourceId: string; sourceType: 'PRICE' | 'PLAN_ENTITLEMENT' | 'ADDON_ENTITLEMENT'; status: 'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'VOIDED' | 'SCHEDULED'; updatedAt: string; voidedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst creditGrantResponse = await client.v1.credits.grants.void('x');\n\nconsole.log(creditGrantResponse);\n```",
|
|
2783
2724
|
perLanguage: {
|
|
2784
2725
|
typescript: {
|
|
2785
|
-
method: 'client.v1.
|
|
2726
|
+
method: 'client.v1.credits.grants.void',
|
|
2786
2727
|
example:
|
|
2787
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst creditGrantResponse = await client.v1.
|
|
2728
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst creditGrantResponse = await client.v1.credits.grants.void('x');\n\nconsole.log(creditGrantResponse.data);",
|
|
2788
2729
|
},
|
|
2789
2730
|
python: {
|
|
2790
|
-
method: 'v1.
|
|
2731
|
+
method: 'v1.credits.grants.void',
|
|
2791
2732
|
example:
|
|
2792
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncredit_grant_response = client.v1.
|
|
2733
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncredit_grant_response = client.v1.credits.grants.void(\n "x",\n)\nprint(credit_grant_response.data)',
|
|
2793
2734
|
},
|
|
2794
2735
|
java: {
|
|
2795
|
-
method: 'v1().
|
|
2736
|
+
method: 'v1().credits().grants().void_',
|
|
2796
2737
|
example:
|
|
2797
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2738
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.grants.CreditGrantResponse;\nimport io.stigg.models.v1.credits.grants.GrantVoidParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CreditGrantResponse creditGrantResponse = client.v1().credits().grants().void_("x");\n }\n}',
|
|
2798
2739
|
},
|
|
2799
2740
|
go: {
|
|
2800
|
-
method: 'client.V1.
|
|
2741
|
+
method: 'client.V1.Credits.Grants.Void',
|
|
2801
2742
|
example:
|
|
2802
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcreditGrantResponse, err := client.V1.
|
|
2743
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcreditGrantResponse, err := client.V1.Credits.Grants.Void(context.TODO(), "x")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", creditGrantResponse.Data)\n}\n',
|
|
2803
2744
|
},
|
|
2804
2745
|
ruby: {
|
|
2805
|
-
method: 'v1.
|
|
2746
|
+
method: 'v1.credits.grants.void',
|
|
2806
2747
|
example:
|
|
2807
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncredit_grant_response = stigg.v1.
|
|
2748
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncredit_grant_response = stigg.v1.credits.grants.void("x")\n\nputs(credit_grant_response)',
|
|
2808
2749
|
},
|
|
2809
2750
|
cli: {
|
|
2810
2751
|
method: 'grants void',
|
|
2811
|
-
example: "stigg v1:
|
|
2752
|
+
example: "stigg v1:credits:grants void \\\n --api-key 'My API Key' \\\n --id x",
|
|
2812
2753
|
},
|
|
2813
2754
|
csharp: {
|
|
2814
|
-
method: 'V1.
|
|
2755
|
+
method: 'V1.Credits.Grants.Void',
|
|
2815
2756
|
example:
|
|
2816
|
-
'GrantVoidParams parameters = new() { ID = "x" };\n\nvar creditGrantResponse = await client.V1.
|
|
2757
|
+
'GrantVoidParams parameters = new() { ID = "x" };\n\nvar creditGrantResponse = await client.V1.Credits.Grants.Void(parameters);\n\nConsole.WriteLine(creditGrantResponse);',
|
|
2817
2758
|
},
|
|
2818
2759
|
http: {
|
|
2819
2760
|
example:
|
|
@@ -2828,47 +2769,47 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2828
2769
|
summary: 'Get a list of custom currencys',
|
|
2829
2770
|
description:
|
|
2830
2771
|
'Retrieves a paginated list of custom currencies in the environment. Archived currencies are excluded by default; pass `status=ARCHIVED` (or `status=ACTIVE,ARCHIVED`) to include them.',
|
|
2831
|
-
stainlessPath: '(resource) v1.
|
|
2832
|
-
qualified: 'client.v1.
|
|
2772
|
+
stainlessPath: '(resource) v1.credits.custom_currencies > (method) list',
|
|
2773
|
+
qualified: 'client.v1.credits.customCurrencies.list',
|
|
2833
2774
|
params: ['after?: string;', 'before?: string;', 'limit?: number;', "status?: 'ACTIVE' | 'ARCHIVED'[];"],
|
|
2834
2775
|
response:
|
|
2835
2776
|
'{ id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }',
|
|
2836
2777
|
markdown:
|
|
2837
|
-
"## list\n\n`client.v1.
|
|
2778
|
+
"## list\n\n`client.v1.credits.customCurrencies.list(after?: string, before?: string, limit?: number, status?: 'ACTIVE' | 'ARCHIVED'[]): { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: object; updatedAt: string; }`\n\n**get** `/api/v1/credits/custom-currencies`\n\nRetrieves a paginated list of custom currencies in the environment. Archived currencies are excluded by default; pass `status=ARCHIVED` (or `status=ACTIVE,ARCHIVED`) to include them.\n\n### Parameters\n\n- `after?: string`\n Return items that come after this cursor\n\n- `before?: string`\n Return items that come before this cursor\n\n- `limit?: number`\n Maximum number of items to return\n\n- `status?: 'ACTIVE' | 'ARCHIVED'[]`\n Filter by custom currency status. Supports comma-separated values (e.g., `ACTIVE,ARCHIVED`). Defaults to `ACTIVE`.\n\n### Returns\n\n- `{ id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }`\n A custom currency used to denominate credit-based entitlements and pricing\n\n - `id: string`\n - `archivedAt: string`\n - `createdAt: string`\n - `description: string`\n - `displayName: string`\n - `metadata: object`\n - `symbol: string`\n - `units: { plural: string; singular: string; }`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\n// Automatically fetches more pages as needed.\nfor await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {\n console.log(customCurrencyListResponse);\n}\n```",
|
|
2838
2779
|
perLanguage: {
|
|
2839
2780
|
typescript: {
|
|
2840
|
-
method: 'client.v1.
|
|
2781
|
+
method: 'client.v1.credits.customCurrencies.list',
|
|
2841
2782
|
example:
|
|
2842
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const customCurrencyListResponse of client.v1.
|
|
2783
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const customCurrencyListResponse of client.v1.credits.customCurrencies.list()) {\n console.log(customCurrencyListResponse.id);\n}",
|
|
2843
2784
|
},
|
|
2844
2785
|
python: {
|
|
2845
|
-
method: 'v1.
|
|
2786
|
+
method: 'v1.credits.custom_currencies.list',
|
|
2846
2787
|
example:
|
|
2847
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\npage = client.v1.
|
|
2788
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\npage = client.v1.credits.custom_currencies.list()\npage = page.data[0]\nprint(page.id)',
|
|
2848
2789
|
},
|
|
2849
2790
|
java: {
|
|
2850
|
-
method: 'v1().
|
|
2791
|
+
method: 'v1().credits().customCurrencies().list',
|
|
2851
2792
|
example:
|
|
2852
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2793
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyListPage;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CustomCurrencyListPage page = client.v1().credits().customCurrencies().list();\n }\n}',
|
|
2853
2794
|
},
|
|
2854
2795
|
go: {
|
|
2855
|
-
method: 'client.V1.
|
|
2796
|
+
method: 'client.V1.Credits.CustomCurrencies.List',
|
|
2856
2797
|
example:
|
|
2857
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.V1.
|
|
2798
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tpage, err := client.V1.Credits.CustomCurrencies.List(context.TODO(), stigg.V1CreditCustomCurrencyListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n',
|
|
2858
2799
|
},
|
|
2859
2800
|
ruby: {
|
|
2860
|
-
method: 'v1.
|
|
2801
|
+
method: 'v1.credits.custom_currencies.list',
|
|
2861
2802
|
example:
|
|
2862
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\npage = stigg.v1.
|
|
2803
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\npage = stigg.v1.credits.custom_currencies.list\n\nputs(page)',
|
|
2863
2804
|
},
|
|
2864
2805
|
cli: {
|
|
2865
2806
|
method: 'custom_currencies list',
|
|
2866
|
-
example: "stigg v1:
|
|
2807
|
+
example: "stigg v1:credits:custom-currencies list \\\n --api-key 'My API Key'",
|
|
2867
2808
|
},
|
|
2868
2809
|
csharp: {
|
|
2869
|
-
method: 'V1.
|
|
2810
|
+
method: 'V1.Credits.CustomCurrencies.List',
|
|
2870
2811
|
example:
|
|
2871
|
-
'CustomCurrencyListParams parameters = new();\n\nvar page = await client.V1.
|
|
2812
|
+
'CustomCurrencyListParams parameters = new();\n\nvar page = await client.V1.Credits.CustomCurrencies.List(parameters);\nawait foreach (var item in page.Paginate())\n{\n Console.WriteLine(item);\n}',
|
|
2872
2813
|
},
|
|
2873
2814
|
http: {
|
|
2874
2815
|
example:
|
|
@@ -2882,8 +2823,8 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2882
2823
|
httpMethod: 'post',
|
|
2883
2824
|
summary: 'Create custom currency',
|
|
2884
2825
|
description: 'Creates a new custom currency in the environment.',
|
|
2885
|
-
stainlessPath: '(resource) v1.
|
|
2886
|
-
qualified: 'client.v1.
|
|
2826
|
+
stainlessPath: '(resource) v1.credits.custom_currencies > (method) create',
|
|
2827
|
+
qualified: 'client.v1.credits.customCurrencies.create',
|
|
2887
2828
|
params: [
|
|
2888
2829
|
'id: string;',
|
|
2889
2830
|
'displayName: string;',
|
|
@@ -2895,42 +2836,42 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2895
2836
|
response:
|
|
2896
2837
|
'{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }',
|
|
2897
2838
|
markdown:
|
|
2898
|
-
"## create\n\n`client.v1.
|
|
2839
|
+
"## create\n\n`client.v1.credits.customCurrencies.create(id: string, displayName: string, description?: string, metadata?: object, symbol?: string, units?: { plural: string; singular: string; }): { data: object; }`\n\n**post** `/api/v1/credits/custom-currencies`\n\nCreates a new custom currency in the environment.\n\n### Parameters\n\n- `id: string`\n The unique identifier for the new custom currency\n\n- `displayName: string`\n The display name of the custom currency\n\n- `description?: string`\n Description of the currency\n\n- `metadata?: object`\n Additional metadata to attach to the custom currency\n\n- `symbol?: string`\n The symbol used to represent the custom currency\n\n- `units?: { plural: string; singular: string; }`\n Singular and plural unit labels for a custom currency. Both fields are required when supplied.\n - `plural: string`\n Plural form of the unit label\n - `singular: string`\n Singular form of the unit label\n\n### Returns\n\n- `{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }`\n Response object\n\n - `data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customCurrency = await client.v1.credits.customCurrencies.create({ id: 'id', displayName: 'displayName' });\n\nconsole.log(customCurrency);\n```",
|
|
2899
2840
|
perLanguage: {
|
|
2900
2841
|
typescript: {
|
|
2901
|
-
method: 'client.v1.
|
|
2842
|
+
method: 'client.v1.credits.customCurrencies.create',
|
|
2902
2843
|
example:
|
|
2903
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst customCurrency = await client.v1.
|
|
2844
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst customCurrency = await client.v1.credits.customCurrencies.create({\n id: 'id',\n displayName: 'displayName',\n});\n\nconsole.log(customCurrency.data);",
|
|
2904
2845
|
},
|
|
2905
2846
|
python: {
|
|
2906
|
-
method: 'v1.
|
|
2847
|
+
method: 'v1.credits.custom_currencies.create',
|
|
2907
2848
|
example:
|
|
2908
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncustom_currency = client.v1.
|
|
2849
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncustom_currency = client.v1.credits.custom_currencies.create(\n id="id",\n display_name="displayName",\n)\nprint(custom_currency.data)',
|
|
2909
2850
|
},
|
|
2910
2851
|
java: {
|
|
2911
|
-
method: 'v1().
|
|
2852
|
+
method: 'v1().credits().customCurrencies().create',
|
|
2912
2853
|
example:
|
|
2913
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2854
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrency;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CustomCurrencyCreateParams params = CustomCurrencyCreateParams.builder()\n .id("id")\n .displayName("displayName")\n .build();\n CustomCurrency customCurrency = client.v1().credits().customCurrencies().create(params);\n }\n}',
|
|
2914
2855
|
},
|
|
2915
2856
|
go: {
|
|
2916
|
-
method: 'client.V1.
|
|
2857
|
+
method: 'client.V1.Credits.CustomCurrencies.New',
|
|
2917
2858
|
example:
|
|
2918
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcustomCurrency, err := client.V1.
|
|
2859
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcustomCurrency, err := client.V1.Credits.CustomCurrencies.New(context.TODO(), stigg.V1CreditCustomCurrencyNewParams{\n\t\tID: "id",\n\t\tDisplayName: "displayName",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customCurrency.Data)\n}\n',
|
|
2919
2860
|
},
|
|
2920
2861
|
ruby: {
|
|
2921
|
-
method: 'v1.
|
|
2862
|
+
method: 'v1.credits.custom_currencies.create',
|
|
2922
2863
|
example:
|
|
2923
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustom_currency = stigg.v1.
|
|
2864
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustom_currency = stigg.v1.credits.custom_currencies.create(id: "id", display_name: "displayName")\n\nputs(custom_currency)',
|
|
2924
2865
|
},
|
|
2925
2866
|
cli: {
|
|
2926
2867
|
method: 'custom_currencies create',
|
|
2927
2868
|
example:
|
|
2928
|
-
"stigg v1:
|
|
2869
|
+
"stigg v1:credits:custom-currencies create \\\n --api-key 'My API Key' \\\n --id id \\\n --display-name displayName",
|
|
2929
2870
|
},
|
|
2930
2871
|
csharp: {
|
|
2931
|
-
method: 'V1.
|
|
2872
|
+
method: 'V1.Credits.CustomCurrencies.Create',
|
|
2932
2873
|
example:
|
|
2933
|
-
'CustomCurrencyCreateParams parameters = new()\n{\n ID = "id",\n DisplayName = "displayName",\n};\n\nvar customCurrency = await client.V1.
|
|
2874
|
+
'CustomCurrencyCreateParams parameters = new()\n{\n ID = "id",\n DisplayName = "displayName",\n};\n\nvar customCurrency = await client.V1.Credits.CustomCurrencies.Create(parameters);\n\nConsole.WriteLine(customCurrency);',
|
|
2934
2875
|
},
|
|
2935
2876
|
http: {
|
|
2936
2877
|
example:
|
|
@@ -2944,8 +2885,8 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2944
2885
|
httpMethod: 'patch',
|
|
2945
2886
|
summary: 'Update custom currency',
|
|
2946
2887
|
description: 'Updates an existing custom currency. Only the supplied fields are modified.',
|
|
2947
|
-
stainlessPath: '(resource) v1.
|
|
2948
|
-
qualified: 'client.v1.
|
|
2888
|
+
stainlessPath: '(resource) v1.credits.custom_currencies > (method) update',
|
|
2889
|
+
qualified: 'client.v1.credits.customCurrencies.update',
|
|
2949
2890
|
params: [
|
|
2950
2891
|
'currencyId: string;',
|
|
2951
2892
|
'description?: string;',
|
|
@@ -2957,42 +2898,42 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2957
2898
|
response:
|
|
2958
2899
|
'{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }',
|
|
2959
2900
|
markdown:
|
|
2960
|
-
"## update\n\n`client.v1.
|
|
2901
|
+
"## update\n\n`client.v1.credits.customCurrencies.update(currencyId: string, description?: string, displayName?: string, metadata?: object, symbol?: string, units?: { plural: string; singular: string; }): { data: object; }`\n\n**patch** `/api/v1/credits/custom-currencies/{currencyId}`\n\nUpdates an existing custom currency. Only the supplied fields are modified.\n\n### Parameters\n\n- `currencyId: string`\n\n- `description?: string`\n A human-readable description of the custom currency. Send an empty string to clear.\n\n- `displayName?: string`\n The display name of the custom currency\n\n- `metadata?: object`\n Additional metadata to attach to the custom currency\n\n- `symbol?: string`\n The symbol used to represent the custom currency. Send an empty string to clear.\n\n- `units?: { plural: string; singular: string; }`\n Singular and plural unit labels for a custom currency. Both fields are required when supplied.\n - `plural: string`\n Plural form of the unit label\n - `singular: string`\n Singular form of the unit label\n\n### Returns\n\n- `{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }`\n Response object\n\n - `data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customCurrency = await client.v1.credits.customCurrencies.update('currencyId');\n\nconsole.log(customCurrency);\n```",
|
|
2961
2902
|
perLanguage: {
|
|
2962
2903
|
typescript: {
|
|
2963
|
-
method: 'client.v1.
|
|
2904
|
+
method: 'client.v1.credits.customCurrencies.update',
|
|
2964
2905
|
example:
|
|
2965
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst customCurrency = await client.v1.
|
|
2906
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst customCurrency = await client.v1.credits.customCurrencies.update('currencyId');\n\nconsole.log(customCurrency.data);",
|
|
2966
2907
|
},
|
|
2967
2908
|
python: {
|
|
2968
|
-
method: 'v1.
|
|
2909
|
+
method: 'v1.credits.custom_currencies.update',
|
|
2969
2910
|
example:
|
|
2970
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncustom_currency = client.v1.
|
|
2911
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncustom_currency = client.v1.credits.custom_currencies.update(\n currency_id="currencyId",\n)\nprint(custom_currency.data)',
|
|
2971
2912
|
},
|
|
2972
2913
|
java: {
|
|
2973
|
-
method: 'v1().
|
|
2914
|
+
method: 'v1().credits().customCurrencies().update',
|
|
2974
2915
|
example:
|
|
2975
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2916
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrency;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CustomCurrency customCurrency = client.v1().credits().customCurrencies().update("currencyId");\n }\n}',
|
|
2976
2917
|
},
|
|
2977
2918
|
go: {
|
|
2978
|
-
method: 'client.V1.
|
|
2919
|
+
method: 'client.V1.Credits.CustomCurrencies.Update',
|
|
2979
2920
|
example:
|
|
2980
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcustomCurrency, err := client.V1.
|
|
2921
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcustomCurrency, err := client.V1.Credits.CustomCurrencies.Update(\n\t\tcontext.TODO(),\n\t\t"currencyId",\n\t\tstigg.V1CreditCustomCurrencyUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customCurrency.Data)\n}\n',
|
|
2981
2922
|
},
|
|
2982
2923
|
ruby: {
|
|
2983
|
-
method: 'v1.
|
|
2924
|
+
method: 'v1.credits.custom_currencies.update',
|
|
2984
2925
|
example:
|
|
2985
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustom_currency = stigg.v1.
|
|
2926
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustom_currency = stigg.v1.credits.custom_currencies.update("currencyId")\n\nputs(custom_currency)',
|
|
2986
2927
|
},
|
|
2987
2928
|
cli: {
|
|
2988
2929
|
method: 'custom_currencies update',
|
|
2989
2930
|
example:
|
|
2990
|
-
"stigg v1:
|
|
2931
|
+
"stigg v1:credits:custom-currencies update \\\n --api-key 'My API Key' \\\n --currency-id currencyId",
|
|
2991
2932
|
},
|
|
2992
2933
|
csharp: {
|
|
2993
|
-
method: 'V1.
|
|
2934
|
+
method: 'V1.Credits.CustomCurrencies.Update',
|
|
2994
2935
|
example:
|
|
2995
|
-
'CustomCurrencyUpdateParams parameters = new() { CurrencyID = "currencyId" };\n\nvar customCurrency = await client.V1.
|
|
2936
|
+
'CustomCurrencyUpdateParams parameters = new() { CurrencyID = "currencyId" };\n\nvar customCurrency = await client.V1.Credits.CustomCurrencies.Update(parameters);\n\nConsole.WriteLine(customCurrency);',
|
|
2996
2937
|
},
|
|
2997
2938
|
http: {
|
|
2998
2939
|
example:
|
|
@@ -3007,48 +2948,48 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3007
2948
|
summary: 'Archive custom currency',
|
|
3008
2949
|
description:
|
|
3009
2950
|
'Archives a custom currency. Fails if the currency is still associated with any active plan or addon — use the associated-entities endpoint first to inspect dependencies.',
|
|
3010
|
-
stainlessPath: '(resource) v1.
|
|
3011
|
-
qualified: 'client.v1.
|
|
2951
|
+
stainlessPath: '(resource) v1.credits.custom_currencies > (method) archive',
|
|
2952
|
+
qualified: 'client.v1.credits.customCurrencies.archive',
|
|
3012
2953
|
params: ['currencyId: string;'],
|
|
3013
2954
|
response:
|
|
3014
2955
|
'{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }',
|
|
3015
2956
|
markdown:
|
|
3016
|
-
"## archive\n\n`client.v1.
|
|
2957
|
+
"## archive\n\n`client.v1.credits.customCurrencies.archive(currencyId: string): { data: object; }`\n\n**post** `/api/v1/credits/custom-currencies/{currencyId}/archive`\n\nArchives a custom currency. Fails if the currency is still associated with any active plan or addon — use the associated-entities endpoint first to inspect dependencies.\n\n### Parameters\n\n- `currencyId: string`\n\n### Returns\n\n- `{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }`\n Response object\n\n - `data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customCurrency = await client.v1.credits.customCurrencies.archive('currencyId');\n\nconsole.log(customCurrency);\n```",
|
|
3017
2958
|
perLanguage: {
|
|
3018
2959
|
typescript: {
|
|
3019
|
-
method: 'client.v1.
|
|
2960
|
+
method: 'client.v1.credits.customCurrencies.archive',
|
|
3020
2961
|
example:
|
|
3021
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst
|
|
2962
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst customCurrency = await client.v1.credits.customCurrencies.archive('currencyId');\n\nconsole.log(customCurrency.data);",
|
|
3022
2963
|
},
|
|
3023
2964
|
python: {
|
|
3024
|
-
method: 'v1.
|
|
2965
|
+
method: 'v1.credits.custom_currencies.archive',
|
|
3025
2966
|
example:
|
|
3026
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\
|
|
2967
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncustom_currency = client.v1.credits.custom_currencies.archive(\n "currencyId",\n)\nprint(custom_currency.data)',
|
|
3027
2968
|
},
|
|
3028
2969
|
java: {
|
|
3029
|
-
method: 'v1().
|
|
2970
|
+
method: 'v1().credits().customCurrencies().archive',
|
|
3030
2971
|
example:
|
|
3031
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
2972
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrency;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyArchiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CustomCurrency customCurrency = client.v1().credits().customCurrencies().archive("currencyId");\n }\n}',
|
|
3032
2973
|
},
|
|
3033
2974
|
go: {
|
|
3034
|
-
method: 'client.V1.
|
|
2975
|
+
method: 'client.V1.Credits.CustomCurrencies.Archive',
|
|
3035
2976
|
example:
|
|
3036
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\
|
|
2977
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcustomCurrency, err := client.V1.Credits.CustomCurrencies.Archive(context.TODO(), "currencyId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customCurrency.Data)\n}\n',
|
|
3037
2978
|
},
|
|
3038
2979
|
ruby: {
|
|
3039
|
-
method: 'v1.
|
|
2980
|
+
method: 'v1.credits.custom_currencies.archive',
|
|
3040
2981
|
example:
|
|
3041
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
2982
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustom_currency = stigg.v1.credits.custom_currencies.archive("currencyId")\n\nputs(custom_currency)',
|
|
3042
2983
|
},
|
|
3043
2984
|
cli: {
|
|
3044
2985
|
method: 'custom_currencies archive',
|
|
3045
2986
|
example:
|
|
3046
|
-
"stigg v1:
|
|
2987
|
+
"stigg v1:credits:custom-currencies archive \\\n --api-key 'My API Key' \\\n --currency-id currencyId",
|
|
3047
2988
|
},
|
|
3048
2989
|
csharp: {
|
|
3049
|
-
method: 'V1.
|
|
2990
|
+
method: 'V1.Credits.CustomCurrencies.Archive',
|
|
3050
2991
|
example:
|
|
3051
|
-
'CustomCurrencyArchiveParams parameters = new() { CurrencyID = "currencyId" };\n\nvar
|
|
2992
|
+
'CustomCurrencyArchiveParams parameters = new() { CurrencyID = "currencyId" };\n\nvar customCurrency = await client.V1.Credits.CustomCurrencies.Archive(parameters);\n\nConsole.WriteLine(customCurrency);',
|
|
3052
2993
|
},
|
|
3053
2994
|
http: {
|
|
3054
2995
|
example:
|
|
@@ -3063,48 +3004,48 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3063
3004
|
summary: 'Unarchive custom currency',
|
|
3064
3005
|
description:
|
|
3065
3006
|
'Restores a previously archived custom currency. Fails if another active currency with the same ID already exists.',
|
|
3066
|
-
stainlessPath: '(resource) v1.
|
|
3067
|
-
qualified: 'client.v1.
|
|
3007
|
+
stainlessPath: '(resource) v1.credits.custom_currencies > (method) unarchive',
|
|
3008
|
+
qualified: 'client.v1.credits.customCurrencies.unarchive',
|
|
3068
3009
|
params: ['currencyId: string;'],
|
|
3069
3010
|
response:
|
|
3070
3011
|
'{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }',
|
|
3071
3012
|
markdown:
|
|
3072
|
-
"## unarchive\n\n`client.v1.
|
|
3013
|
+
"## unarchive\n\n`client.v1.credits.customCurrencies.unarchive(currencyId: string): { data: object; }`\n\n**post** `/api/v1/credits/custom-currencies/{currencyId}/unarchive`\n\nRestores a previously archived custom currency. Fails if another active currency with the same ID already exists.\n\n### Parameters\n\n- `currencyId: string`\n\n### Returns\n\n- `{ data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }; }`\n Response object\n\n - `data: { id: string; archivedAt: string; createdAt: string; description: string; displayName: string; metadata: object; symbol: string; units: { plural: string; singular: string; }; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customCurrency = await client.v1.credits.customCurrencies.unarchive('currencyId');\n\nconsole.log(customCurrency);\n```",
|
|
3073
3014
|
perLanguage: {
|
|
3074
3015
|
typescript: {
|
|
3075
|
-
method: 'client.v1.
|
|
3016
|
+
method: 'client.v1.credits.customCurrencies.unarchive',
|
|
3076
3017
|
example:
|
|
3077
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst
|
|
3018
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst customCurrency = await client.v1.credits.customCurrencies.unarchive('currencyId');\n\nconsole.log(customCurrency.data);",
|
|
3078
3019
|
},
|
|
3079
3020
|
python: {
|
|
3080
|
-
method: 'v1.
|
|
3021
|
+
method: 'v1.credits.custom_currencies.unarchive',
|
|
3081
3022
|
example:
|
|
3082
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\
|
|
3023
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\ncustom_currency = client.v1.credits.custom_currencies.unarchive(\n "currencyId",\n)\nprint(custom_currency.data)',
|
|
3083
3024
|
},
|
|
3084
3025
|
java: {
|
|
3085
|
-
method: 'v1().
|
|
3026
|
+
method: 'v1().credits().customCurrencies().unarchive',
|
|
3086
3027
|
example:
|
|
3087
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
3028
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrency;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyUnarchiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CustomCurrency customCurrency = client.v1().credits().customCurrencies().unarchive("currencyId");\n }\n}',
|
|
3088
3029
|
},
|
|
3089
3030
|
go: {
|
|
3090
|
-
method: 'client.V1.
|
|
3031
|
+
method: 'client.V1.Credits.CustomCurrencies.Unarchive',
|
|
3091
3032
|
example:
|
|
3092
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\
|
|
3033
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tcustomCurrency, err := client.V1.Credits.CustomCurrencies.Unarchive(context.TODO(), "currencyId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customCurrency.Data)\n}\n',
|
|
3093
3034
|
},
|
|
3094
3035
|
ruby: {
|
|
3095
|
-
method: 'v1.
|
|
3036
|
+
method: 'v1.credits.custom_currencies.unarchive',
|
|
3096
3037
|
example:
|
|
3097
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
3038
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustom_currency = stigg.v1.credits.custom_currencies.unarchive("currencyId")\n\nputs(custom_currency)',
|
|
3098
3039
|
},
|
|
3099
3040
|
cli: {
|
|
3100
3041
|
method: 'custom_currencies unarchive',
|
|
3101
3042
|
example:
|
|
3102
|
-
"stigg v1:
|
|
3043
|
+
"stigg v1:credits:custom-currencies unarchive \\\n --api-key 'My API Key' \\\n --currency-id currencyId",
|
|
3103
3044
|
},
|
|
3104
3045
|
csharp: {
|
|
3105
|
-
method: 'V1.
|
|
3046
|
+
method: 'V1.Credits.CustomCurrencies.Unarchive',
|
|
3106
3047
|
example:
|
|
3107
|
-
'CustomCurrencyUnarchiveParams parameters = new() { CurrencyID = "currencyId" };\n\nvar
|
|
3048
|
+
'CustomCurrencyUnarchiveParams parameters = new() { CurrencyID = "currencyId" };\n\nvar customCurrency = await client.V1.Credits.CustomCurrencies.Unarchive(parameters);\n\nConsole.WriteLine(customCurrency);',
|
|
3108
3049
|
},
|
|
3109
3050
|
http: {
|
|
3110
3051
|
example:
|
|
@@ -3119,47 +3060,47 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3119
3060
|
summary: 'List custom currency associated entities',
|
|
3120
3061
|
description:
|
|
3121
3062
|
'Lists the active plans and addons that reference a custom currency. Useful before archiving to inspect dependencies.',
|
|
3122
|
-
stainlessPath: '(resource) v1.
|
|
3123
|
-
qualified: 'client.v1.
|
|
3063
|
+
stainlessPath: '(resource) v1.credits.custom_currencies > (method) list_associated_entities',
|
|
3064
|
+
qualified: 'client.v1.credits.customCurrencies.listAssociatedEntities',
|
|
3124
3065
|
params: ['currencyId: string;'],
|
|
3125
3066
|
response: '{ data: { id: string; displayName: string; type: string; }[]; }',
|
|
3126
3067
|
markdown:
|
|
3127
|
-
"## list_associated_entities\n\n`client.v1.
|
|
3068
|
+
"## list_associated_entities\n\n`client.v1.credits.customCurrencies.listAssociatedEntities(currencyId: string): { data: object[]; }`\n\n**get** `/api/v1/credits/custom-currencies/{currencyId}/associated-entities`\n\nLists the active plans and addons that reference a custom currency. Useful before archiving to inspect dependencies.\n\n### Parameters\n\n- `currencyId: string`\n\n### Returns\n\n- `{ data: { id: string; displayName: string; type: string; }[]; }`\n List of entities (plans or addons) that reference a custom currency\n\n - `data: { id: string; displayName: string; type: string; }[]`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.credits.customCurrencies.listAssociatedEntities('currencyId');\n\nconsole.log(response);\n```",
|
|
3128
3069
|
perLanguage: {
|
|
3129
3070
|
typescript: {
|
|
3130
|
-
method: 'client.v1.
|
|
3071
|
+
method: 'client.v1.credits.customCurrencies.listAssociatedEntities',
|
|
3131
3072
|
example:
|
|
3132
|
-
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.
|
|
3073
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.credits.customCurrencies.listAssociatedEntities('currencyId');\n\nconsole.log(response.data);",
|
|
3133
3074
|
},
|
|
3134
3075
|
python: {
|
|
3135
|
-
method: 'v1.
|
|
3076
|
+
method: 'v1.credits.custom_currencies.list_associated_entities',
|
|
3136
3077
|
example:
|
|
3137
|
-
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.v1.
|
|
3078
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.v1.credits.custom_currencies.list_associated_entities(\n "currencyId",\n)\nprint(response.data)',
|
|
3138
3079
|
},
|
|
3139
3080
|
java: {
|
|
3140
|
-
method: 'v1().
|
|
3081
|
+
method: 'v1().credits().customCurrencies().listAssociatedEntities',
|
|
3141
3082
|
example:
|
|
3142
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.
|
|
3083
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyListAssociatedEntitiesParams;\nimport io.stigg.models.v1.credits.customcurrencies.CustomCurrencyListAssociatedEntitiesResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n CustomCurrencyListAssociatedEntitiesResponse response = client.v1().credits().customCurrencies().listAssociatedEntities("currencyId");\n }\n}',
|
|
3143
3084
|
},
|
|
3144
3085
|
go: {
|
|
3145
|
-
method: 'client.V1.
|
|
3086
|
+
method: 'client.V1.Credits.CustomCurrencies.ListAssociatedEntities',
|
|
3146
3087
|
example:
|
|
3147
|
-
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.V1.
|
|
3088
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.V1.Credits.CustomCurrencies.ListAssociatedEntities(context.TODO(), "currencyId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Data)\n}\n',
|
|
3148
3089
|
},
|
|
3149
3090
|
ruby: {
|
|
3150
|
-
method: 'v1.
|
|
3091
|
+
method: 'v1.credits.custom_currencies.list_associated_entities',
|
|
3151
3092
|
example:
|
|
3152
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nresponse = stigg.v1.
|
|
3093
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nresponse = stigg.v1.credits.custom_currencies.list_associated_entities("currencyId")\n\nputs(response)',
|
|
3153
3094
|
},
|
|
3154
3095
|
cli: {
|
|
3155
3096
|
method: 'custom_currencies list_associated_entities',
|
|
3156
3097
|
example:
|
|
3157
|
-
"stigg v1:
|
|
3098
|
+
"stigg v1:credits:custom-currencies list-associated-entities \\\n --api-key 'My API Key' \\\n --currency-id currencyId",
|
|
3158
3099
|
},
|
|
3159
3100
|
csharp: {
|
|
3160
|
-
method: 'V1.
|
|
3101
|
+
method: 'V1.Credits.CustomCurrencies.ListAssociatedEntities',
|
|
3161
3102
|
example:
|
|
3162
|
-
'CustomCurrencyListAssociatedEntitiesParams parameters = new()\n{\n CurrencyID = "currencyId"\n};\n\nvar response = await client.V1.
|
|
3103
|
+
'CustomCurrencyListAssociatedEntitiesParams parameters = new()\n{\n CurrencyID = "currencyId"\n};\n\nvar response = await client.V1.Credits.CustomCurrencies.ListAssociatedEntities(parameters);\n\nConsole.WriteLine(response);',
|
|
3163
3104
|
},
|
|
3164
3105
|
http: {
|
|
3165
3106
|
example:
|
|
@@ -3167,6 +3108,62 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3167
3108
|
},
|
|
3168
3109
|
},
|
|
3169
3110
|
},
|
|
3111
|
+
{
|
|
3112
|
+
name: 'get_auto_recharge',
|
|
3113
|
+
endpoint: '/api/v1/credits/auto-recharge',
|
|
3114
|
+
httpMethod: 'get',
|
|
3115
|
+
summary: 'Get automatic recharge configuration',
|
|
3116
|
+
description:
|
|
3117
|
+
'Retrieves the automatic recharge configuration for a customer and currency. Returns default settings if no configuration exists.',
|
|
3118
|
+
stainlessPath: '(resource) v1.credits.auto_recharge > (method) get_auto_recharge',
|
|
3119
|
+
qualified: 'client.v1.credits.autoRecharge.getAutoRecharge',
|
|
3120
|
+
params: ['currencyId: string;', 'customerId: string;'],
|
|
3121
|
+
response:
|
|
3122
|
+
"{ data: { id: string; createdAt: string; currencyId: string; customerId: string; grantExpirationPeriod: '1_MONTH' | '1_YEAR'; isEnabled: boolean; maxSpendLimit: number; targetBalance: number; thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT'; thresholdValue: number; updatedAt: string; }; }",
|
|
3123
|
+
markdown:
|
|
3124
|
+
"## get_auto_recharge\n\n`client.v1.credits.autoRecharge.getAutoRecharge(currencyId: string, customerId: string): { data: object; }`\n\n**get** `/api/v1/credits/auto-recharge`\n\nRetrieves the automatic recharge configuration for a customer and currency. Returns default settings if no configuration exists.\n\n### Parameters\n\n- `currencyId: string`\n Filter by currency ID (required)\n\n- `customerId: string`\n Filter by customer ID (required)\n\n### Returns\n\n- `{ data: { id: string; createdAt: string; currencyId: string; customerId: string; grantExpirationPeriod: '1_MONTH' | '1_YEAR'; isEnabled: boolean; maxSpendLimit: number; targetBalance: number; thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT'; thresholdValue: number; updatedAt: string; }; }`\n Response object\n\n - `data: { id: string; createdAt: string; currencyId: string; customerId: string; grantExpirationPeriod: '1_MONTH' | '1_YEAR'; isEnabled: boolean; maxSpendLimit: number; targetBalance: number; thresholdType: 'CREDIT_AMOUNT' | 'DOLLAR_AMOUNT'; thresholdValue: number; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.credits.autoRecharge.getAutoRecharge({ currencyId: 'currencyId', customerId: 'customerId' });\n\nconsole.log(response);\n```",
|
|
3125
|
+
perLanguage: {
|
|
3126
|
+
typescript: {
|
|
3127
|
+
method: 'client.v1.credits.autoRecharge.getAutoRecharge',
|
|
3128
|
+
example:
|
|
3129
|
+
"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.v1.credits.autoRecharge.getAutoRecharge({\n currencyId: 'currencyId',\n customerId: 'customerId',\n});\n\nconsole.log(response.data);",
|
|
3130
|
+
},
|
|
3131
|
+
python: {
|
|
3132
|
+
method: 'v1.credits.auto_recharge.get_auto_recharge',
|
|
3133
|
+
example:
|
|
3134
|
+
'import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted\n)\nresponse = client.v1.credits.auto_recharge.get_auto_recharge(\n currency_id="currencyId",\n customer_id="customerId",\n)\nprint(response.data)',
|
|
3135
|
+
},
|
|
3136
|
+
java: {
|
|
3137
|
+
method: 'v1().credits().autoRecharge().getAutoRecharge',
|
|
3138
|
+
example:
|
|
3139
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.autorecharge.AutoRechargeGetAutoRechargeParams;\nimport io.stigg.models.v1.credits.autorecharge.AutoRechargeGetAutoRechargeResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n AutoRechargeGetAutoRechargeParams params = AutoRechargeGetAutoRechargeParams.builder()\n .currencyId("currencyId")\n .customerId("customerId")\n .build();\n AutoRechargeGetAutoRechargeResponse response = client.v1().credits().autoRecharge().getAutoRecharge(params);\n }\n}',
|
|
3140
|
+
},
|
|
3141
|
+
go: {
|
|
3142
|
+
method: 'client.V1.Credits.AutoRecharge.GetAutoRecharge',
|
|
3143
|
+
example:
|
|
3144
|
+
'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/stiggio/stigg-go"\n\t"github.com/stiggio/stigg-go/option"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tresponse, err := client.V1.Credits.AutoRecharge.GetAutoRecharge(context.TODO(), stigg.V1CreditAutoRechargeGetAutoRechargeParams{\n\t\tCurrencyID: "currencyId",\n\t\tCustomerID: "customerId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Data)\n}\n',
|
|
3145
|
+
},
|
|
3146
|
+
ruby: {
|
|
3147
|
+
method: 'v1.credits.auto_recharge.get_auto_recharge',
|
|
3148
|
+
example:
|
|
3149
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nresponse = stigg.v1.credits.auto_recharge.get_auto_recharge(currency_id: "currencyId", customer_id: "customerId")\n\nputs(response)',
|
|
3150
|
+
},
|
|
3151
|
+
cli: {
|
|
3152
|
+
method: 'auto_recharge get_auto_recharge',
|
|
3153
|
+
example:
|
|
3154
|
+
"stigg v1:credits:auto-recharge get-auto-recharge \\\n --api-key 'My API Key' \\\n --currency-id currencyId \\\n --customer-id customerId",
|
|
3155
|
+
},
|
|
3156
|
+
csharp: {
|
|
3157
|
+
method: 'V1.Credits.AutoRecharge.GetAutoRecharge',
|
|
3158
|
+
example:
|
|
3159
|
+
'AutoRechargeGetAutoRechargeParams parameters = new()\n{\n CurrencyID = "currencyId",\n CustomerID = "customerId",\n};\n\nvar response = await client.V1.Credits.AutoRecharge.GetAutoRecharge(parameters);\n\nConsole.WriteLine(response);',
|
|
3160
|
+
},
|
|
3161
|
+
http: {
|
|
3162
|
+
example:
|
|
3163
|
+
'curl https://api.stigg.io/api/v1/credits/auto-recharge \\\n -H "X-API-KEY: $STIGG_API_KEY"',
|
|
3164
|
+
},
|
|
3165
|
+
},
|
|
3166
|
+
},
|
|
3170
3167
|
{
|
|
3171
3168
|
name: 'retrieve_feature',
|
|
3172
3169
|
endpoint: '/api/v1/features/{id}',
|