@stigg/typescript-mcp 0.1.0-alpha.26 → 0.1.0-alpha.28
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.d.mts.map +1 -1
- package/code-tool-worker.d.ts.map +1 -1
- package/code-tool-worker.js +2 -1
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +2 -1
- package/code-tool-worker.mjs.map +1 -1
- package/docs-search-tool.js +1 -1
- package/docs-search-tool.js.map +1 -1
- package/docs-search-tool.mjs +1 -1
- package/docs-search-tool.mjs.map +1 -1
- package/instructions.js +1 -1
- package/instructions.js.map +1 -1
- package/instructions.mjs +1 -1
- package/instructions.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 +60 -61
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +60 -61
- package/local-docs-search.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 +2 -1
- package/src/docs-search-tool.ts +1 -1
- package/src/instructions.ts +1 -1
- package/src/local-docs-search.ts +60 -61
- package/src/server.ts +1 -1
- package/src/util.ts +2 -2
- package/util.js +2 -2
- package/util.js.map +1 -1
- package/util.mjs +2 -2
- package/util.mjs.map +1 -1
package/src/local-docs-search.ts
CHANGED
|
@@ -524,14 +524,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
524
524
|
httpMethod: 'get',
|
|
525
525
|
summary: 'Get entitlements state',
|
|
526
526
|
description:
|
|
527
|
-
'Retrieves the effective entitlements for a customer or resource, including feature and credit entitlements.',
|
|
527
|
+
'Retrieves the effective entitlements for a customer or resource, including feature and credit entitlements.\n\n**Warning:** This REST API endpoint lacks built-in client-side caching, fallback mechanisms, and low-latency guarantees. It is not recommended for hot-path entitlement checks. For production use, consider using the Stigg Node Server SDK with caching or the Sidecar for low-latency cached responses.',
|
|
528
528
|
stainlessPath: '(resource) v1.customers > (method) retrieve_entitlements',
|
|
529
529
|
qualified: 'client.v1.customers.retrieveEntitlements',
|
|
530
530
|
params: ['id: string;', 'resourceId?: string;'],
|
|
531
531
|
response:
|
|
532
532
|
"{ data: { accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived'; entitlements: { accessDeniedReason: string; isGranted: boolean; type: 'FEATURE'; currentUsage?: number; entitlementUpdatedAt?: string; feature?: object; hasUnlimitedUsage?: boolean; resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR'; usageLimit?: number; usagePeriodAnchor?: string; usagePeriodEnd?: string; usagePeriodStart?: string; validUntil?: string; } | { accessDeniedReason: string; currency: object; currentUsage: number; isGranted: boolean; type: 'CREDIT'; usageLimit: number; usageUpdatedAt: string; entitlementUpdatedAt?: string; usagePeriodEnd?: string; validUntil?: string; }[]; }; }",
|
|
533
533
|
markdown:
|
|
534
|
-
"## retrieve_entitlements\n\n`client.v1.customers.retrieveEntitlements(id: string, resourceId?: string): { data: object; }`\n\n**get** `/api/v1/customers/{id}/entitlements`\n\nRetrieves the effective entitlements for a customer or resource, including feature and credit entitlements.\n\n### Parameters\n\n- `id: string`\n\n- `resourceId?: string`\n Resource ID to scope entitlements to a specific resource\n\n### Returns\n\n- `{ data: { accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived'; entitlements: { accessDeniedReason: string; isGranted: boolean; type: 'FEATURE'; currentUsage?: number; entitlementUpdatedAt?: string; feature?: object; hasUnlimitedUsage?: boolean; resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR'; usageLimit?: number; usagePeriodAnchor?: string; usagePeriodEnd?: string; usagePeriodStart?: string; validUntil?: string; } | { accessDeniedReason: string; currency: object; currentUsage: number; isGranted: boolean; type: 'CREDIT'; usageLimit: number; usageUpdatedAt: string; entitlementUpdatedAt?: string; usagePeriodEnd?: string; validUntil?: string; }[]; }; }`\n Response object\n\n - `data: { accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived'; entitlements: { accessDeniedReason: string; isGranted: boolean; type: 'FEATURE'; currentUsage?: number; entitlementUpdatedAt?: string; feature?: { id: string; displayName: string; featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE'; featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM'; }; hasUnlimitedUsage?: boolean; resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR'; usageLimit?: number; usagePeriodAnchor?: string; usagePeriodEnd?: string; usagePeriodStart?: string; validUntil?: string; } | { accessDeniedReason: string; currency: { currencyId: string; displayName: string; description?: string; metadata?: object; unitPlural?: string; unitSingular?: string; }; currentUsage: number; isGranted: boolean; type: 'CREDIT'; usageLimit: number; usageUpdatedAt: string; entitlementUpdatedAt?: string; usagePeriodEnd?: string; validUntil?: string; }[]; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.customers.retrieveEntitlements('x');\n\nconsole.log(response);\n```",
|
|
534
|
+
"## retrieve_entitlements\n\n`client.v1.customers.retrieveEntitlements(id: string, resourceId?: string): { data: object; }`\n\n**get** `/api/v1/customers/{id}/entitlements`\n\nRetrieves the effective entitlements for a customer or resource, including feature and credit entitlements.\n\n**Warning:** This REST API endpoint lacks built-in client-side caching, fallback mechanisms, and low-latency guarantees. It is not recommended for hot-path entitlement checks. For production use, consider using the Stigg Node Server SDK with caching or the Sidecar for low-latency cached responses.\n\n### Parameters\n\n- `id: string`\n\n- `resourceId?: string`\n Resource ID to scope entitlements to a specific resource\n\n### Returns\n\n- `{ data: { accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived'; entitlements: { accessDeniedReason: string; isGranted: boolean; type: 'FEATURE'; currentUsage?: number; entitlementUpdatedAt?: string; feature?: object; hasUnlimitedUsage?: boolean; resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR'; usageLimit?: number; usagePeriodAnchor?: string; usagePeriodEnd?: string; usagePeriodStart?: string; validUntil?: string; } | { accessDeniedReason: string; currency: object; currentUsage: number; isGranted: boolean; type: 'CREDIT'; usageLimit: number; usageUpdatedAt: string; entitlementUpdatedAt?: string; usagePeriodEnd?: string; validUntil?: string; }[]; }; }`\n Response object\n\n - `data: { accessDeniedReason: 'CustomerNotFound' | 'NoActiveSubscription' | 'CustomerIsArchived'; entitlements: { accessDeniedReason: string; isGranted: boolean; type: 'FEATURE'; currentUsage?: number; entitlementUpdatedAt?: string; feature?: { id: string; displayName: string; featureStatus: 'NEW' | 'SUSPENDED' | 'ACTIVE'; featureType: 'BOOLEAN' | 'NUMBER' | 'ENUM'; }; hasUnlimitedUsage?: boolean; resetPeriod?: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR'; usageLimit?: number; usagePeriodAnchor?: string; usagePeriodEnd?: string; usagePeriodStart?: string; validUntil?: string; } | { accessDeniedReason: string; currency: { currencyId: string; displayName: string; description?: string; metadata?: object; unitPlural?: string; unitSingular?: string; }; currentUsage: number; isGranted: boolean; type: 'CREDIT'; usageLimit: number; usageUpdatedAt: string; entitlementUpdatedAt?: string; usagePeriodEnd?: string; validUntil?: string; }[]; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.customers.retrieveEntitlements('x');\n\nconsole.log(response);\n```",
|
|
535
535
|
perLanguage: {
|
|
536
536
|
cli: {
|
|
537
537
|
method: 'customers retrieve_entitlements',
|
|
@@ -939,7 +939,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
939
939
|
response:
|
|
940
940
|
'{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }',
|
|
941
941
|
markdown:
|
|
942
|
-
"## link\n\n`client.v1.customers.integrations.link(id: string, id: string, syncedEntityId: string, vendorIdentifier: string): { data: object; }`\n\n**post** `/api/v1/customers/{id}/integrations`\n\nLinks a customer to an external integration by specifying the vendor and external entity ID.\n\n### Parameters\n\n- `id: string`\n\n- `id: string`\n Integration details\n\n- `syncedEntityId: string`\n Synced entity id\n\n- `vendorIdentifier: string`\n The vendor identifier of integration\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
942
|
+
"## link\n\n`client.v1.customers.integrations.link(id: string, id: string, syncedEntityId: string, vendorIdentifier: string): { data: object; }`\n\n**post** `/api/v1/customers/{id}/integrations`\n\nLinks a customer to an external integration by specifying the vendor and external entity ID.\n\n### Parameters\n\n- `id: string`\n\n- `id: string`\n Integration details\n\n- `syncedEntityId: string`\n Synced entity id\n\n- `vendorIdentifier: string`\n The vendor identifier of integration\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customerIntegrationResponse = await client.v1.customers.integrations.link('x', {\n id: 'id',\n syncedEntityId: 'syncedEntityId',\n vendorIdentifier: 'AUTH0',\n});\n\nconsole.log(customerIntegrationResponse);\n```",
|
|
943
943
|
perLanguage: {
|
|
944
944
|
cli: {
|
|
945
945
|
method: 'integrations link',
|
|
@@ -949,12 +949,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
949
949
|
csharp: {
|
|
950
950
|
method: 'V1.Customers.Integrations.Link',
|
|
951
951
|
example:
|
|
952
|
-
'IntegrationLinkParams parameters = new()\n{\n ID = "x",\n ID = "id",\n SyncedEntityID = "syncedEntityId",\n VendorIdentifier = VendorIdentifier.Auth0,\n};\n\nvar
|
|
952
|
+
'IntegrationLinkParams parameters = new()\n{\n ID = "x",\n ID = "id",\n SyncedEntityID = "syncedEntityId",\n VendorIdentifier = VendorIdentifier.Auth0,\n};\n\nvar customerIntegrationResponse = await client.V1.Customers.Integrations.Link(parameters);\n\nConsole.WriteLine(customerIntegrationResponse);',
|
|
953
953
|
},
|
|
954
954
|
go: {
|
|
955
955
|
method: 'client.V1.Customers.Integrations.Link',
|
|
956
956
|
example:
|
|
957
|
-
'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\
|
|
957
|
+
'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\tcustomerIntegrationResponse, err := client.V1.Customers.Integrations.Link(\n\t\tcontext.TODO(),\n\t\t"x",\n\t\tstigg.V1CustomerIntegrationLinkParams{\n\t\t\tID: "id",\n\t\t\tSyncedEntityID: "syncedEntityId",\n\t\t\tVendorIdentifier: stigg.V1CustomerIntegrationLinkParamsVendorIdentifierAuth0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customerIntegrationResponse.Data)\n}\n',
|
|
958
958
|
},
|
|
959
959
|
http: {
|
|
960
960
|
example:
|
|
@@ -963,22 +963,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
963
963
|
java: {
|
|
964
964
|
method: 'v1().customers().integrations().link',
|
|
965
965
|
example:
|
|
966
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.
|
|
966
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.CustomerIntegrationResponse;\nimport io.stigg.models.v1.customers.integrations.IntegrationLinkParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n IntegrationLinkParams params = IntegrationLinkParams.builder()\n .pathId("x")\n .bodyId("id")\n .syncedEntityId("syncedEntityId")\n .vendorIdentifier(IntegrationLinkParams.VendorIdentifier.AUTH0)\n .build();\n CustomerIntegrationResponse customerIntegrationResponse = client.v1().customers().integrations().link(params);\n }\n}',
|
|
967
967
|
},
|
|
968
968
|
python: {
|
|
969
969
|
method: 'v1.customers.integrations.link',
|
|
970
970
|
example:
|
|
971
|
-
'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)\
|
|
971
|
+
'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)\ncustomer_integration_response = client.v1.customers.integrations.link(\n path_id="x",\n body_id="id",\n synced_entity_id="syncedEntityId",\n vendor_identifier="AUTH0",\n)\nprint(customer_integration_response.data)',
|
|
972
972
|
},
|
|
973
973
|
ruby: {
|
|
974
974
|
method: 'v1.customers.integrations.link',
|
|
975
975
|
example:
|
|
976
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
976
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustomer_integration_response = stigg.v1.customers.integrations.link(\n "x",\n body_id: "id",\n synced_entity_id: "syncedEntityId",\n vendor_identifier: :AUTH0\n)\n\nputs(customer_integration_response)',
|
|
977
977
|
},
|
|
978
978
|
typescript: {
|
|
979
979
|
method: 'client.v1.customers.integrations.link',
|
|
980
980
|
example:
|
|
981
|
-
"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
|
|
981
|
+
"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 customerIntegrationResponse = await client.v1.customers.integrations.link('x', {\n id: 'id',\n syncedEntityId: 'syncedEntityId',\n vendorIdentifier: 'AUTH0',\n});\n\nconsole.log(customerIntegrationResponse.data);",
|
|
982
982
|
},
|
|
983
983
|
},
|
|
984
984
|
},
|
|
@@ -994,7 +994,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
994
994
|
response:
|
|
995
995
|
'{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }',
|
|
996
996
|
markdown:
|
|
997
|
-
"## retrieve\n\n`client.v1.customers.integrations.retrieve(id: string, integrationId: string): { data: object; }`\n\n**get** `/api/v1/customers/{id}/integrations/{integrationId}`\n\nRetrieves a specific integration for a customer by integration ID.\n\n### Parameters\n\n- `id: string`\n\n- `integrationId: string`\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
997
|
+
"## retrieve\n\n`client.v1.customers.integrations.retrieve(id: string, integrationId: string): { data: object; }`\n\n**get** `/api/v1/customers/{id}/integrations/{integrationId}`\n\nRetrieves a specific integration for a customer by integration ID.\n\n### Parameters\n\n- `id: string`\n\n- `integrationId: string`\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customerIntegrationResponse = await client.v1.customers.integrations.retrieve('integrationId', { id: 'id' });\n\nconsole.log(customerIntegrationResponse);\n```",
|
|
998
998
|
perLanguage: {
|
|
999
999
|
cli: {
|
|
1000
1000
|
method: 'integrations retrieve',
|
|
@@ -1004,12 +1004,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1004
1004
|
csharp: {
|
|
1005
1005
|
method: 'V1.Customers.Integrations.Retrieve',
|
|
1006
1006
|
example:
|
|
1007
|
-
'IntegrationRetrieveParams parameters = new()\n{\n ID = "id",\n IntegrationID = "integrationId",\n};\n\nvar
|
|
1007
|
+
'IntegrationRetrieveParams parameters = new()\n{\n ID = "id",\n IntegrationID = "integrationId",\n};\n\nvar customerIntegrationResponse = await client.V1.Customers.Integrations.Retrieve(parameters);\n\nConsole.WriteLine(customerIntegrationResponse);',
|
|
1008
1008
|
},
|
|
1009
1009
|
go: {
|
|
1010
1010
|
method: 'client.V1.Customers.Integrations.Get',
|
|
1011
1011
|
example:
|
|
1012
|
-
'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\
|
|
1012
|
+
'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\tcustomerIntegrationResponse, err := client.V1.Customers.Integrations.Get(\n\t\tcontext.TODO(),\n\t\t"integrationId",\n\t\tstigg.V1CustomerIntegrationGetParams{\n\t\t\tID: "id",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customerIntegrationResponse.Data)\n}\n',
|
|
1013
1013
|
},
|
|
1014
1014
|
http: {
|
|
1015
1015
|
example:
|
|
@@ -1018,22 +1018,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1018
1018
|
java: {
|
|
1019
1019
|
method: 'v1().customers().integrations().retrieve',
|
|
1020
1020
|
example:
|
|
1021
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.
|
|
1021
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.CustomerIntegrationResponse;\nimport io.stigg.models.v1.customers.integrations.IntegrationRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n IntegrationRetrieveParams params = IntegrationRetrieveParams.builder()\n .id("id")\n .integrationId("integrationId")\n .build();\n CustomerIntegrationResponse customerIntegrationResponse = client.v1().customers().integrations().retrieve(params);\n }\n}',
|
|
1022
1022
|
},
|
|
1023
1023
|
python: {
|
|
1024
1024
|
method: 'v1.customers.integrations.retrieve',
|
|
1025
1025
|
example:
|
|
1026
|
-
'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)\
|
|
1026
|
+
'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)\ncustomer_integration_response = client.v1.customers.integrations.retrieve(\n integration_id="integrationId",\n id="id",\n)\nprint(customer_integration_response.data)',
|
|
1027
1027
|
},
|
|
1028
1028
|
ruby: {
|
|
1029
1029
|
method: 'v1.customers.integrations.retrieve',
|
|
1030
1030
|
example:
|
|
1031
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
1031
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustomer_integration_response = stigg.v1.customers.integrations.retrieve("integrationId", id: "id")\n\nputs(customer_integration_response)',
|
|
1032
1032
|
},
|
|
1033
1033
|
typescript: {
|
|
1034
1034
|
method: 'client.v1.customers.integrations.retrieve',
|
|
1035
1035
|
example:
|
|
1036
|
-
"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
|
|
1036
|
+
"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 customerIntegrationResponse = await client.v1.customers.integrations.retrieve(\n 'integrationId',\n { id: 'id' },\n);\n\nconsole.log(customerIntegrationResponse.data);",
|
|
1037
1037
|
},
|
|
1038
1038
|
},
|
|
1039
1039
|
},
|
|
@@ -1049,7 +1049,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1049
1049
|
response:
|
|
1050
1050
|
'{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }',
|
|
1051
1051
|
markdown:
|
|
1052
|
-
"## update\n\n`client.v1.customers.integrations.update(id: string, integrationId: string, syncedEntityId: string): { data: object; }`\n\n**patch** `/api/v1/customers/{id}/integrations/{integrationId}`\n\nUpdates a customer's integration link, such as changing the synced external entity ID.\n\n### Parameters\n\n- `id: string`\n\n- `integrationId: string`\n\n- `syncedEntityId: string`\n Synced entity id\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
1052
|
+
"## update\n\n`client.v1.customers.integrations.update(id: string, integrationId: string, syncedEntityId: string): { data: object; }`\n\n**patch** `/api/v1/customers/{id}/integrations/{integrationId}`\n\nUpdates a customer's integration link, such as changing the synced external entity ID.\n\n### Parameters\n\n- `id: string`\n\n- `integrationId: string`\n\n- `syncedEntityId: string`\n Synced entity id\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customerIntegrationResponse = await client.v1.customers.integrations.update('integrationId', { id: 'id', syncedEntityId: 'syncedEntityId' });\n\nconsole.log(customerIntegrationResponse);\n```",
|
|
1053
1053
|
perLanguage: {
|
|
1054
1054
|
cli: {
|
|
1055
1055
|
method: 'integrations update',
|
|
@@ -1059,12 +1059,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1059
1059
|
csharp: {
|
|
1060
1060
|
method: 'V1.Customers.Integrations.Update',
|
|
1061
1061
|
example:
|
|
1062
|
-
'IntegrationUpdateParams parameters = new()\n{\n ID = "id",\n IntegrationID = "integrationId",\n SyncedEntityID = "syncedEntityId",\n};\n\nvar
|
|
1062
|
+
'IntegrationUpdateParams parameters = new()\n{\n ID = "id",\n IntegrationID = "integrationId",\n SyncedEntityID = "syncedEntityId",\n};\n\nvar customerIntegrationResponse = await client.V1.Customers.Integrations.Update(parameters);\n\nConsole.WriteLine(customerIntegrationResponse);',
|
|
1063
1063
|
},
|
|
1064
1064
|
go: {
|
|
1065
1065
|
method: 'client.V1.Customers.Integrations.Update',
|
|
1066
1066
|
example:
|
|
1067
|
-
'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\
|
|
1067
|
+
'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\tcustomerIntegrationResponse, err := client.V1.Customers.Integrations.Update(\n\t\tcontext.TODO(),\n\t\t"integrationId",\n\t\tstigg.V1CustomerIntegrationUpdateParams{\n\t\t\tID: "id",\n\t\t\tSyncedEntityID: stigg.String("syncedEntityId"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customerIntegrationResponse.Data)\n}\n',
|
|
1068
1068
|
},
|
|
1069
1069
|
http: {
|
|
1070
1070
|
example:
|
|
@@ -1073,22 +1073,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1073
1073
|
java: {
|
|
1074
1074
|
method: 'v1().customers().integrations().update',
|
|
1075
1075
|
example:
|
|
1076
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.
|
|
1076
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.CustomerIntegrationResponse;\nimport io.stigg.models.v1.customers.integrations.IntegrationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n IntegrationUpdateParams params = IntegrationUpdateParams.builder()\n .id("id")\n .integrationId("integrationId")\n .syncedEntityId("syncedEntityId")\n .build();\n CustomerIntegrationResponse customerIntegrationResponse = client.v1().customers().integrations().update(params);\n }\n}',
|
|
1077
1077
|
},
|
|
1078
1078
|
python: {
|
|
1079
1079
|
method: 'v1.customers.integrations.update',
|
|
1080
1080
|
example:
|
|
1081
|
-
'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)\
|
|
1081
|
+
'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)\ncustomer_integration_response = client.v1.customers.integrations.update(\n integration_id="integrationId",\n id="id",\n synced_entity_id="syncedEntityId",\n)\nprint(customer_integration_response.data)',
|
|
1082
1082
|
},
|
|
1083
1083
|
ruby: {
|
|
1084
1084
|
method: 'v1.customers.integrations.update',
|
|
1085
1085
|
example:
|
|
1086
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
1086
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustomer_integration_response = stigg.v1.customers.integrations.update("integrationId", id: "id", synced_entity_id: "syncedEntityId")\n\nputs(customer_integration_response)',
|
|
1087
1087
|
},
|
|
1088
1088
|
typescript: {
|
|
1089
1089
|
method: 'client.v1.customers.integrations.update',
|
|
1090
1090
|
example:
|
|
1091
|
-
"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
|
|
1091
|
+
"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 customerIntegrationResponse = await client.v1.customers.integrations.update('integrationId', {\n id: 'id',\n syncedEntityId: 'syncedEntityId',\n});\n\nconsole.log(customerIntegrationResponse.data);",
|
|
1092
1092
|
},
|
|
1093
1093
|
},
|
|
1094
1094
|
},
|
|
@@ -1104,7 +1104,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1104
1104
|
response:
|
|
1105
1105
|
'{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }',
|
|
1106
1106
|
markdown:
|
|
1107
|
-
"## unlink\n\n`client.v1.customers.integrations.unlink(id: string, integrationId: string): { data: object; }`\n\n**delete** `/api/v1/customers/{id}/integrations/{integrationId}`\n\nRemoves the link between a customer and an external integration.\n\n### Parameters\n\n- `id: string`\n\n- `integrationId: string`\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
1107
|
+
"## unlink\n\n`client.v1.customers.integrations.unlink(id: string, integrationId: string): { data: object; }`\n\n**delete** `/api/v1/customers/{id}/integrations/{integrationId}`\n\nRemoves the link between a customer and an external integration.\n\n### Parameters\n\n- `id: string`\n\n- `integrationId: string`\n\n### Returns\n\n- `{ data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }; }`\n Response object\n\n - `data: { id: string; syncedEntityId: string; vendorIdentifier: string; syncData?: { billingId: string; billingLinkUrl: string; priceGroupPackageBillingId: string; } | { billingId: string; billingLinkUrl: string; } | { dimensions: string; }; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst customerIntegrationResponse = await client.v1.customers.integrations.unlink('integrationId', { id: 'id' });\n\nconsole.log(customerIntegrationResponse);\n```",
|
|
1108
1108
|
perLanguage: {
|
|
1109
1109
|
cli: {
|
|
1110
1110
|
method: 'integrations unlink',
|
|
@@ -1114,12 +1114,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1114
1114
|
csharp: {
|
|
1115
1115
|
method: 'V1.Customers.Integrations.Unlink',
|
|
1116
1116
|
example:
|
|
1117
|
-
'IntegrationUnlinkParams parameters = new()\n{\n ID = "id",\n IntegrationID = "integrationId",\n};\n\nvar
|
|
1117
|
+
'IntegrationUnlinkParams parameters = new()\n{\n ID = "id",\n IntegrationID = "integrationId",\n};\n\nvar customerIntegrationResponse = await client.V1.Customers.Integrations.Unlink(parameters);\n\nConsole.WriteLine(customerIntegrationResponse);',
|
|
1118
1118
|
},
|
|
1119
1119
|
go: {
|
|
1120
1120
|
method: 'client.V1.Customers.Integrations.Unlink',
|
|
1121
1121
|
example:
|
|
1122
|
-
'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\
|
|
1122
|
+
'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\tcustomerIntegrationResponse, err := client.V1.Customers.Integrations.Unlink(\n\t\tcontext.TODO(),\n\t\t"integrationId",\n\t\tstigg.V1CustomerIntegrationUnlinkParams{\n\t\t\tID: "id",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customerIntegrationResponse.Data)\n}\n',
|
|
1123
1123
|
},
|
|
1124
1124
|
http: {
|
|
1125
1125
|
example:
|
|
@@ -1128,22 +1128,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1128
1128
|
java: {
|
|
1129
1129
|
method: 'v1().customers().integrations().unlink',
|
|
1130
1130
|
example:
|
|
1131
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.
|
|
1131
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.customers.CustomerIntegrationResponse;\nimport io.stigg.models.v1.customers.integrations.IntegrationUnlinkParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n IntegrationUnlinkParams params = IntegrationUnlinkParams.builder()\n .id("id")\n .integrationId("integrationId")\n .build();\n CustomerIntegrationResponse customerIntegrationResponse = client.v1().customers().integrations().unlink(params);\n }\n}',
|
|
1132
1132
|
},
|
|
1133
1133
|
python: {
|
|
1134
1134
|
method: 'v1.customers.integrations.unlink',
|
|
1135
1135
|
example:
|
|
1136
|
-
'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)\
|
|
1136
|
+
'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)\ncustomer_integration_response = client.v1.customers.integrations.unlink(\n integration_id="integrationId",\n id="id",\n)\nprint(customer_integration_response.data)',
|
|
1137
1137
|
},
|
|
1138
1138
|
ruby: {
|
|
1139
1139
|
method: 'v1.customers.integrations.unlink',
|
|
1140
1140
|
example:
|
|
1141
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
1141
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\ncustomer_integration_response = stigg.v1.customers.integrations.unlink("integrationId", id: "id")\n\nputs(customer_integration_response)',
|
|
1142
1142
|
},
|
|
1143
1143
|
typescript: {
|
|
1144
1144
|
method: 'client.v1.customers.integrations.unlink',
|
|
1145
1145
|
example:
|
|
1146
|
-
"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
|
|
1146
|
+
"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 customerIntegrationResponse = await client.v1.customers.integrations.unlink('integrationId', {\n id: 'id',\n});\n\nconsole.log(customerIntegrationResponse.data);",
|
|
1147
1147
|
},
|
|
1148
1148
|
},
|
|
1149
1149
|
},
|
|
@@ -4547,13 +4547,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4547
4547
|
'startDate: string;',
|
|
4548
4548
|
'endDate?: string;',
|
|
4549
4549
|
'groupBy?: string;',
|
|
4550
|
-
'includeInactiveSubscriptions?: boolean;',
|
|
4551
4550
|
'resourceId?: string;',
|
|
4552
4551
|
],
|
|
4553
4552
|
response:
|
|
4554
4553
|
"{ data: { markers: { timestamp: string; type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET'; }[]; series: { points: object[]; tags: object[]; }[]; }; }",
|
|
4555
4554
|
markdown:
|
|
4556
|
-
"## history\n\n`client.v1.usage.history(customerId: string, featureId: string, startDate: string, endDate?: string, groupBy?: string,
|
|
4555
|
+
"## history\n\n`client.v1.usage.history(customerId: string, featureId: string, startDate: string, endDate?: string, groupBy?: string, resourceId?: string): { data: object; }`\n\n**get** `/api/v1/usage/{customerId}/history/{featureId}`\n\nRetrieves historical usage data for a customer's metered feature over time.\n\n### Parameters\n\n- `customerId: string`\n\n- `featureId: string`\n\n- `startDate: string`\n The start date of the range\n\n- `endDate?: string`\n The end date of the range\n\n- `groupBy?: string`\n Criteria by which to group the usage history\n\n- `resourceId?: string`\n Resource id\n\n### Returns\n\n- `{ data: { markers: { timestamp: string; type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET'; }[]; series: { points: object[]; tags: object[]; }[]; }; }`\n Response object\n\n - `data: { markers: { timestamp: string; type: 'PERIODIC_RESET' | 'SUBSCRIPTION_CHANGE_RESET'; }[]; series: { points: { isResetPoint: boolean; timestamp: string; value: number; }[]; tags: { key: string; value: string; }[]; }[]; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst response = await client.v1.usage.history('featureId', { customerId: 'customerId', startDate: '2019-12-27T18:11:19.117Z' });\n\nconsole.log(response);\n```",
|
|
4557
4556
|
perLanguage: {
|
|
4558
4557
|
cli: {
|
|
4559
4558
|
method: 'usage history',
|
|
@@ -4960,7 +4959,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4960
4959
|
response:
|
|
4961
4960
|
"{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }",
|
|
4962
4961
|
markdown:
|
|
4963
|
-
"## provision\n\n`client.internal.beta.eventQueues.provision(region: string, allowedAssumeRoleArns?: string[], createLowPriorityQueues?: boolean, eventTypes?: string[], suffix?: string): { data: object; }`\n\n**post** `/internal/beta/event-queues/provision`\n\nProvision SQS queue, SNS subscriptions, and IAM role for the current environment\n\n### Parameters\n\n- `region: string`\n AWS region for the SQS queue (e.g., us-east-1, eu-west-1)\n\n- `allowedAssumeRoleArns?: string[]`\n Additional IAM role ARNs allowed to assume the external role for queue access\n\n- `createLowPriorityQueues?: boolean`\n Whether to create separate low-priority queues for standard topic events\n\n- `eventTypes?: string[]`\n Event types to subscribe to. Defaults to entitlements, measurements, and migrations.\n\n- `suffix?: string`\n Optional suffix to allow multiple queues for the same environment and region\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
4962
|
+
"## provision\n\n`client.internal.beta.eventQueues.provision(region: string, allowedAssumeRoleArns?: string[], createLowPriorityQueues?: boolean, eventTypes?: string[], suffix?: string): { data: object; }`\n\n**post** `/internal/beta/event-queues/provision`\n\nProvision SQS queue, SNS subscriptions, and IAM role for the current environment\n\n### Parameters\n\n- `region: string`\n AWS region for the SQS queue (e.g., us-east-1, eu-west-1)\n\n- `allowedAssumeRoleArns?: string[]`\n Additional IAM role ARNs allowed to assume the external role for queue access\n\n- `createLowPriorityQueues?: boolean`\n Whether to create separate low-priority queues for standard topic events\n\n- `eventTypes?: string[]`\n Event types to subscribe to. Defaults to entitlements, measurements, and migrations.\n\n- `suffix?: string`\n Optional suffix to allow multiple queues for the same environment and region\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst eventQueueResponse = await client.internal.beta.eventQueues.provision({ region: 'us-east-1' });\n\nconsole.log(eventQueueResponse);\n```",
|
|
4964
4963
|
perLanguage: {
|
|
4965
4964
|
cli: {
|
|
4966
4965
|
method: 'event_queues provision',
|
|
@@ -4970,12 +4969,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4970
4969
|
csharp: {
|
|
4971
4970
|
method: 'Internal.Beta.EventQueues.Provision',
|
|
4972
4971
|
example:
|
|
4973
|
-
'EventQueueProvisionParams parameters = new() { Region = Region.UsEast1 };\n\nvar
|
|
4972
|
+
'EventQueueProvisionParams parameters = new() { Region = Region.UsEast1 };\n\nvar eventQueueResponse = await client.Internal.Beta.EventQueues.Provision(parameters);\n\nConsole.WriteLine(eventQueueResponse);',
|
|
4974
4973
|
},
|
|
4975
4974
|
go: {
|
|
4976
4975
|
method: 'client.Internal.Beta.EventQueues.Provision',
|
|
4977
4976
|
example:
|
|
4978
|
-
'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\
|
|
4977
|
+
'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\teventQueueResponse, err := client.Internal.Beta.EventQueues.Provision(context.TODO(), stigg.InternalBetaEventQueueProvisionParams{\n\t\tRegion: stigg.InternalBetaEventQueueProvisionParamsRegionUsEast1,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventQueueResponse.Data)\n}\n',
|
|
4979
4978
|
},
|
|
4980
4979
|
http: {
|
|
4981
4980
|
example:
|
|
@@ -4984,22 +4983,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4984
4983
|
java: {
|
|
4985
4984
|
method: 'internal_().beta().eventQueues().provision',
|
|
4986
4985
|
example:
|
|
4987
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueProvisionParams;\nimport io.stigg.models.internal_.beta.eventqueues.
|
|
4986
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueProvisionParams;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n EventQueueProvisionParams params = EventQueueProvisionParams.builder()\n .region(EventQueueProvisionParams.Region.US_EAST_1)\n .build();\n EventQueueResponse eventQueueResponse = client.internal_().beta().eventQueues().provision(params);\n }\n}',
|
|
4988
4987
|
},
|
|
4989
4988
|
python: {
|
|
4990
4989
|
method: 'internal.beta.event_queues.provision',
|
|
4991
4990
|
example:
|
|
4992
|
-
'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)\
|
|
4991
|
+
'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)\nevent_queue_response = client.internal.beta.event_queues.provision(\n region="us-east-1",\n)\nprint(event_queue_response.data)',
|
|
4993
4992
|
},
|
|
4994
4993
|
ruby: {
|
|
4995
4994
|
method: 'internal.beta.event_queues.provision',
|
|
4996
4995
|
example:
|
|
4997
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
4996
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nevent_queue_response = stigg.internal.beta.event_queues.provision(region: :"us-east-1")\n\nputs(event_queue_response)',
|
|
4998
4997
|
},
|
|
4999
4998
|
typescript: {
|
|
5000
4999
|
method: 'client.internal.beta.eventQueues.provision',
|
|
5001
5000
|
example:
|
|
5002
|
-
"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
|
|
5001
|
+
"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 eventQueueResponse = await client.internal.beta.eventQueues.provision({\n region: 'us-east-1',\n});\n\nconsole.log(eventQueueResponse.data);",
|
|
5003
5002
|
},
|
|
5004
5003
|
},
|
|
5005
5004
|
},
|
|
@@ -5068,7 +5067,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5068
5067
|
response:
|
|
5069
5068
|
"{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }",
|
|
5070
5069
|
markdown:
|
|
5071
|
-
"## retrieve\n\n`client.internal.beta.eventQueues.retrieve(queueName: string): { data: object; }`\n\n**get** `/internal/beta/event-queues/{queueName}`\n\nGet event queue by queue name\n\n### Parameters\n\n- `queueName: string`\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
5070
|
+
"## retrieve\n\n`client.internal.beta.eventQueues.retrieve(queueName: string): { data: object; }`\n\n**get** `/internal/beta/event-queues/{queueName}`\n\nGet event queue by queue name\n\n### Parameters\n\n- `queueName: string`\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst eventQueueResponse = await client.internal.beta.eventQueues.retrieve('x');\n\nconsole.log(eventQueueResponse);\n```",
|
|
5072
5071
|
perLanguage: {
|
|
5073
5072
|
cli: {
|
|
5074
5073
|
method: 'event_queues retrieve',
|
|
@@ -5078,12 +5077,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5078
5077
|
csharp: {
|
|
5079
5078
|
method: 'Internal.Beta.EventQueues.Retrieve',
|
|
5080
5079
|
example:
|
|
5081
|
-
'EventQueueRetrieveParams parameters = new() { QueueName = "x" };\n\nvar
|
|
5080
|
+
'EventQueueRetrieveParams parameters = new() { QueueName = "x" };\n\nvar eventQueueResponse = await client.Internal.Beta.EventQueues.Retrieve(parameters);\n\nConsole.WriteLine(eventQueueResponse);',
|
|
5082
5081
|
},
|
|
5083
5082
|
go: {
|
|
5084
5083
|
method: 'client.Internal.Beta.EventQueues.Get',
|
|
5085
5084
|
example:
|
|
5086
|
-
'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\
|
|
5085
|
+
'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\teventQueueResponse, err := client.Internal.Beta.EventQueues.Get(context.TODO(), "x")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventQueueResponse.Data)\n}\n',
|
|
5087
5086
|
},
|
|
5088
5087
|
http: {
|
|
5089
5088
|
example:
|
|
@@ -5092,22 +5091,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5092
5091
|
java: {
|
|
5093
5092
|
method: 'internal_().beta().eventQueues().retrieve',
|
|
5094
5093
|
example:
|
|
5095
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.
|
|
5094
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueResponse;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n EventQueueResponse eventQueueResponse = client.internal_().beta().eventQueues().retrieve("x");\n }\n}',
|
|
5096
5095
|
},
|
|
5097
5096
|
python: {
|
|
5098
5097
|
method: 'internal.beta.event_queues.retrieve',
|
|
5099
5098
|
example:
|
|
5100
|
-
'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)\
|
|
5099
|
+
'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)\nevent_queue_response = client.internal.beta.event_queues.retrieve(\n "x",\n)\nprint(event_queue_response.data)',
|
|
5101
5100
|
},
|
|
5102
5101
|
ruby: {
|
|
5103
5102
|
method: 'internal.beta.event_queues.retrieve',
|
|
5104
5103
|
example:
|
|
5105
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
5104
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nevent_queue_response = stigg.internal.beta.event_queues.retrieve("x")\n\nputs(event_queue_response)',
|
|
5106
5105
|
},
|
|
5107
5106
|
typescript: {
|
|
5108
5107
|
method: 'client.internal.beta.eventQueues.retrieve',
|
|
5109
5108
|
example:
|
|
5110
|
-
"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
|
|
5109
|
+
"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 eventQueueResponse = await client.internal.beta.eventQueues.retrieve('x');\n\nconsole.log(eventQueueResponse.data);",
|
|
5111
5110
|
},
|
|
5112
5111
|
},
|
|
5113
5112
|
},
|
|
@@ -5128,7 +5127,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5128
5127
|
response:
|
|
5129
5128
|
"{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }",
|
|
5130
5129
|
markdown:
|
|
5131
|
-
"## update\n\n`client.internal.beta.eventQueues.update(queueName: string, allowedAssumeRoleArns?: string[], createLowPriorityQueues?: boolean, eventTypes?: string[]): { data: object; }`\n\n**patch** `/internal/beta/event-queues/{queueName}`\n\nUpdate event queue configuration\n\n### Parameters\n\n- `queueName: string`\n\n- `allowedAssumeRoleArns?: string[]`\n\n- `createLowPriorityQueues?: boolean`\n Whether to create separate low-priority queues for standard topic events\n\n- `eventTypes?: string[]`\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
5130
|
+
"## update\n\n`client.internal.beta.eventQueues.update(queueName: string, allowedAssumeRoleArns?: string[], createLowPriorityQueues?: boolean, eventTypes?: string[]): { data: object; }`\n\n**patch** `/internal/beta/event-queues/{queueName}`\n\nUpdate event queue configuration\n\n### Parameters\n\n- `queueName: string`\n\n- `allowedAssumeRoleArns?: string[]`\n\n- `createLowPriorityQueues?: boolean`\n Whether to create separate low-priority queues for standard topic events\n\n- `eventTypes?: string[]`\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst eventQueueResponse = await client.internal.beta.eventQueues.update('x');\n\nconsole.log(eventQueueResponse);\n```",
|
|
5132
5131
|
perLanguage: {
|
|
5133
5132
|
cli: {
|
|
5134
5133
|
method: 'event_queues update',
|
|
@@ -5137,12 +5136,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5137
5136
|
csharp: {
|
|
5138
5137
|
method: 'Internal.Beta.EventQueues.Update',
|
|
5139
5138
|
example:
|
|
5140
|
-
'EventQueueUpdateParams parameters = new() { QueueName = "x" };\n\nvar
|
|
5139
|
+
'EventQueueUpdateParams parameters = new() { QueueName = "x" };\n\nvar eventQueueResponse = await client.Internal.Beta.EventQueues.Update(parameters);\n\nConsole.WriteLine(eventQueueResponse);',
|
|
5141
5140
|
},
|
|
5142
5141
|
go: {
|
|
5143
5142
|
method: 'client.Internal.Beta.EventQueues.Update',
|
|
5144
5143
|
example:
|
|
5145
|
-
'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\
|
|
5144
|
+
'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\teventQueueResponse, err := client.Internal.Beta.EventQueues.Update(\n\t\tcontext.TODO(),\n\t\t"x",\n\t\tstigg.InternalBetaEventQueueUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventQueueResponse.Data)\n}\n',
|
|
5146
5145
|
},
|
|
5147
5146
|
http: {
|
|
5148
5147
|
example:
|
|
@@ -5151,22 +5150,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5151
5150
|
java: {
|
|
5152
5151
|
method: 'internal_().beta().eventQueues().update',
|
|
5153
5152
|
example:
|
|
5154
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.
|
|
5153
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueResponse;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n EventQueueResponse eventQueueResponse = client.internal_().beta().eventQueues().update("x");\n }\n}',
|
|
5155
5154
|
},
|
|
5156
5155
|
python: {
|
|
5157
5156
|
method: 'internal.beta.event_queues.update',
|
|
5158
5157
|
example:
|
|
5159
|
-
'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)\
|
|
5158
|
+
'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)\nevent_queue_response = client.internal.beta.event_queues.update(\n queue_name="x",\n)\nprint(event_queue_response.data)',
|
|
5160
5159
|
},
|
|
5161
5160
|
ruby: {
|
|
5162
5161
|
method: 'internal.beta.event_queues.update',
|
|
5163
5162
|
example:
|
|
5164
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
5163
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nevent_queue_response = stigg.internal.beta.event_queues.update("x")\n\nputs(event_queue_response)',
|
|
5165
5164
|
},
|
|
5166
5165
|
typescript: {
|
|
5167
5166
|
method: 'client.internal.beta.eventQueues.update',
|
|
5168
5167
|
example:
|
|
5169
|
-
"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
|
|
5168
|
+
"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 eventQueueResponse = await client.internal.beta.eventQueues.update('x');\n\nconsole.log(eventQueueResponse.data);",
|
|
5170
5169
|
},
|
|
5171
5170
|
},
|
|
5172
5171
|
},
|
|
@@ -5182,7 +5181,7 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5182
5181
|
response:
|
|
5183
5182
|
"{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }",
|
|
5184
5183
|
markdown:
|
|
5185
|
-
"## delete\n\n`client.internal.beta.eventQueues.delete(queueName: string): { data: object; }`\n\n**delete** `/internal/beta/event-queues/{queueName}`\n\nDelete an event queue and tear down its infrastructure\n\n### Parameters\n\n- `queueName: string`\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst
|
|
5184
|
+
"## delete\n\n`client.internal.beta.eventQueues.delete(queueName: string): { data: object; }`\n\n**delete** `/internal/beta/event-queues/{queueName}`\n\nDelete an event queue and tear down its infrastructure\n\n### Parameters\n\n- `queueName: string`\n\n### Returns\n\n- `{ data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }; }`\n Response object\n\n - `data: { createdAt: string; queueName: string; region: string; status: 'PROVISIONING' | 'ACTIVE' | 'FAILED' | 'DEPROVISIONING'; updatedAt: string; queueUrl?: string; roleArn?: string; suffix?: string; }`\n\n### Example\n\n```typescript\nimport Stigg from '@stigg/typescript';\n\nconst client = new Stigg();\n\nconst eventQueueResponse = await client.internal.beta.eventQueues.delete('x');\n\nconsole.log(eventQueueResponse);\n```",
|
|
5186
5185
|
perLanguage: {
|
|
5187
5186
|
cli: {
|
|
5188
5187
|
method: 'event_queues delete',
|
|
@@ -5191,12 +5190,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5191
5190
|
csharp: {
|
|
5192
5191
|
method: 'Internal.Beta.EventQueues.Delete',
|
|
5193
5192
|
example:
|
|
5194
|
-
'EventQueueDeleteParams parameters = new() { QueueName = "x" };\n\nvar
|
|
5193
|
+
'EventQueueDeleteParams parameters = new() { QueueName = "x" };\n\nvar eventQueueResponse = await client.Internal.Beta.EventQueues.Delete(parameters);\n\nConsole.WriteLine(eventQueueResponse);',
|
|
5195
5194
|
},
|
|
5196
5195
|
go: {
|
|
5197
5196
|
method: 'client.Internal.Beta.EventQueues.Delete',
|
|
5198
5197
|
example:
|
|
5199
|
-
'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\
|
|
5198
|
+
'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\teventQueueResponse, err := client.Internal.Beta.EventQueues.Delete(context.TODO(), "x")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventQueueResponse.Data)\n}\n',
|
|
5200
5199
|
},
|
|
5201
5200
|
http: {
|
|
5202
5201
|
example:
|
|
@@ -5205,22 +5204,22 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5205
5204
|
java: {
|
|
5206
5205
|
method: 'internal_().beta().eventQueues().delete',
|
|
5207
5206
|
example:
|
|
5208
|
-
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueDeleteParams;\nimport io.stigg.models.internal_.beta.eventqueues.
|
|
5207
|
+
'package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueDeleteParams;\nimport io.stigg.models.internal_.beta.eventqueues.EventQueueResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n EventQueueResponse eventQueueResponse = client.internal_().beta().eventQueues().delete("x");\n }\n}',
|
|
5209
5208
|
},
|
|
5210
5209
|
python: {
|
|
5211
5210
|
method: 'internal.beta.event_queues.delete',
|
|
5212
5211
|
example:
|
|
5213
|
-
'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)\
|
|
5212
|
+
'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)\nevent_queue_response = client.internal.beta.event_queues.delete(\n "x",\n)\nprint(event_queue_response.data)',
|
|
5214
5213
|
},
|
|
5215
5214
|
ruby: {
|
|
5216
5215
|
method: 'internal.beta.event_queues.delete',
|
|
5217
5216
|
example:
|
|
5218
|
-
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\
|
|
5217
|
+
'require "stigg"\n\nstigg = Stigg::Client.new(api_key: "My API Key")\n\nevent_queue_response = stigg.internal.beta.event_queues.delete("x")\n\nputs(event_queue_response)',
|
|
5219
5218
|
},
|
|
5220
5219
|
typescript: {
|
|
5221
5220
|
method: 'client.internal.beta.eventQueues.delete',
|
|
5222
5221
|
example:
|
|
5223
|
-
"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
|
|
5222
|
+
"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 eventQueueResponse = await client.internal.beta.eventQueues.delete('x');\n\nconsole.log(eventQueueResponse.data);",
|
|
5224
5223
|
},
|
|
5225
5224
|
},
|
|
5226
5225
|
},
|
|
@@ -5260,7 +5259,7 @@ const EMBEDDED_READMES: { language: string; content: string }[] = [
|
|
|
5260
5259
|
{
|
|
5261
5260
|
language: 'cli',
|
|
5262
5261
|
content:
|
|
5263
|
-
"# Stigg CLI\n\nThe official CLI for the Stigg REST API.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n<!-- x-release-please-start-version -->\n\n## Installation\n\n### Installing with Homebrew\n\n~~~sh\nbrew install stiggio/tools/stigg\n~~~\n\n### Installing with Go\n\nTo test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.\n\n~~~sh\ngo install 'github.com/stiggio/stigg-cli/cmd/stigg@latest'\n~~~\n\nOnce you have run `go install`, the binary is placed in your Go bin directory:\n\n- **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set)\n- **Check your path**: Run `go env GOPATH` to see the base directory\n\nIf commands aren't found after installation, add the Go bin directory to your PATH:\n\n~~~sh\n# Add to your shell profile (.zshrc, .bashrc, etc.)\nexport PATH=\"$PATH:$(go env GOPATH)/bin\"\n~~~\n\n<!-- x-release-please-end -->\n\n### Running Locally\n\nAfter cloning the git repository for this project, you can use the\n`scripts/run` script to run the tool locally:\n\n~~~sh\n./scripts/run args...\n~~~\n\n## Usage\n\nThe CLI follows a resource-based command structure:\n\n~~~sh\nstigg [resource] <command> [flags...]\n~~~\n\n~~~sh\nstigg v1:customers retrieve \\\n --api-key 'My API Key' \\\n --id REPLACE_ME\n~~~\n\nFor details about specific commands, use the `--help` flag.\n\n### Environment variables\n\n| Environment variable | Required |\n| -------------------- | -------- |\n| `STIGG_API_KEY` | yes |\n\n### Global flags\n\n- `--api-key` (can also be set with `STIGG_API_KEY` env var)\n- `--help` - Show command line usage\n- `--debug` - Enable debug logging (includes HTTP request/response details)\n- `--version`, `-v` - Show the CLI version\n- `--base-url` - Use a custom API backend URL\n- `--format` - Change the output format (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--format-error` - Change the output format for errors (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--transform` - Transform the data output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n- `--transform-error` - Transform the error output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n\n### Passing files as arguments\n\nTo pass files to your API, you can use the `@myfile.ext` syntax:\n\n~~~bash\nstigg <command> --arg @abe.jpg\n~~~\n\nFiles can also be passed inside JSON or YAML blobs:\n\n~~~bash\nstigg <command> --arg '{image: \"@abe.jpg\"}'\n# Equivalent:\nstigg <command> <<YAML\narg:\n image: \"@abe.jpg\"\nYAML\n~~~\n\nIf you need to pass a string literal that begins with an `@` sign, you can\nescape the `@` sign to avoid accidentally passing a file.\n\n~~~bash\nstigg <command> --username '\\@abe'\n~~~\n\n#### Explicit encoding\n\nFor JSON endpoints, the CLI tool does filetype sniffing to determine whether the\nfile contents should be sent as a string literal (for plain text files) or as a\nbase64-encoded string literal (for binary files). If you need to explicitly send\nthe file as either plain text or base64-encoded data, you can use\n`@file://myfile.txt` (for string encoding) or `@data://myfile.dat` (for\nbase64-encoding). Note that absolute paths will begin with `@file://` or\n`@data://`, followed by a third `/` (for example, `@file:///tmp/file.txt`).\n\n~~~bash\nstigg <command> --arg @data://file.txt\n~~~\n",
|
|
5262
|
+
"# Stigg CLI\n\nThe official CLI for the Stigg REST API.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n<!-- x-release-please-start-version -->\n\n## Installation\n\n### Installing with Homebrew\n\n~~~sh\nbrew install stiggio/tools/stigg\n~~~\n\n### Installing with Go\n\nTo test or install the CLI locally, you need [Go](https://go.dev/doc/install) version 1.22 or later installed.\n\n~~~sh\ngo install 'github.com/stiggio/stigg-cli/cmd/stigg@latest'\n~~~\n\nOnce you have run `go install`, the binary is placed in your Go bin directory:\n\n- **Default location**: `$HOME/go/bin` (or `$GOPATH/bin` if GOPATH is set)\n- **Check your path**: Run `go env GOPATH` to see the base directory\n\nIf commands aren't found after installation, add the Go bin directory to your PATH:\n\n~~~sh\n# Add to your shell profile (.zshrc, .bashrc, etc.)\nexport PATH=\"$PATH:$(go env GOPATH)/bin\"\n~~~\n\n<!-- x-release-please-end -->\n\n### Running Locally\n\nAfter cloning the git repository for this project, you can use the\n`scripts/run` script to run the tool locally:\n\n~~~sh\n./scripts/run args...\n~~~\n\n## Usage\n\nThe CLI follows a resource-based command structure:\n\n~~~sh\nstigg [resource] <command> [flags...]\n~~~\n\n~~~sh\nstigg v1:customers retrieve \\\n --api-key 'My API Key' \\\n --id REPLACE_ME\n~~~\n\nFor details about specific commands, use the `--help` flag.\n\n### Environment variables\n\n| Environment variable | Required |\n| -------------------- | -------- |\n| `STIGG_API_KEY` | yes |\n\n### Global flags\n\n- `--api-key` (can also be set with `STIGG_API_KEY` env var)\n- `--help` - Show command line usage\n- `--debug` - Enable debug logging (includes HTTP request/response details)\n- `--version`, `-v` - Show the CLI version\n- `--base-url` - Use a custom API backend URL\n- `--format` - Change the output format (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--format-error` - Change the output format for errors (`auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`)\n- `--transform` - Transform the data output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n- `--transform-error` - Transform the error output using [GJSON syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)\n\n### Passing files as arguments\n\nTo pass files to your API, you can use the `@myfile.ext` syntax:\n\n~~~bash\nstigg <command> --arg @abe.jpg\n~~~\n\nFiles can also be passed inside JSON or YAML blobs:\n\n~~~bash\nstigg <command> --arg '{image: \"@abe.jpg\"}'\n# Equivalent:\nstigg <command> <<YAML\narg:\n image: \"@abe.jpg\"\nYAML\n~~~\n\nIf you need to pass a string literal that begins with an `@` sign, you can\nescape the `@` sign to avoid accidentally passing a file.\n\n~~~bash\nstigg <command> --username '\\@abe'\n~~~\n\n#### Explicit encoding\n\nFor JSON endpoints, the CLI tool does filetype sniffing to determine whether the\nfile contents should be sent as a string literal (for plain text files) or as a\nbase64-encoded string literal (for binary files). If you need to explicitly send\nthe file as either plain text or base64-encoded data, you can use\n`@file://myfile.txt` (for string encoding) or `@data://myfile.dat` (for\nbase64-encoding). Note that absolute paths will begin with `@file://` or\n`@data://`, followed by a third `/` (for example, `@file:///tmp/file.txt`).\n\n~~~bash\nstigg <command> --arg @data://file.txt\n~~~\n\n## Linking different Go SDK versions\n\nYou can link the CLI against a different version of the Stigg Go SDK\nfor development purposes using the `./scripts/link` script.\n\nTo link to a specific version from a repository (version can be a branch,\ngit tag, or commit hash):\n\n~~~bash\n./scripts/link github.com/org/repo@version\n~~~\n\nTo link to a local copy of the SDK:\n\n~~~bash\n./scripts/link ../path/to/stigg-go\n~~~\n\nIf you run the link script without any arguments, it will default to `../stigg-go`.\n",
|
|
5264
5263
|
},
|
|
5265
5264
|
];
|
|
5266
5265
|
|
package/src/server.ts
CHANGED
package/src/util.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
export const readEnv = (env: string): string | undefined => {
|
|
4
4
|
if (typeof (globalThis as any).process !== 'undefined') {
|
|
5
|
-
return (globalThis as any).process.env?.[env]?.trim();
|
|
5
|
+
return (globalThis as any).process.env?.[env]?.trim() || undefined;
|
|
6
6
|
} else if (typeof (globalThis as any).Deno !== 'undefined') {
|
|
7
|
-
return (globalThis as any).Deno.env?.get?.(env)?.trim();
|
|
7
|
+
return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
|
|
8
8
|
}
|
|
9
9
|
return;
|
|
10
10
|
};
|
package/util.js
CHANGED
|
@@ -4,10 +4,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.requireValue = exports.readEnvOrError = exports.readEnv = void 0;
|
|
5
5
|
const readEnv = (env) => {
|
|
6
6
|
if (typeof globalThis.process !== 'undefined') {
|
|
7
|
-
return globalThis.process.env?.[env]?.trim();
|
|
7
|
+
return globalThis.process.env?.[env]?.trim() || undefined;
|
|
8
8
|
}
|
|
9
9
|
else if (typeof globalThis.Deno !== 'undefined') {
|
|
10
|
-
return globalThis.Deno.env?.get?.(env)?.trim();
|
|
10
|
+
return globalThis.Deno.env?.get?.(env)?.trim() || undefined;
|
|
11
11
|
}
|
|
12
12
|
return;
|
|
13
13
|
};
|