@hyperscale0/sdk 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/client.d.ts +38 -0
- package/client.js +80 -0
- package/package.json +26 -0
- package/platform.d.ts +486 -0
package/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# @hyperscale0/sdk
|
|
2
|
+
|
|
3
|
+
One client for every Hyperscale Product. Platform types ship with the package.
|
|
4
|
+
Instrument fields and public action inputs come from the admitted Build at runtime.
|
|
5
|
+
|
|
6
|
+
```js
|
|
7
|
+
import { createClient } from "@hyperscale0/sdk";
|
|
8
|
+
|
|
9
|
+
const client = createClient({
|
|
10
|
+
apiKey: process.env.HYPERSCALE_API_KEY,
|
|
11
|
+
productId: process.env.HYPERSCALE_PRODUCT_ID,
|
|
12
|
+
});
|
|
13
|
+
const { instruments, actions } = await client.discover();
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Use `client.call(operationName, input, { idempotencyKey })` for platform operations.
|
|
17
|
+
Their names and types match the operation descriptors.
|
|
18
|
+
|
|
19
|
+
Call `client.act(name, input, { idempotencyKey })` with an action name and input
|
|
20
|
+
from discovery. Reuse the same idempotency key and input when retrying a request.
|
|
21
|
+
The client never retries a mutation automatically. Keys stay in your environment.
|
|
22
|
+
Set `baseUrl` and `environment` to select an estate and sandbox or live plane.
|
|
23
|
+
|
|
24
|
+
Security: https://hyperscale0.ai/security
|
|
25
|
+
|
|
26
|
+
License: LicenseRef-Hyperscale-Proprietary
|
package/client.d.ts
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
Operations,
|
|
3
|
+
product_instruments_listOutput,
|
|
4
|
+
product_actions_listOutput,
|
|
5
|
+
} from "./platform.js";
|
|
6
|
+
export type * from "./platform.js";
|
|
7
|
+
|
|
8
|
+
export interface ClientOptions {
|
|
9
|
+
apiKey: string;
|
|
10
|
+
productId: string;
|
|
11
|
+
baseUrl?: string;
|
|
12
|
+
environment?: "sandbox" | "live";
|
|
13
|
+
}
|
|
14
|
+
export interface ActionInput {
|
|
15
|
+
instanceId?: string;
|
|
16
|
+
fields?: Record<string, unknown>;
|
|
17
|
+
parties?: Record<string, string>;
|
|
18
|
+
input?: Record<string, unknown>;
|
|
19
|
+
}
|
|
20
|
+
export interface Client {
|
|
21
|
+
discover(): Promise<{
|
|
22
|
+
instruments: product_instruments_listOutput;
|
|
23
|
+
actions: product_actions_listOutput;
|
|
24
|
+
}>;
|
|
25
|
+
call<Name extends keyof Operations>(
|
|
26
|
+
name: Name,
|
|
27
|
+
input: Operations[Name]["input"],
|
|
28
|
+
options?: { idempotencyKey?: string },
|
|
29
|
+
): Promise<Operations[Name]["output"]>;
|
|
30
|
+
instruments(): Promise<product_instruments_listOutput>;
|
|
31
|
+
actions(instrument?: string): Promise<product_actions_listOutput>;
|
|
32
|
+
act(
|
|
33
|
+
name: string,
|
|
34
|
+
input: ActionInput,
|
|
35
|
+
options: { idempotencyKey: string },
|
|
36
|
+
): Promise<Record<string, unknown>>;
|
|
37
|
+
}
|
|
38
|
+
export function createClient(options: ClientOptions): Client;
|
package/client.js
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
export function createClient({
|
|
2
|
+
apiKey,
|
|
3
|
+
productId,
|
|
4
|
+
baseUrl = "https://hyperscale0.ai",
|
|
5
|
+
environment = "sandbox",
|
|
6
|
+
}) {
|
|
7
|
+
if (!apiKey || !productId)
|
|
8
|
+
throw new Error("apiKey and productId are required");
|
|
9
|
+
const origin = new URL(baseUrl);
|
|
10
|
+
if (
|
|
11
|
+
origin.origin !== baseUrl ||
|
|
12
|
+
(origin.protocol !== "https:" &&
|
|
13
|
+
!["localhost", "127.0.0.1", "[::1]"].includes(origin.hostname))
|
|
14
|
+
) {
|
|
15
|
+
throw new Error(
|
|
16
|
+
"baseUrl must be an HTTPS origin or a loopback HTTP origin",
|
|
17
|
+
);
|
|
18
|
+
}
|
|
19
|
+
if (!["sandbox", "live"].includes(environment))
|
|
20
|
+
throw new Error("environment must be sandbox or live");
|
|
21
|
+
async function request(path, input, idempotencyKey) {
|
|
22
|
+
const response = await fetch(new URL(path, origin), {
|
|
23
|
+
method: input === undefined ? "GET" : "POST",
|
|
24
|
+
headers: {
|
|
25
|
+
authorization: `Bearer ${apiKey}`,
|
|
26
|
+
"x-hyperscale-environment": environment,
|
|
27
|
+
...(input === undefined ? {} : { "content-type": "application/json" }),
|
|
28
|
+
...(idempotencyKey ? { "idempotency-key": idempotencyKey } : {}),
|
|
29
|
+
},
|
|
30
|
+
...(input === undefined ? {} : { body: JSON.stringify(input) }),
|
|
31
|
+
redirect: "error",
|
|
32
|
+
signal: AbortSignal.timeout(30_000),
|
|
33
|
+
});
|
|
34
|
+
const result = await response.json();
|
|
35
|
+
if (!response.ok) {
|
|
36
|
+
const error = new Error(
|
|
37
|
+
`Hyperscale request failed with HTTP ${response.status}`,
|
|
38
|
+
);
|
|
39
|
+
error.status = response.status;
|
|
40
|
+
error.code = result?.error?.code;
|
|
41
|
+
error.requestId = response.headers.get("x-request-id");
|
|
42
|
+
throw error;
|
|
43
|
+
}
|
|
44
|
+
return result;
|
|
45
|
+
}
|
|
46
|
+
const productPath = `/v1/products/${encodeURIComponent(productId)}`;
|
|
47
|
+
return {
|
|
48
|
+
discover: async () => {
|
|
49
|
+
const [instruments, actions] = await Promise.all([
|
|
50
|
+
request(`${productPath}/instruments`),
|
|
51
|
+
request(`${productPath}/actions`),
|
|
52
|
+
]);
|
|
53
|
+
if (instruments.buildDigest !== actions.buildDigest)
|
|
54
|
+
throw new Error(
|
|
55
|
+
"Product Build changed during discovery; discover again",
|
|
56
|
+
);
|
|
57
|
+
return { instruments, actions };
|
|
58
|
+
},
|
|
59
|
+
call: (name, input, { idempotencyKey } = {}) =>
|
|
60
|
+
request(
|
|
61
|
+
`/v1/operations/${encodeURIComponent(name)}`,
|
|
62
|
+
input,
|
|
63
|
+
idempotencyKey,
|
|
64
|
+
),
|
|
65
|
+
instruments: () => request(`${productPath}/instruments`),
|
|
66
|
+
actions: (instrument) =>
|
|
67
|
+
request(
|
|
68
|
+
`${productPath}/actions${instrument ? `?instrument=${encodeURIComponent(instrument)}` : ""}`,
|
|
69
|
+
),
|
|
70
|
+
act: (name, input, { idempotencyKey } = {}) => {
|
|
71
|
+
if (!idempotencyKey)
|
|
72
|
+
throw new Error("act requires an idempotencyKey for safe retries");
|
|
73
|
+
return request(
|
|
74
|
+
`/v1/operations/${encodeURIComponent(name)}`,
|
|
75
|
+
input,
|
|
76
|
+
idempotencyKey,
|
|
77
|
+
);
|
|
78
|
+
},
|
|
79
|
+
};
|
|
80
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@hyperscale0/sdk",
|
|
3
|
+
"version": "3.0.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"sideEffects": false,
|
|
6
|
+
"license": "LicenseRef-Hyperscale-Proprietary",
|
|
7
|
+
"author": "Hyperscale LLC",
|
|
8
|
+
"engines": {
|
|
9
|
+
"node": ">=20"
|
|
10
|
+
},
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./client.d.ts",
|
|
14
|
+
"import": "./client.js"
|
|
15
|
+
},
|
|
16
|
+
"./types": {
|
|
17
|
+
"types": "./platform.d.ts"
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"types": "./client.d.ts",
|
|
21
|
+
"homepage": "https://hyperscale0.ai",
|
|
22
|
+
"publishConfig": {
|
|
23
|
+
"access": "public"
|
|
24
|
+
},
|
|
25
|
+
"gitHead": "ceeb9999f9724709720171ecbd457ac180941901"
|
|
26
|
+
}
|
package/platform.d.ts
ADDED
|
@@ -0,0 +1,486 @@
|
|
|
1
|
+
// Generated from core/contracts operation descriptors. Do not edit.
|
|
2
|
+
export type account_balance_retrieveInput = { readonly "accountId": string; readonly "productId"?: string; };
|
|
3
|
+
export type account_balance_retrieveOutput = { readonly "accountId": string; readonly "asOf": string; readonly "available": string; readonly "creditsPending": string; readonly "creditsPosted": string; readonly "currency": string; readonly "debitsPending": string; readonly "debitsPosted": string; readonly "environment": "sandbox" | "live"; readonly "normalBalance": "debit" | "credit"; readonly "pending": string; readonly "settled": string; readonly "tenantId": string; readonly "productId"?: string; };
|
|
4
|
+
export type account_bank_linkInput = { readonly "accountId": string; readonly "beneficiaryId": string; };
|
|
5
|
+
export type account_bank_linkOutput = { readonly "tenantId": string; readonly "accountId": string; readonly "beneficiaryId": string; };
|
|
6
|
+
export type account_closeInput = { readonly "accountId": string; readonly "reason": string; };
|
|
7
|
+
export type account_closeOutput = { readonly "tenantId": string; readonly "accountId": string; readonly "productId"?: string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "open" | "frozen"; readonly "status": "closed"; };
|
|
8
|
+
export type account_createInput = { readonly "owner": account_createInput_AccountOwner; readonly "productId"?: string; readonly "role": "tenant_billing" | "tenant_credit" | "tenant_settlement" | "customer_balance" | "customer_investment" | "product_pool" | "product_credit" | "product_revenue"; readonly "currency": string; readonly "balanceCapMinor"?: string; readonly "metadata"?: account_createInput_Metadata; };
|
|
9
|
+
type account_createInput_AccountOwner = (account_createInput_TenantAccountOwner | account_createInput_CustomerAccountOwner | account_createInput_ProductAccountOwner);
|
|
10
|
+
type account_createInput_TenantAccountOwner = { readonly "type": "tenant"; readonly "id": string; };
|
|
11
|
+
type account_createInput_CustomerAccountOwner = { readonly "type": "customer"; readonly "id": string; };
|
|
12
|
+
type account_createInput_ProductAccountOwner = { readonly "type": "product"; readonly "id": string; };
|
|
13
|
+
type account_createInput_Metadata = { readonly [key: string]: account_createInput_MetadataValue };
|
|
14
|
+
type account_createInput_MetadataValue = (account_createInput_MetadataScalar | ReadonlyArray<account_createInput_MetadataScalar> | { readonly [key: string]: account_createInput_MetadataScalar });
|
|
15
|
+
type account_createInput_MetadataScalar = (string | number | boolean | null);
|
|
16
|
+
export type account_createOutput = { readonly "accountId": string; readonly "tenantId": string; readonly "owner": account_createOutput_AccountOwner; readonly "productId"?: string; readonly "role": "tenant_billing" | "tenant_credit" | "tenant_settlement" | "customer_balance" | "customer_investment" | "product_pool" | "product_credit" | "product_revenue"; readonly "currency": string; readonly "normalBalance": "debit" | "credit"; readonly "balanceCapMinor"?: string; readonly "status": "open"; };
|
|
17
|
+
type account_createOutput_AccountOwner = (account_createOutput_TenantAccountOwner | account_createOutput_CustomerAccountOwner | account_createOutput_ProductAccountOwner);
|
|
18
|
+
type account_createOutput_TenantAccountOwner = { readonly "type": "tenant"; readonly "id": string; };
|
|
19
|
+
type account_createOutput_CustomerAccountOwner = { readonly "type": "customer"; readonly "id": string; };
|
|
20
|
+
type account_createOutput_ProductAccountOwner = { readonly "type": "product"; readonly "id": string; };
|
|
21
|
+
export type account_freezeInput = { readonly "accountId": string; readonly "reason": string; readonly "reasonClass": "customer_request"; };
|
|
22
|
+
export type account_freezeOutput = { readonly "tenantId": string; readonly "accountId": string; readonly "productId"?: string; readonly "updatedAt": string; readonly "reason": string; readonly "reasonClass": "customer_request"; readonly "previousStatus": "open"; readonly "status": "frozen"; };
|
|
23
|
+
export type account_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "role"?: "tenant_billing" | "tenant_credit" | "tenant_settlement" | "tenant_master_mirror" | "customer_balance" | "customer_investment" | "instrument_account" | "product_escrow" | "product_pool" | "product_credit" | "product_revenue" | "platform_estate_mirror" | "platform_revenue" | "provider_payable" | "platform_suspense"; readonly "status"?: "pending" | "open" | "frozen" | "closed"; };
|
|
24
|
+
export type account_listOutput = { readonly "items": ReadonlyArray<{ readonly "accountId": string; readonly "tenantId": string; readonly "id": string; readonly "role"?: "tenant_billing" | "tenant_credit" | "tenant_settlement" | "tenant_master_mirror" | "customer_balance" | "customer_investment" | "instrument_account" | "product_escrow" | "product_pool" | "product_credit" | "product_revenue" | "platform_estate_mirror" | "platform_revenue" | "provider_payable" | "platform_suspense"; readonly "currency"?: string; readonly "status"?: "pending" | "open" | "frozen" | "closed"; readonly "ownerParticipantId"?: string; readonly "book"?: string; readonly "external"?: boolean; readonly "beneficiaryId"?: string; readonly "ownerKind"?: "platform" | "tenant" | "customer" | "product" | "external"; readonly "ownerCustomerId"?: string; readonly "updatedAt": string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
25
|
+
export type account_retrieveInput = { readonly "productId"?: string; readonly "accountId": string; };
|
|
26
|
+
export type account_retrieveOutput = { readonly "item": { readonly "accountId": string; readonly "tenantId": string; readonly "id": string; readonly "role"?: "tenant_billing" | "tenant_credit" | "tenant_settlement" | "tenant_master_mirror" | "customer_balance" | "customer_investment" | "instrument_account" | "product_escrow" | "product_pool" | "product_credit" | "product_revenue" | "platform_estate_mirror" | "platform_revenue" | "provider_payable" | "platform_suspense"; readonly "currency"?: string; readonly "status"?: "pending" | "open" | "frozen" | "closed"; readonly "ownerParticipantId"?: string; readonly "book"?: string; readonly "external"?: boolean; readonly "beneficiaryId"?: string; readonly "ownerKind"?: "platform" | "tenant" | "customer" | "product" | "external"; readonly "ownerCustomerId"?: string; readonly "updatedAt": string; readonly "createdAt"?: string; }; };
|
|
27
|
+
export type account_statement_exportInput = { readonly "accountId": string; readonly "productId"?: string; readonly "period": string; };
|
|
28
|
+
export type account_statement_exportOutput = { readonly "accountId": string; readonly "closingBalance": string; readonly "currency": string; readonly "environment": "sandbox" | "live"; readonly "finalized": boolean; readonly "openingBalance": string; readonly "period": string; readonly "periodEndExclusive": string; readonly "periodStart": string; readonly "tenantId": string; readonly "productId"?: string; readonly "contentType": "text/csv"; readonly "csv": string; readonly "filename": string; readonly "sha256": string; readonly "sizeBytes": number; };
|
|
29
|
+
export type account_statement_retrieveInput = { readonly "accountId": string; readonly "productId"?: string; readonly "period": string; };
|
|
30
|
+
export type account_statement_retrieveOutput = { readonly "accountId": string; readonly "closingBalance": string; readonly "currency": string; readonly "environment": "sandbox" | "live"; readonly "finalized": boolean; readonly "openingBalance": string; readonly "period": string; readonly "periodEndExclusive": string; readonly "periodStart": string; readonly "tenantId": string; readonly "productId"?: string; readonly "lines": ReadonlyArray<{ readonly "amount": string; readonly "balanceDelta": string; readonly "counterpartyAccountId": string; readonly "counterpartyDisplayName": string; readonly "currency": string; readonly "direction": "debit" | "credit"; readonly "entryId": string; readonly "memo": string; readonly "occurredAt": string; readonly "operationId": string; readonly "operationName": string; readonly "origin"?: { readonly "instrumentId": string; readonly "instrumentInstanceId": string; readonly "action": string; }; readonly "runningBalance": string; readonly "status": "pending" | "posted" | "voided"; readonly "transferId": string; }>; };
|
|
31
|
+
export type account_unfreezeInput = { readonly "accountId": string; readonly "reason": string; };
|
|
32
|
+
export type account_unfreezeOutput = { readonly "tenantId": string; readonly "accountId": string; readonly "productId"?: string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "frozen"; readonly "status": "open"; };
|
|
33
|
+
export type activity_listInput = { readonly "productId"?: string; readonly "operation"?: string; readonly "status"?: "accepted" | "pending" | "succeeded" | "failed"; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user"; readonly "resourceId"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "limit"?: number; readonly "cursor"?: string; };
|
|
34
|
+
export type activity_listOutput = { readonly "items": ReadonlyArray<({ readonly "activityId": string; readonly "occurredAt": string; readonly "receiptId"?: string; readonly "requestId"?: string; readonly "sourceSurface"?: string; readonly "evidence": ReadonlyArray<{ readonly "kind": "ledger" | "local" | "external"; readonly "reference": string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; }>; readonly "errorEnvelope"?: { readonly "code": string; readonly "message": string; readonly "status": number; readonly "details"?: unknown; }; readonly "timeline": ReadonlyArray<{ readonly "kind": string; readonly "reference"?: string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: ("account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user" | null); readonly "resourceId"?: (string | null); readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; readonly "usageRecordId"?: string; readonly "meter"?: "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity"?: string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "operationName"?: string; readonly "receiptId"?: string; readonly "type"?: string; readonly "finalizedAt"?: (string | null); readonly "auditEventId"?: string; readonly "event"?: string; readonly "level"?: string; readonly "body"?: { readonly [key: string]: unknown }; } & { readonly [key: string]: unknown }>; readonly "usage": ReadonlyArray<{ readonly "usageRecordId": string; readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity": string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "occurredAt": string; }>; readonly "operationId": string; readonly "operation": string; readonly "status": "accepted" | "pending" | "succeeded" | "failed"; readonly "resource"?: { readonly "kind": "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "id"?: string; }; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "receipt"?: { readonly "id": string; readonly "status": string; readonly "type": string; readonly "finalizedAt": (string | null); }; readonly "auditEvent"?: string; } | { readonly "activityId": string; readonly "occurredAt": string; readonly "receiptId"?: string; readonly "requestId"?: string; readonly "sourceSurface"?: string; readonly "evidence": ReadonlyArray<{ readonly "kind": "ledger" | "local" | "external"; readonly "reference": string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; }>; readonly "errorEnvelope"?: { readonly "code": string; readonly "message": string; readonly "status": number; readonly "details"?: unknown; }; readonly "timeline": ReadonlyArray<{ readonly "kind": string; readonly "reference"?: string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: ("account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user" | null); readonly "resourceId"?: (string | null); readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; readonly "usageRecordId"?: string; readonly "meter"?: "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity"?: string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "operationName"?: string; readonly "receiptId"?: string; readonly "type"?: string; readonly "finalizedAt"?: (string | null); readonly "auditEventId"?: string; readonly "event"?: string; readonly "level"?: string; readonly "body"?: { readonly [key: string]: unknown }; } & { readonly [key: string]: unknown }>; readonly "usage": ReadonlyArray<{ readonly "usageRecordId": string; readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity": string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "occurredAt": string; }>; readonly "operationId": null; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user"; readonly "resourceId"?: string; readonly "auditEventId": string; readonly "auditEvent": string; readonly "auditEventBody"?: { readonly [key: string]: unknown }; })>; readonly "nextCursor"?: string; };
|
|
35
|
+
export type audit_event_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
36
|
+
export type audit_event_listOutput = { readonly "items": ReadonlyArray<{ readonly "auditEventId": string; readonly "tenantId": string; readonly "event"?: string; readonly "principalId"?: string; readonly "userId"?: string; readonly "operationId"?: string; readonly "requestId"?: string; readonly "resourceKind"?: string; readonly "resourceId"?: string; readonly "digest"?: string; readonly "prevDigest"?: string; readonly "chainVersion": string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
37
|
+
export type audit_event_retrieveInput = { readonly "productId"?: string; readonly "auditEventId": string; };
|
|
38
|
+
export type audit_event_retrieveOutput = { readonly "item": { readonly "auditEventId": string; readonly "tenantId": string; readonly "event"?: string; readonly "principalId"?: string; readonly "userId"?: string; readonly "operationId"?: string; readonly "requestId"?: string; readonly "resourceKind"?: string; readonly "resourceId"?: string; readonly "digest"?: string; readonly "prevDigest"?: string; readonly "chainVersion": string; readonly "createdAt"?: string; }; };
|
|
39
|
+
export type beneficiary_createInput = { readonly "ownerParticipantId": string; readonly "beneficiaryId"?: string; readonly "name": string; readonly "accountAddress": string; readonly "metadata"?: beneficiary_createInput_Metadata; };
|
|
40
|
+
type beneficiary_createInput_Metadata = { readonly [key: string]: beneficiary_createInput_MetadataValue };
|
|
41
|
+
type beneficiary_createInput_MetadataValue = (beneficiary_createInput_MetadataScalar | ReadonlyArray<beneficiary_createInput_MetadataScalar> | { readonly [key: string]: beneficiary_createInput_MetadataScalar });
|
|
42
|
+
type beneficiary_createInput_MetadataScalar = (string | number | boolean | null);
|
|
43
|
+
export type beneficiary_createOutput = { readonly "beneficiaryId": string; readonly "tenantId": string; readonly "ownerParticipantId": string; readonly "name": string; readonly "accountAddress": string; readonly "status": "pending"; readonly "createdAt": string; readonly "metadata": beneficiary_createOutput_Metadata; };
|
|
44
|
+
type beneficiary_createOutput_Metadata = { readonly [key: string]: beneficiary_createOutput_MetadataValue };
|
|
45
|
+
type beneficiary_createOutput_MetadataValue = (beneficiary_createOutput_MetadataScalar | ReadonlyArray<beneficiary_createOutput_MetadataScalar> | { readonly [key: string]: beneficiary_createOutput_MetadataScalar });
|
|
46
|
+
type beneficiary_createOutput_MetadataScalar = (string | number | boolean | null);
|
|
47
|
+
export type beneficiary_listInput = { readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "pending" | "active" | "disabled"; };
|
|
48
|
+
export type beneficiary_listOutput = { readonly "items": ReadonlyArray<{ readonly "beneficiaryId": string; readonly "tenantId": string; readonly "name"?: string; readonly "ownerParticipantId"?: string; readonly "accountAddress"?: string; readonly "status"?: "pending" | "active" | "disabled"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
49
|
+
export type beneficiary_retrieveInput = { readonly "beneficiaryId": string; };
|
|
50
|
+
export type beneficiary_retrieveOutput = { readonly "item": { readonly "beneficiaryId": string; readonly "tenantId": string; readonly "name"?: string; readonly "ownerParticipantId"?: string; readonly "accountAddress"?: string; readonly "status"?: "pending" | "active" | "disabled"; readonly "createdAt"?: string; }; };
|
|
51
|
+
export type beneficiary_verifyInput = { readonly "iban": string; readonly "beneficiaryName": string; };
|
|
52
|
+
export type beneficiary_verifyOutput = { readonly "beneficiaryVerificationId": string; readonly "tenantId": string; readonly "iban": string; readonly "beneficiaryName": string; readonly "matchGrade": "full_match" | "close_match" | "no_match" | "unavailable"; };
|
|
53
|
+
export type billing_adjustment_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "draft" | "applied" | "voided"; };
|
|
54
|
+
export type billing_adjustment_listOutput = { readonly "items": ReadonlyArray<{ readonly "billingAdjustmentId": string; readonly "tenantId": string; readonly "id": string; readonly "type"?: string; readonly "direction"?: string; readonly "status"?: "draft" | "applied" | "voided"; readonly "amount"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
55
|
+
export type billing_adjustment_retrieveInput = { readonly "productId"?: string; readonly "billingAdjustmentId": string; };
|
|
56
|
+
export type billing_adjustment_retrieveOutput = { readonly "item": { readonly "billingAdjustmentId": string; readonly "tenantId": string; readonly "id": string; readonly "type"?: string; readonly "direction"?: string; readonly "status"?: "draft" | "applied" | "voided"; readonly "amount"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }; };
|
|
57
|
+
export type billing_period_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "open" | "snapshotted" | "finalized" | "voided"; };
|
|
58
|
+
export type billing_period_listOutput = { readonly "items": ReadonlyArray<{ readonly "billingPeriodId": string; readonly "tenantId": string; readonly "id": string; readonly "productId"?: string; readonly "periodStart"?: string; readonly "periodEnd"?: string; readonly "status"?: "open" | "snapshotted" | "finalized" | "voided"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
59
|
+
export type billing_period_retrieveInput = { readonly "productId"?: string; readonly "billingPeriodId": string; };
|
|
60
|
+
export type billing_period_retrieveOutput = { readonly "item": { readonly "billingPeriodId": string; readonly "tenantId": string; readonly "id": string; readonly "productId"?: string; readonly "periodStart"?: string; readonly "periodEnd"?: string; readonly "status"?: "open" | "snapshotted" | "finalized" | "voided"; readonly "createdAt"?: string; }; };
|
|
61
|
+
export type billing_subscription_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "billingPeriodId"?: string; };
|
|
62
|
+
export type billing_subscription_listOutput = { readonly "items": ReadonlyArray<{ readonly "billingSubscriptionId": string; readonly "tenantId": string; readonly "id": string; readonly "billingPeriodId"?: string; readonly "productId"?: string; readonly "status"?: string; readonly "startsAt"?: string; readonly "cancelledAt"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
63
|
+
export type billing_subscription_retrieveInput = { readonly "productId"?: string; readonly "billingSubscriptionId": string; };
|
|
64
|
+
export type billing_subscription_retrieveOutput = { readonly "item": { readonly "billingSubscriptionId": string; readonly "tenantId": string; readonly "id": string; readonly "billingPeriodId"?: string; readonly "productId"?: string; readonly "status"?: string; readonly "startsAt"?: string; readonly "cancelledAt"?: string; readonly "createdAt"?: string; }; };
|
|
65
|
+
export type charge_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "billingPeriodId"?: string; readonly "status"?: "accepted" | "posted" | "voided" | "failed"; };
|
|
66
|
+
export type charge_listOutput = { readonly "items": ReadonlyArray<{ readonly "chargeId": string; readonly "tenantId": string; readonly "description": string; readonly "billingPeriodId"?: string; readonly "transferId"?: string; readonly "debitAccountId": string; readonly "creditAccountId": string; readonly "amount"?: string; readonly "currency"?: string; readonly "status"?: "accepted" | "posted" | "voided" | "failed"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
67
|
+
export type charge_retrieveInput = { readonly "productId"?: string; readonly "chargeId": string; };
|
|
68
|
+
export type charge_retrieveOutput = { readonly "item": { readonly "chargeId": string; readonly "tenantId": string; readonly "description": string; readonly "billingPeriodId"?: string; readonly "transferId"?: string; readonly "debitAccountId": string; readonly "creditAccountId": string; readonly "amount"?: string; readonly "currency"?: string; readonly "status"?: "accepted" | "posted" | "voided" | "failed"; readonly "createdAt"?: string; }; };
|
|
69
|
+
export type collection_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
70
|
+
export type collection_listOutput = { readonly "items": ReadonlyArray<{ readonly "collectionId": string; readonly "tenantId": string; readonly "id": string; readonly "amount"?: string; readonly "currency"?: string; readonly "status"?: "reserved" | "captured" | "cancelled" | "failed"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
71
|
+
export type collection_pay_in_cancelInput = { readonly "collectionId": string; readonly "transferId": string; readonly "reason": string; };
|
|
72
|
+
export type collection_pay_in_cancelOutput = { readonly "collectionId": string; readonly "tenantId": string; readonly "transferId": string; readonly "status": "cancelled"; };
|
|
73
|
+
export type collection_pay_in_captureInput = { readonly "collectionId": string; readonly "transferId": string; readonly "capturedAt": string; };
|
|
74
|
+
export type collection_pay_in_captureOutput = { readonly "collectionId": string; readonly "tenantId": string; readonly "transferId": string; readonly "status": "captured"; };
|
|
75
|
+
export type collection_pay_in_reserveInput = { readonly "collectionId"?: string; readonly "transferId"?: string; readonly "sourceAccountId": string; readonly "destinationAccountId": string; readonly "amount": string; readonly "currency": string; };
|
|
76
|
+
export type collection_pay_in_reserveOutput = { readonly "collectionId": string; readonly "tenantId": string; readonly "transferId": string; readonly "sourceAccountId": string; readonly "destinationAccountId": string; readonly "amount": string; readonly "currency": string; readonly "status": "reserved"; };
|
|
77
|
+
export type collection_retrieveInput = { readonly "productId"?: string; readonly "collectionId": string; };
|
|
78
|
+
export type collection_retrieveOutput = { readonly "item": { readonly "collectionId": string; readonly "tenantId": string; readonly "id": string; readonly "amount"?: string; readonly "currency"?: string; readonly "status"?: "reserved" | "captured" | "cancelled" | "failed"; readonly "createdAt"?: string; }; };
|
|
79
|
+
export type consent_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "active" | "expired" | "revoked"; };
|
|
80
|
+
export type consent_listOutput = { readonly "items": ReadonlyArray<{ readonly "consentId": string; readonly "tenantId": string; readonly "productId"?: string; readonly "subjectId"?: string; readonly "subjectKind"?: string; readonly "status"?: "active" | "expired" | "revoked"; readonly "version"?: string; readonly "expiresAt"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
81
|
+
export type consent_retrieveInput = { readonly "productId"?: string; readonly "consentId": string; };
|
|
82
|
+
export type consent_retrieveOutput = { readonly "item": { readonly "consentId": string; readonly "tenantId": string; readonly "productId"?: string; readonly "subjectId"?: string; readonly "subjectKind"?: string; readonly "status"?: "active" | "expired" | "revoked"; readonly "version"?: string; readonly "expiresAt"?: string; readonly "createdAt"?: string; }; };
|
|
83
|
+
export type consent_revokeInput = { readonly "productId": string; readonly "consentId": string; readonly "reason": string; };
|
|
84
|
+
export type consent_revokeOutput = { readonly "consentId": string; readonly "tenantId": string; readonly "productId": string; readonly "subjectKind": "customer" | "customer_access" | "entity"; readonly "subjectId": string; readonly "status": "revoked"; readonly "revokedAt": string; readonly "reason": string; };
|
|
85
|
+
export type credit_balance_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
86
|
+
export type credit_balance_listOutput = { readonly "items": ReadonlyArray<{ readonly "creditBalanceId": string; readonly "tenantId": string; readonly "id": string; readonly "customerId"?: string; readonly "currency"?: string; readonly "availableAmount"?: string; readonly "updatedAt"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
87
|
+
export type credit_balance_retrieveInput = { readonly "productId"?: string; readonly "creditBalanceId": string; };
|
|
88
|
+
export type credit_balance_retrieveOutput = { readonly "item": { readonly "creditBalanceId": string; readonly "tenantId": string; readonly "id": string; readonly "customerId"?: string; readonly "currency"?: string; readonly "availableAmount"?: string; readonly "updatedAt"?: string; readonly "createdAt"?: string; }; };
|
|
89
|
+
export type credit_grant_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
90
|
+
export type credit_grant_listOutput = { readonly "items": ReadonlyArray<{ readonly "creditGrantId": string; readonly "tenantId": string; readonly "id": string; readonly "creditBalanceId"?: string; readonly "customerId"?: string; readonly "amount"?: string; readonly "remainingAmount"?: string; readonly "currency"?: string; readonly "status"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
91
|
+
export type credit_grant_retrieveInput = { readonly "productId"?: string; readonly "creditGrantId": string; };
|
|
92
|
+
export type credit_grant_retrieveOutput = { readonly "item": { readonly "creditGrantId": string; readonly "tenantId": string; readonly "id": string; readonly "creditBalanceId"?: string; readonly "customerId"?: string; readonly "amount"?: string; readonly "remainingAmount"?: string; readonly "currency"?: string; readonly "status"?: string; readonly "createdAt"?: string; }; };
|
|
93
|
+
export type credit_ledger_entry_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
94
|
+
export type credit_ledger_entry_listOutput = { readonly "items": ReadonlyArray<{ readonly "creditLedgerEntryId": string; readonly "tenantId": string; readonly "id": string; readonly "creditBalanceId"?: string; readonly "creditGrantId"?: string; readonly "invoiceId"?: string; readonly "entryType"?: string; readonly "direction"?: string; readonly "amount"?: string; readonly "balanceAfter"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
95
|
+
export type credit_ledger_entry_retrieveInput = { readonly "productId"?: string; readonly "creditLedgerEntryId": string; };
|
|
96
|
+
export type credit_ledger_entry_retrieveOutput = { readonly "item": { readonly "creditLedgerEntryId": string; readonly "tenantId": string; readonly "id": string; readonly "creditBalanceId"?: string; readonly "creditGrantId"?: string; readonly "invoiceId"?: string; readonly "entryType"?: string; readonly "direction"?: string; readonly "amount"?: string; readonly "balanceAfter"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }; };
|
|
97
|
+
export type credit_note_line_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
98
|
+
export type credit_note_line_listOutput = { readonly "items": ReadonlyArray<{ readonly "creditNoteLineId": string; readonly "tenantId": string; readonly "id": string; readonly "creditNoteId"?: string; readonly "invoiceId"?: string; readonly "invoiceLineId"?: string; readonly "amount"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
99
|
+
export type credit_note_line_retrieveInput = { readonly "productId"?: string; readonly "creditNoteLineId": string; };
|
|
100
|
+
export type credit_note_line_retrieveOutput = { readonly "item": { readonly "creditNoteLineId": string; readonly "tenantId": string; readonly "id": string; readonly "creditNoteId"?: string; readonly "invoiceId"?: string; readonly "invoiceLineId"?: string; readonly "amount"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }; };
|
|
101
|
+
export type credit_note_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "issued"; };
|
|
102
|
+
export type credit_note_listOutput = { readonly "items": ReadonlyArray<{ readonly "creditNoteId": string; readonly "tenantId": string; readonly "id": string; readonly "invoiceId"?: string; readonly "number"?: string; readonly "status"?: "issued"; readonly "amount"?: string; readonly "currency"?: string; readonly "issuedAt"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
103
|
+
export type credit_note_retrieveInput = { readonly "productId"?: string; readonly "creditNoteId": string; };
|
|
104
|
+
export type credit_note_retrieveOutput = { readonly "item": { readonly "creditNoteId": string; readonly "tenantId": string; readonly "id": string; readonly "invoiceId"?: string; readonly "number"?: string; readonly "status"?: "issued"; readonly "amount"?: string; readonly "currency"?: string; readonly "issuedAt"?: string; readonly "createdAt"?: string; }; };
|
|
105
|
+
export type customer_access_closeInput = { readonly "customerAccessId": string; readonly "reason": string; };
|
|
106
|
+
export type customer_access_closeOutput = { readonly "tenantId": string; readonly "productId": string; readonly "customerId": string; readonly "customerAccessId": string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "pending" | "active" | "suspended"; readonly "status": "closed"; };
|
|
107
|
+
export type customer_access_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "pending" | "active" | "suspended" | "closed"; };
|
|
108
|
+
export type customer_access_listOutput = { readonly "items": ReadonlyArray<{ readonly "customerAccessId": string; readonly "tenantId": string; readonly "id": string; readonly "customerId"?: string; readonly "productId"?: string; readonly "status"?: "pending" | "active" | "suspended" | "closed"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
109
|
+
export type customer_access_reactivateInput = { readonly "customerAccessId": string; readonly "reason": string; };
|
|
110
|
+
export type customer_access_reactivateOutput = { readonly "tenantId": string; readonly "productId": string; readonly "customerId": string; readonly "customerAccessId": string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "suspended"; readonly "status": "active"; };
|
|
111
|
+
export type customer_access_retrieveInput = { readonly "productId"?: string; readonly "customerAccessId": string; };
|
|
112
|
+
export type customer_access_retrieveOutput = { readonly "item": { readonly "customerAccessId": string; readonly "tenantId": string; readonly "id": string; readonly "customerId"?: string; readonly "productId"?: string; readonly "status"?: "pending" | "active" | "suspended" | "closed"; readonly "createdAt"?: string; }; };
|
|
113
|
+
export type customer_access_suspendInput = { readonly "customerAccessId": string; readonly "reason": string; };
|
|
114
|
+
export type customer_access_suspendOutput = { readonly "tenantId": string; readonly "productId": string; readonly "customerId": string; readonly "customerAccessId": string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "active"; readonly "status": "suspended"; };
|
|
115
|
+
export type customer_createInput = { readonly "productId": string; readonly "entity": { readonly "kind": "person" | "organization"; readonly "displayName": string; readonly "country": string; }; };
|
|
116
|
+
export type customer_createOutput = { readonly "tenantId": string; readonly "productId": string; readonly "customerId": string; readonly "customerStatus": "active"; readonly "entityId": string; readonly "entityStatus": "pending" | "verified" | "rejected" | "disabled"; readonly "customerAccessId": string; };
|
|
117
|
+
export type customer_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "pending" | "active" | "disabled" | "erased"; };
|
|
118
|
+
export type customer_listOutput = { readonly "items": ReadonlyArray<{ readonly "customerId": string; readonly "tenantId": string; readonly "displayName": string; readonly "entityId"?: string; readonly "externalReference"?: string; readonly "status"?: "pending" | "active" | "disabled" | "erased"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
119
|
+
export type customer_loginInput = { readonly "productId": string; readonly "email": string; readonly "password": string; };
|
|
120
|
+
export type customer_loginOutput = { readonly "tenantId": string; readonly "productId": string; readonly "environment": "sandbox" | "live"; readonly "customerId": string; readonly "entityId": string; readonly "email": string; readonly "customerAccessId": string; readonly "customerAccessStatus": "pending" | "active" | "suspended" | "closed"; readonly "customerSessionId": string; readonly "sessionToken"?: string; readonly "sessionExpiresAt": string; };
|
|
121
|
+
export type customer_logoutInput = Record<string, never>;
|
|
122
|
+
export type customer_logoutOutput = { readonly "customerSessionId": string; readonly "status": "revoked"; readonly "revokedAt": string; };
|
|
123
|
+
export type customer_retrieveInput = { readonly "productId"?: string; readonly "customerId": string; };
|
|
124
|
+
export type customer_retrieveOutput = { readonly "item": { readonly "customerId": string; readonly "tenantId": string; readonly "displayName": string; readonly "entityId"?: string; readonly "externalReference"?: string; readonly "status"?: "pending" | "active" | "disabled" | "erased"; readonly "createdAt"?: string; }; };
|
|
125
|
+
export type customer_session_revokeInput = { readonly "customerSessionId": string; };
|
|
126
|
+
export type customer_session_revokeOutput = { readonly "customerSessionId": string; readonly "status": "revoked" | "already_revoked"; readonly "revokedAt": string; };
|
|
127
|
+
export type customer_signupInput = { readonly "productId": string; readonly "email": string; readonly "password": string; readonly "displayName": string; readonly "country"?: string; readonly "termsAccepted": true; };
|
|
128
|
+
export type customer_signupOutput = { readonly "tenantId": string; readonly "productId": string; readonly "environment": "sandbox" | "live"; readonly "customerId": string; readonly "entityId": string; readonly "email": string; readonly "customerAccessId": string; readonly "customerAccessStatus": "pending" | "active" | "suspended" | "closed"; readonly "customerSessionId": string; readonly "sessionToken"?: string; readonly "sessionExpiresAt": string; readonly "displayName": string; readonly "customerStatus": "pending" | "active" | "disabled" | "erased"; readonly "entityStatus": "pending" | "verified" | "rejected" | "disabled"; };
|
|
129
|
+
export type deposit_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "received" | "returned"; };
|
|
130
|
+
export type deposit_listOutput = { readonly "items": ReadonlyArray<{ readonly "depositId": string; readonly "tenantId": string; readonly "accountId"?: string; readonly "financialAddressId"?: string; readonly "expectedPaymentId"?: string; readonly "amount"?: string; readonly "currency"?: string; readonly "transferId"?: string; readonly "status"?: "received" | "returned"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
131
|
+
export type deposit_retrieveInput = { readonly "productId"?: string; readonly "depositId": string; };
|
|
132
|
+
export type deposit_retrieveOutput = { readonly "item": { readonly "depositId": string; readonly "tenantId": string; readonly "accountId"?: string; readonly "financialAddressId"?: string; readonly "expectedPaymentId"?: string; readonly "amount"?: string; readonly "currency"?: string; readonly "transferId"?: string; readonly "status"?: "received" | "returned"; readonly "createdAt"?: string; }; };
|
|
133
|
+
export type developer_log_listInput = { readonly "productId"?: string; readonly "operation"?: string; readonly "status"?: "accepted" | "pending" | "succeeded" | "failed"; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "principalId"?: string; };
|
|
134
|
+
export type developer_log_listOutput = { readonly "items": ReadonlyArray<{ readonly "activityId": string; readonly "occurredAt": string; readonly "receiptId"?: string; readonly "requestId"?: string; readonly "sourceSurface"?: string; readonly "evidence": ReadonlyArray<{ readonly "kind": "ledger" | "local" | "external"; readonly "reference": string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; }>; readonly "errorEnvelope"?: { readonly "code": string; readonly "message": string; readonly "status": number; readonly "details"?: unknown; }; readonly "timeline": ReadonlyArray<{ readonly "kind": string; readonly "reference"?: string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: ("account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user" | null); readonly "resourceId"?: (string | null); readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; readonly "usageRecordId"?: string; readonly "meter"?: "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity"?: string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "operationName"?: string; readonly "receiptId"?: string; readonly "type"?: string; readonly "finalizedAt"?: (string | null); readonly "auditEventId"?: string; readonly "event"?: string; readonly "level"?: string; readonly "body"?: { readonly [key: string]: unknown }; } & { readonly [key: string]: unknown }>; readonly "usage": ReadonlyArray<{ readonly "usageRecordId": string; readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity": string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "occurredAt": string; }>; readonly "operationId": string; readonly "operation": string; readonly "status": "accepted" | "pending" | "succeeded" | "failed"; readonly "resource"?: { readonly "kind": "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "id"?: string; }; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "receipt"?: { readonly "id": string; readonly "status": string; readonly "type": string; readonly "finalizedAt": (string | null); }; readonly "auditEvent"?: string; readonly "audit": ReadonlyArray<{ readonly "auditEventId": string; readonly "event": string; readonly "level"?: string; readonly "resourceKind"?: ("account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user" | null); readonly "resourceId"?: (string | null); readonly "body"?: { readonly [key: string]: unknown }; readonly "occurredAt": string; }>; readonly "principalId"?: string; readonly "finalizedAt"?: string; readonly "latencyMs"?: number; }>; readonly "nextCursor"?: string; };
|
|
135
|
+
export type developer_log_retrieveInput = { readonly "operationId": string; };
|
|
136
|
+
export type developer_log_retrieveOutput = { readonly "tenantId": string; readonly "log": { readonly "activityId": string; readonly "occurredAt": string; readonly "receiptId"?: string; readonly "requestId"?: string; readonly "sourceSurface"?: string; readonly "evidence": ReadonlyArray<{ readonly "kind": "ledger" | "local" | "external"; readonly "reference": string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; }>; readonly "errorEnvelope"?: { readonly "code": string; readonly "message": string; readonly "status": number; readonly "details"?: unknown; }; readonly "timeline": ReadonlyArray<{ readonly "kind": string; readonly "reference"?: string; readonly "externalConfirmationId"?: string; readonly "provider"?: string; readonly "providerReference"?: string; readonly "resourceKind"?: ("account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user" | null); readonly "resourceId"?: (string | null); readonly "operationId"?: string; readonly "operation"?: { readonly "id": string; readonly "name"?: string; readonly "status"?: string; }; readonly "status"?: string; readonly "occurredAt"?: string; readonly "proof"?: { readonly [key: string]: unknown }; readonly "usageRecordId"?: string; readonly "meter"?: "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity"?: string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "operationName"?: string; readonly "receiptId"?: string; readonly "type"?: string; readonly "finalizedAt"?: (string | null); readonly "auditEventId"?: string; readonly "event"?: string; readonly "level"?: string; readonly "body"?: { readonly [key: string]: unknown }; } & { readonly [key: string]: unknown }>; readonly "usage": ReadonlyArray<{ readonly "usageRecordId": string; readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "quantity": string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "occurredAt": string; }>; readonly "operationId": string; readonly "operation": string; readonly "status": "accepted" | "pending" | "succeeded" | "failed"; readonly "resource"?: { readonly "kind": "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "id"?: string; }; readonly "resourceKind"?: "account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection"; readonly "resourceId"?: string; readonly "receipt"?: { readonly "id": string; readonly "status": string; readonly "type": string; readonly "finalizedAt": (string | null); }; readonly "auditEvent"?: string; readonly "audit": ReadonlyArray<{ readonly "auditEventId": string; readonly "event": string; readonly "level"?: string; readonly "resourceKind"?: ("account" | "activity" | "financial_address" | "api_key" | "audit" | "product_capability" | "charge" | "collection" | "consent" | "credit_balance" | "credit_grant" | "credit_ledger_entry" | "credit_note" | "credit_note_line" | "customer" | "beneficiary" | "deposit" | "entity" | "entity_kyc_profile" | "expected_payment" | "instrument_instance" | "operation" | "payout" | "beneficiary_verification" | "product" | "customer_access" | "customer_session" | "external_confirmation" | "provider_cost_event" | "provider_webhook_event" | "webhook_endpoint" | "webhook_delivery" | "receipt" | "tenant" | "tenant_catalog_revision" | "subject" | "subject_kind" | "statement_line" | "reconciliation_run" | "reconciliation_break" | "reporting_artifact" | "str_case" | "wedged_money_repair" | "reconciliation_break_repair" | "attribution_queue" | "user_session" | "internal_transfer" | "usage" | "billing_adjustment" | "meter_rate_discount" | "platform_alert" | "platform_rate_override" | "billing_period" | "billing_subscription" | "invoice" | "invoice_line" | "meter_period_snapshot" | "trust_review" | "trust_evidence" | "trust_requirement" | "trust_review_subject" | "support_ticket" | "support_ticket_message" | "support_booking" | "support_plan_selection" | "tenant_bank_connection" | "team" | "team_membership" | "user" | null); readonly "resourceId"?: (string | null); readonly "body"?: { readonly [key: string]: unknown }; readonly "occurredAt": string; }>; readonly "principalId"?: string; readonly "finalizedAt"?: string; readonly "latencyMs"?: number; }; };
|
|
137
|
+
export type event_listInput = { readonly "limit"?: number; readonly "cursor"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "resourceId"?: string; readonly "event"?: string; };
|
|
138
|
+
export type event_listOutput = { readonly "items": ReadonlyArray<{ readonly "id": string; readonly "object": "event"; readonly "apiVersion": "2026-06-04"; readonly "environment": "sandbox" | "live"; readonly "tenantId": string; readonly "event": string; readonly "createdAt": string; readonly "operationId": (string | null); readonly "relatedObject": ({ readonly "id": string; readonly "type": string; } | null); readonly "data": { readonly "object": { readonly [key: string]: unknown }; }; readonly "outbox"?: { readonly "payloadDigest": string; }; }>; readonly "nextCursor"?: string; };
|
|
139
|
+
export type event_retrieveInput = { readonly "eventId": string; };
|
|
140
|
+
export type event_retrieveOutput = { readonly "id": string; readonly "object": "event"; readonly "apiVersion": "2026-06-04"; readonly "environment": "sandbox" | "live"; readonly "tenantId": string; readonly "event": string; readonly "createdAt": string; readonly "operationId": (string | null); readonly "relatedObject": ({ readonly "id": string; readonly "type": string; } | null); readonly "data": { readonly "object": { readonly [key: string]: unknown }; }; readonly "outbox"?: { readonly "payloadDigest": string; }; };
|
|
141
|
+
export type expected_payment_cancelInput = { readonly "expectedPaymentId": string; readonly "reason": string; };
|
|
142
|
+
export type expected_payment_cancelOutput = { readonly "expectedPaymentId": string; readonly "tenantId": string; readonly "status": "canceled"; readonly "updatedAt": string; };
|
|
143
|
+
export type expected_payment_createInput = { readonly "expectedPaymentId"?: string; readonly "productId": string; readonly "accountId": string; readonly "financialAddressId": string; readonly "amountMin": string; readonly "amountMax": string; readonly "currency": string; readonly "windowStart": string; readonly "windowEnd": string; readonly "reference"?: string; readonly "metadata"?: expected_payment_createInput_Metadata; };
|
|
144
|
+
type expected_payment_createInput_Metadata = { readonly [key: string]: expected_payment_createInput_MetadataValue };
|
|
145
|
+
type expected_payment_createInput_MetadataValue = (expected_payment_createInput_MetadataScalar | ReadonlyArray<expected_payment_createInput_MetadataScalar> | { readonly [key: string]: expected_payment_createInput_MetadataScalar });
|
|
146
|
+
type expected_payment_createInput_MetadataScalar = (string | number | boolean | null);
|
|
147
|
+
export type expected_payment_createOutput = { readonly "expectedPaymentId": string; readonly "tenantId": string; readonly "productId": string; readonly "accountId": string; readonly "financialAddressId": string; readonly "amountMin": string; readonly "amountMax": string; readonly "amountReceived": "0"; readonly "currency": string; readonly "windowStart": string; readonly "windowEnd": string; readonly "reference"?: string; readonly "status": "expected"; readonly "createdAt": string; readonly "metadata": expected_payment_createOutput_Metadata; };
|
|
148
|
+
type expected_payment_createOutput_Metadata = { readonly [key: string]: expected_payment_createOutput_MetadataValue };
|
|
149
|
+
type expected_payment_createOutput_MetadataValue = (expected_payment_createOutput_MetadataScalar | ReadonlyArray<expected_payment_createOutput_MetadataScalar> | { readonly [key: string]: expected_payment_createOutput_MetadataScalar });
|
|
150
|
+
type expected_payment_createOutput_MetadataScalar = (string | number | boolean | null);
|
|
151
|
+
export type expected_payment_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "expected" | "partially_received" | "received" | "overdue" | "canceled"; };
|
|
152
|
+
export type expected_payment_listOutput = { readonly "items": ReadonlyArray<{ readonly "expectedPaymentId": string; readonly "tenantId": string; readonly "productId"?: string; readonly "accountId"?: string; readonly "financialAddressId"?: string; readonly "amountMin"?: string; readonly "amountMax"?: string; readonly "amountReceived"?: string; readonly "currency"?: string; readonly "windowStart"?: string; readonly "windowEnd"?: string; readonly "reference"?: string; readonly "status"?: "expected" | "partially_received" | "received" | "overdue" | "canceled"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
153
|
+
export type expected_payment_retrieveInput = { readonly "productId"?: string; readonly "expectedPaymentId": string; };
|
|
154
|
+
export type expected_payment_retrieveOutput = { readonly "item": { readonly "expectedPaymentId": string; readonly "tenantId": string; readonly "productId"?: string; readonly "accountId"?: string; readonly "financialAddressId"?: string; readonly "amountMin"?: string; readonly "amountMax"?: string; readonly "amountReceived"?: string; readonly "currency"?: string; readonly "windowStart"?: string; readonly "windowEnd"?: string; readonly "reference"?: string; readonly "status"?: "expected" | "partially_received" | "received" | "overdue" | "canceled"; readonly "createdAt"?: string; }; };
|
|
155
|
+
export type extension_listInput = { readonly "limit"?: number; readonly "cursor"?: string; };
|
|
156
|
+
export type extension_listOutput = { readonly "items": ReadonlyArray<{ readonly "id": "money" | "marketplace" | "escrow" | "wallet" | "financing" | "lending" | "insurance" | "approvals" | "collections" | "travel" | "cards" | "savings"; readonly "title": string; readonly "objects": ReadonlyArray<{ readonly "name": string; readonly "qualifiedName": string; readonly "summary": string; readonly "tunables": ReadonlyArray<{ readonly "name": string; readonly "type": string; readonly "required": boolean; readonly "default"?: string; readonly "values"?: ReadonlyArray<string>; readonly "minimum"?: (number | string); readonly "maximum"?: (number | string); }>; readonly "constraints": ReadonlyArray<{ readonly "tunable": string; readonly "relation": "less_than" | "at_most" | "greater_than"; readonly "other": string; }>; readonly "parties": ReadonlyArray<string>; readonly "actions": ReadonlyArray<{ readonly "name": string; readonly "summary": string; readonly "actor": string; }>; }>; }>; readonly "nextCursor"?: string; };
|
|
157
|
+
export type financial_address_createInput = { readonly "financialAddressId"?: string; readonly "accountId": string; readonly "productId"?: string; readonly "purpose"?: string; readonly "metadata"?: financial_address_createInput_Metadata; };
|
|
158
|
+
type financial_address_createInput_Metadata = { readonly [key: string]: financial_address_createInput_MetadataValue };
|
|
159
|
+
type financial_address_createInput_MetadataValue = (financial_address_createInput_MetadataScalar | ReadonlyArray<financial_address_createInput_MetadataScalar> | { readonly [key: string]: financial_address_createInput_MetadataScalar });
|
|
160
|
+
type financial_address_createInput_MetadataScalar = (string | number | boolean | null);
|
|
161
|
+
export type financial_address_createOutput = { readonly "financialAddressId": string; readonly "tenantId": string; readonly "accountId": string; readonly "productId"?: string; readonly "status": "requested"; readonly "createdAt": string; readonly "metadata": financial_address_createOutput_Metadata; };
|
|
162
|
+
type financial_address_createOutput_Metadata = { readonly [key: string]: financial_address_createOutput_MetadataValue };
|
|
163
|
+
type financial_address_createOutput_MetadataValue = (financial_address_createOutput_MetadataScalar | ReadonlyArray<financial_address_createOutput_MetadataScalar> | { readonly [key: string]: financial_address_createOutput_MetadataScalar });
|
|
164
|
+
type financial_address_createOutput_MetadataScalar = (string | number | boolean | null);
|
|
165
|
+
export type financial_address_disableInput = { readonly "financialAddressId": string; readonly "reason": string; };
|
|
166
|
+
export type financial_address_disableOutput = { readonly "financialAddressId": string; readonly "tenantId": string; readonly "accountId": string; readonly "status": "disabled"; readonly "updatedAt": string; };
|
|
167
|
+
export type financial_address_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "requested" | "active" | "disabled"; };
|
|
168
|
+
export type financial_address_listOutput = { readonly "items": ReadonlyArray<{ readonly "financialAddressId": string; readonly "tenantId": string; readonly "address"?: string; readonly "accountId"?: string; readonly "purpose"?: string; readonly "status"?: "requested" | "active" | "disabled"; readonly "activeAt"?: string; readonly "addressClass"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
169
|
+
export type financial_address_retrieveInput = { readonly "productId"?: string; readonly "financialAddressId": string; };
|
|
170
|
+
export type financial_address_retrieveOutput = { readonly "item": { readonly "financialAddressId": string; readonly "tenantId": string; readonly "address"?: string; readonly "accountId"?: string; readonly "purpose"?: string; readonly "status"?: "requested" | "active" | "disabled"; readonly "activeAt"?: string; readonly "addressClass"?: string; readonly "createdAt"?: string; }; };
|
|
171
|
+
export type human_approval_approver_listInput = { readonly "approvalRequestId": string; };
|
|
172
|
+
export type human_approval_approver_listOutput = { readonly "approvalRequestId": string; readonly "approvers": ReadonlyArray<{ readonly "memberId": string; readonly "displayName": string; readonly "role": string; readonly "eligible": boolean; readonly "ineligibilityReason"?: string; }>; };
|
|
173
|
+
export type human_approval_cancelInput = { readonly "approvalRequestId": string; readonly "reason": string; };
|
|
174
|
+
export type human_approval_cancelOutput = { readonly "tenantId": string; readonly "approvalRequestId": string; readonly "state": "pending" | "approved" | "consumed" | "cancelled" | "expired" | "invalidated"; readonly "reviewUrl": string; readonly "expiresAt": string; readonly "createdAt": string; readonly "approvedAt": (string | null); readonly "approverMemberId": string | null; readonly "operationName": string; readonly "scope": ({ readonly "kind": "org"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; } | { readonly "kind": "product"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; readonly "productId": string; readonly "productBuildId": string; readonly "buildDigest": string; }); readonly "requestHash": string; readonly "reviewDigest": string; readonly "policyRevision": string; readonly "separation": "distinct_member" | "self_permitted"; readonly "eligibleApproverCount": number; readonly "resume": "same_request_same_key"; readonly "reviewEnvelope": { readonly "amounts": ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "sourceAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "destinationAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "fees"?: ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "tax"?: ({ readonly "amount": string | number; readonly "currency": string; } | null); readonly "holdEffects"?: ReadonlyArray<{ readonly "holdId"?: string; readonly "amount"?: string | number; readonly "currency"?: string; readonly "status"?: string; }>; readonly "debtEffects"?: ReadonlyArray<{ readonly "debtId"?: string; readonly "amount"?: string | number; readonly "kind"?: string; }>; readonly "targetRecords": ReadonlyArray<{ readonly "recordType": string; readonly "recordId": string; }>; readonly "prerequisiteEvidence"?: ReadonlyArray<{ readonly "evidenceId"?: string; readonly "kind"?: string; readonly "description"?: string; }>; readonly "consequences": ReadonlyArray<string>; readonly "requestingCredential": { readonly "credentialKind": string; readonly "credentialRecordId": string; readonly "displayName"?: string; }; readonly "requestingMember"?: ({ readonly "memberId"?: string; readonly "displayName"?: string; } | null); readonly "checkpointReason"?: string | null; }; readonly "input"?: { readonly [key: string]: unknown }; readonly "reasonCode": string | null; readonly "operationId": (string | null); readonly "receiptId": (string | null); };
|
|
175
|
+
export type human_approval_expireInput = Record<string, never>;
|
|
176
|
+
export type human_approval_expireOutput = { readonly "tenantId": string; readonly "expiredCount": number; };
|
|
177
|
+
export type human_approval_request_createInput = { readonly "operationName": string; readonly "scope": ({ readonly "kind": "org"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; } | { readonly "kind": "product"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; readonly "productId": string; readonly "productBuildId": string; readonly "buildDigest": string; }); readonly "input": { readonly [key: string]: unknown }; readonly "executionIdempotencyKey": string; };
|
|
178
|
+
export type human_approval_request_createOutput = { readonly "tenantId": string; readonly "approvalRequestId": string; readonly "state": "pending" | "approved" | "consumed" | "cancelled" | "expired" | "invalidated"; readonly "reviewUrl": string; readonly "expiresAt": string; readonly "createdAt": string; readonly "approvedAt": (string | null); readonly "approverMemberId": string | null; readonly "operationName": string; readonly "scope": ({ readonly "kind": "org"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; } | { readonly "kind": "product"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; readonly "productId": string; readonly "productBuildId": string; readonly "buildDigest": string; }); readonly "requestHash": string; readonly "reviewDigest": string; readonly "policyRevision": string; readonly "separation": "distinct_member" | "self_permitted"; readonly "eligibleApproverCount": number; readonly "resume": "same_request_same_key"; readonly "reviewEnvelope": { readonly "amounts": ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "sourceAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "destinationAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "fees"?: ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "tax"?: ({ readonly "amount": string | number; readonly "currency": string; } | null); readonly "holdEffects"?: ReadonlyArray<{ readonly "holdId"?: string; readonly "amount"?: string | number; readonly "currency"?: string; readonly "status"?: string; }>; readonly "debtEffects"?: ReadonlyArray<{ readonly "debtId"?: string; readonly "amount"?: string | number; readonly "kind"?: string; }>; readonly "targetRecords": ReadonlyArray<{ readonly "recordType": string; readonly "recordId": string; }>; readonly "prerequisiteEvidence"?: ReadonlyArray<{ readonly "evidenceId"?: string; readonly "kind"?: string; readonly "description"?: string; }>; readonly "consequences": ReadonlyArray<string>; readonly "requestingCredential": { readonly "credentialKind": string; readonly "credentialRecordId": string; readonly "displayName"?: string; }; readonly "requestingMember"?: ({ readonly "memberId"?: string; readonly "displayName"?: string; } | null); readonly "checkpointReason"?: string | null; }; readonly "input"?: { readonly [key: string]: unknown }; readonly "reasonCode": string | null; readonly "operationId": (string | null); readonly "receiptId": (string | null); };
|
|
179
|
+
export type human_approval_request_listInput = { readonly "state"?: "pending" | "approved" | "consumed" | "cancelled" | "expired" | "invalidated"; readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; };
|
|
180
|
+
export type human_approval_request_listOutput = { readonly "items": ReadonlyArray<{ readonly "tenantId": string; readonly "approvalRequestId": string; readonly "state": "pending" | "approved" | "consumed" | "cancelled" | "expired" | "invalidated"; readonly "reviewUrl": string; readonly "expiresAt": string; readonly "createdAt": string; readonly "approvedAt": (string | null); readonly "approverMemberId": string | null; readonly "operationName": string; readonly "scope": ({ readonly "kind": "org"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; } | { readonly "kind": "product"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; readonly "productId": string; readonly "productBuildId": string; readonly "buildDigest": string; }); readonly "requestHash": string; readonly "reviewDigest": string; readonly "policyRevision": string; readonly "separation": "distinct_member" | "self_permitted"; readonly "eligibleApproverCount": number; readonly "resume": "same_request_same_key"; readonly "reviewEnvelope": { readonly "amounts": ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "sourceAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "destinationAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "fees"?: ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "tax"?: ({ readonly "amount": string | number; readonly "currency": string; } | null); readonly "holdEffects"?: ReadonlyArray<{ readonly "holdId"?: string; readonly "amount"?: string | number; readonly "currency"?: string; readonly "status"?: string; }>; readonly "debtEffects"?: ReadonlyArray<{ readonly "debtId"?: string; readonly "amount"?: string | number; readonly "kind"?: string; }>; readonly "targetRecords": ReadonlyArray<{ readonly "recordType": string; readonly "recordId": string; }>; readonly "prerequisiteEvidence"?: ReadonlyArray<{ readonly "evidenceId"?: string; readonly "kind"?: string; readonly "description"?: string; }>; readonly "consequences": ReadonlyArray<string>; readonly "requestingCredential": { readonly "credentialKind": string; readonly "credentialRecordId": string; readonly "displayName"?: string; }; readonly "requestingMember"?: ({ readonly "memberId"?: string; readonly "displayName"?: string; } | null); readonly "checkpointReason"?: string | null; }; readonly "input"?: { readonly [key: string]: unknown }; readonly "reasonCode": string | null; readonly "operationId": (string | null); readonly "receiptId": (string | null); }>; readonly "nextCursor"?: string; };
|
|
181
|
+
export type human_approval_request_retrieveInput = { readonly "approvalRequestId": string; };
|
|
182
|
+
export type human_approval_request_retrieveOutput = { readonly "tenantId": string; readonly "approvalRequestId": string; readonly "state": "pending" | "approved" | "consumed" | "cancelled" | "expired" | "invalidated"; readonly "reviewUrl": string; readonly "expiresAt": string; readonly "createdAt": string; readonly "approvedAt": (string | null); readonly "approverMemberId": string | null; readonly "operationName": string; readonly "scope": ({ readonly "kind": "org"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; } | { readonly "kind": "product"; readonly "tenantId": string; readonly "environment": "sandbox" | "live" | "either"; readonly "productId": string; readonly "productBuildId": string; readonly "buildDigest": string; }); readonly "requestHash": string; readonly "reviewDigest": string; readonly "policyRevision": string; readonly "separation": "distinct_member" | "self_permitted"; readonly "eligibleApproverCount": number; readonly "resume": "same_request_same_key"; readonly "reviewEnvelope": { readonly "amounts": ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "sourceAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "destinationAccount"?: { readonly "accountId"?: string; readonly "ownerName"?: string; readonly "role"?: string; }; readonly "fees"?: ReadonlyArray<{ readonly "amount": string | number; readonly "currency": string; readonly "description"?: string; }>; readonly "tax"?: ({ readonly "amount": string | number; readonly "currency": string; } | null); readonly "holdEffects"?: ReadonlyArray<{ readonly "holdId"?: string; readonly "amount"?: string | number; readonly "currency"?: string; readonly "status"?: string; }>; readonly "debtEffects"?: ReadonlyArray<{ readonly "debtId"?: string; readonly "amount"?: string | number; readonly "kind"?: string; }>; readonly "targetRecords": ReadonlyArray<{ readonly "recordType": string; readonly "recordId": string; }>; readonly "prerequisiteEvidence"?: ReadonlyArray<{ readonly "evidenceId"?: string; readonly "kind"?: string; readonly "description"?: string; }>; readonly "consequences": ReadonlyArray<string>; readonly "requestingCredential": { readonly "credentialKind": string; readonly "credentialRecordId": string; readonly "displayName"?: string; }; readonly "requestingMember"?: ({ readonly "memberId"?: string; readonly "displayName"?: string; } | null); readonly "checkpointReason"?: string | null; }; readonly "input"?: { readonly [key: string]: unknown }; readonly "reasonCode": string | null; readonly "operationId": (string | null); readonly "receiptId": (string | null); };
|
|
183
|
+
export type internal_transfer_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "settled" | "reversed" | "accepted" | "reserved" | "posted" | "voided" | "failed"; };
|
|
184
|
+
export type internal_transfer_listOutput = { readonly "items": ReadonlyArray<{ readonly "transferId": string; readonly "tenantId": string; readonly "amount"?: string; readonly "postedAmount"?: string; readonly "currency"?: string; readonly "sourceAccountId"?: string; readonly "destinationAccountId"?: string; readonly "status"?: "settled" | "reversed" | "accepted" | "reserved" | "posted" | "voided" | "failed"; readonly "expiresAt"?: string; readonly "expiredAt"?: string; readonly "metadata"?: internal_transfer_listOutput_Metadata; readonly "correctsTransferId"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
185
|
+
type internal_transfer_listOutput_Metadata = { readonly [key: string]: internal_transfer_listOutput_MetadataValue };
|
|
186
|
+
type internal_transfer_listOutput_MetadataValue = (internal_transfer_listOutput_MetadataScalar | ReadonlyArray<internal_transfer_listOutput_MetadataScalar> | { readonly [key: string]: internal_transfer_listOutput_MetadataScalar });
|
|
187
|
+
type internal_transfer_listOutput_MetadataScalar = (string | number | boolean | null);
|
|
188
|
+
export type internal_transfer_retrieveInput = { readonly "productId"?: string; readonly "transferId": string; };
|
|
189
|
+
export type internal_transfer_retrieveOutput = { readonly "item": { readonly "transferId": string; readonly "tenantId": string; readonly "amount"?: string; readonly "postedAmount"?: string; readonly "currency"?: string; readonly "sourceAccountId"?: string; readonly "destinationAccountId"?: string; readonly "status"?: "settled" | "reversed" | "accepted" | "reserved" | "posted" | "voided" | "failed"; readonly "expiresAt"?: string; readonly "expiredAt"?: string; readonly "metadata"?: internal_transfer_retrieveOutput_Metadata; readonly "correctsTransferId"?: string; readonly "createdAt"?: string; }; };
|
|
190
|
+
type internal_transfer_retrieveOutput_Metadata = { readonly [key: string]: internal_transfer_retrieveOutput_MetadataValue };
|
|
191
|
+
type internal_transfer_retrieveOutput_MetadataValue = (internal_transfer_retrieveOutput_MetadataScalar | ReadonlyArray<internal_transfer_retrieveOutput_MetadataScalar> | { readonly [key: string]: internal_transfer_retrieveOutput_MetadataScalar });
|
|
192
|
+
type internal_transfer_retrieveOutput_MetadataScalar = (string | number | boolean | null);
|
|
193
|
+
export type invoice_line_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "invoiceId"?: string; };
|
|
194
|
+
export type invoice_line_listOutput = { readonly "items": ReadonlyArray<{ readonly "invoiceLineId": string; readonly "tenantId": string; readonly "id": string; readonly "invoiceId"?: string; readonly "description"?: string; readonly "meter"?: string; readonly "quantity"?: string; readonly "unitAmount"?: string; readonly "subtotalAmount"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
195
|
+
export type invoice_line_retrieveInput = { readonly "productId"?: string; readonly "invoiceLineId": string; };
|
|
196
|
+
export type invoice_line_retrieveOutput = { readonly "item": { readonly "invoiceLineId": string; readonly "tenantId": string; readonly "id": string; readonly "invoiceId"?: string; readonly "description"?: string; readonly "meter"?: string; readonly "quantity"?: string; readonly "unitAmount"?: string; readonly "subtotalAmount"?: string; readonly "currency"?: string; readonly "createdAt"?: string; }; };
|
|
197
|
+
export type invoice_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "billingPeriodId"?: string; readonly "status"?: "draft" | "finalized" | "charged" | "paid" | "voided" | "credited"; };
|
|
198
|
+
export type invoice_listOutput = { readonly "items": ReadonlyArray<{ readonly "invoiceId": string; readonly "tenantId": string; readonly "id": string; readonly "billingPeriodId"?: string; readonly "billedToName"?: string; readonly "status"?: "draft" | "finalized" | "charged" | "paid" | "voided" | "credited"; readonly "subtotalAmount"?: string; readonly "creditAppliedAmount"?: string; readonly "totalAmount"?: string; readonly "currency"?: string; readonly "finalizedAt"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
199
|
+
export type invoice_retrieveInput = { readonly "productId"?: string; readonly "invoiceId": string; };
|
|
200
|
+
export type invoice_retrieveOutput = { readonly "item": { readonly "invoiceId": string; readonly "tenantId": string; readonly "id": string; readonly "billingPeriodId"?: string; readonly "billedToName"?: string; readonly "status"?: "draft" | "finalized" | "charged" | "paid" | "voided" | "credited"; readonly "subtotalAmount"?: string; readonly "creditAppliedAmount"?: string; readonly "totalAmount"?: string; readonly "currency"?: string; readonly "finalizedAt"?: string; readonly "createdAt"?: string; }; };
|
|
201
|
+
export type kyc_requirements_retrieveInput = { readonly "country": string; };
|
|
202
|
+
export type kyc_requirements_retrieveOutput = { readonly "country": string; readonly "tiers": ReadonlyArray<{ readonly "tier": "basic" | "standard" | "investment"; readonly "level": number; readonly "name": string; readonly "summary": string; readonly "fieldGroups": ReadonlyArray<"identity" | "personal" | "address" | "education" | "financial_profile" | "employment" | "investment_experience" | "declarations" | "tax_residency" | "consent">; readonly "fields": ReadonlyArray<{ readonly "key": string; readonly "group": "identity" | "personal" | "address" | "education" | "financial_profile" | "employment" | "investment_experience" | "declarations" | "tax_residency" | "consent"; readonly "type": "text" | "boolean" | "integer" | "enum" | "multi_enum" | "country"; readonly "label": string; readonly "values"?: ReadonlyArray<string>; readonly "pattern"?: string; readonly "optional"?: boolean; readonly "dependsOn"?: { readonly "key": string; readonly "equals": boolean; }; readonly "mustEqual"?: boolean; }>; }>; };
|
|
203
|
+
export type meter_period_snapshot_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "billingPeriodId"?: string; };
|
|
204
|
+
export type meter_period_snapshot_listOutput = { readonly "items": ReadonlyArray<{ readonly "meterPeriodSnapshotId": string; readonly "tenantId": string; readonly "id": string; readonly "billingPeriodId"?: string; readonly "meter"?: string; readonly "quantity"?: string; readonly "status"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
205
|
+
export type meter_period_snapshot_retrieveInput = { readonly "productId"?: string; readonly "meterPeriodSnapshotId": string; };
|
|
206
|
+
export type meter_period_snapshot_retrieveOutput = { readonly "item": { readonly "meterPeriodSnapshotId": string; readonly "tenantId": string; readonly "id": string; readonly "billingPeriodId"?: string; readonly "meter"?: string; readonly "quantity"?: string; readonly "status"?: string; readonly "createdAt"?: string; }; };
|
|
207
|
+
export type operation_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "accepted" | "pending" | "succeeded" | "failed"; };
|
|
208
|
+
export type operation_listOutput = { readonly "items": ReadonlyArray<{ readonly "operationId": string; readonly "tenantId"?: string; readonly "name": string; readonly "status"?: "accepted" | "pending" | "succeeded" | "failed"; readonly "errorCode"?: string; readonly "errorMessage"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
209
|
+
export type operation_retrieveInput = { readonly "productId"?: string; readonly "operationId": string; };
|
|
210
|
+
export type operation_retrieveOutput = { readonly "item": { readonly "operationId": string; readonly "tenantId"?: string; readonly "name": string; readonly "status"?: "accepted" | "pending" | "succeeded" | "failed"; readonly "errorCode"?: string; readonly "errorMessage"?: string; readonly "createdAt"?: string; }; };
|
|
211
|
+
export type payout_createInput = { readonly "payoutId"?: string; readonly "sourceAccountId": string; readonly "beneficiaryId": string; readonly "amount": string; readonly "currency": string; readonly "speed": "instant" | "standard"; readonly "metadata"?: payout_createInput_Metadata; };
|
|
212
|
+
type payout_createInput_Metadata = { readonly [key: string]: payout_createInput_MetadataValue };
|
|
213
|
+
type payout_createInput_MetadataValue = (payout_createInput_MetadataScalar | ReadonlyArray<payout_createInput_MetadataScalar> | { readonly [key: string]: payout_createInput_MetadataScalar });
|
|
214
|
+
type payout_createInput_MetadataScalar = (string | number | boolean | null);
|
|
215
|
+
export type payout_createOutput = { readonly "payoutId": string; readonly "tenantId": string; readonly "sourceAccountId": string; readonly "beneficiaryId": string; readonly "amount": string; readonly "currency": string; readonly "speed": "instant" | "standard"; readonly "status": "created"; readonly "estimatedCompletionAt"?: string; readonly "createdAt": string; readonly "metadata": payout_createOutput_Metadata; };
|
|
216
|
+
type payout_createOutput_Metadata = { readonly [key: string]: payout_createOutput_MetadataValue };
|
|
217
|
+
type payout_createOutput_MetadataValue = (payout_createOutput_MetadataScalar | ReadonlyArray<payout_createOutput_MetadataScalar> | { readonly [key: string]: payout_createOutput_MetadataScalar });
|
|
218
|
+
type payout_createOutput_MetadataScalar = (string | number | boolean | null);
|
|
219
|
+
export type payout_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "created" | "processing" | "completed" | "failed" | "returned"; };
|
|
220
|
+
export type payout_listOutput = { readonly "items": ReadonlyArray<{ readonly "payoutId": string; readonly "tenantId": string; readonly "sourceAccountId"?: string; readonly "beneficiaryId"?: string; readonly "amount"?: string; readonly "currency"?: string; readonly "speed"?: string; readonly "transferId"?: string; readonly "estimatedCompletionAt"?: string; readonly "failureReason"?: string; readonly "returnReason"?: string; readonly "status"?: "created" | "processing" | "completed" | "failed" | "returned"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
221
|
+
export type payout_retrieveInput = { readonly "productId"?: string; readonly "payoutId": string; };
|
|
222
|
+
export type payout_retrieveOutput = { readonly "item": { readonly "payoutId": string; readonly "tenantId": string; readonly "sourceAccountId"?: string; readonly "beneficiaryId"?: string; readonly "amount"?: string; readonly "currency"?: string; readonly "speed"?: string; readonly "transferId"?: string; readonly "estimatedCompletionAt"?: string; readonly "failureReason"?: string; readonly "returnReason"?: string; readonly "status"?: "created" | "processing" | "completed" | "failed" | "returned"; readonly "createdAt"?: string; }; };
|
|
223
|
+
export type product_actions_listInput = { readonly "productId": string; readonly "instrument"?: string; };
|
|
224
|
+
export type product_actions_listOutput = { readonly "productBuildId": string; readonly "buildDigest": string; readonly "items": ReadonlyArray<{ readonly "instrument": string; readonly "name": string; readonly "action": string; readonly "actor": ("caller" | "clock" | { readonly "party": string; } | { readonly "parent": string; }); readonly "input": ReadonlyArray<({ readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "money"; readonly "value"?: string; readonly "minimum"?: string; readonly "maximum"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "account"; readonly "owner": string; readonly "key"?: string; readonly "book": "cash" | "claim"; readonly "contra"?: true; readonly "external"?: true; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "ref"; readonly "target": (string | ReadonlyArray<string>); } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "date"; readonly "value"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "duration"; readonly "value"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "text"; readonly "value"?: string; readonly "maxLength"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "integer"; readonly "value"?: number; readonly "minimum"?: number; readonly "maximum"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "percent"; readonly "value"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "boolean"; readonly "value"?: boolean; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "enum"; readonly "values": ReadonlyArray<string>; readonly "value"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "list"; readonly "item": "money" | "date" | "text" | "integer" | "ref"; readonly "target"?: string; readonly "maxItems": number; })>; readonly "fields": ReadonlyArray<({ readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "money"; readonly "value"?: string; readonly "minimum"?: string; readonly "maximum"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "account"; readonly "owner": string; readonly "key"?: string; readonly "book": "cash" | "claim"; readonly "contra"?: true; readonly "external"?: true; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "ref"; readonly "target": (string | ReadonlyArray<string>); } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "date"; readonly "value"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "duration"; readonly "value"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "text"; readonly "value"?: string; readonly "maxLength"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "integer"; readonly "value"?: number; readonly "minimum"?: number; readonly "maximum"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "percent"; readonly "value"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "boolean"; readonly "value"?: boolean; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "enum"; readonly "values": ReadonlyArray<string>; readonly "value"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "list"; readonly "item": "money" | "date" | "text" | "integer" | "ref"; readonly "target"?: string; readonly "maxItems": number; })>; readonly "parties": { readonly [key: string]: { readonly "kind": "person" | "business" | "staff"; readonly "role"?: string; } }; readonly "instanceIdRequired": boolean; readonly "method": "POST"; readonly "path": string; }>; };
|
|
225
|
+
export type product_activation_retrieveInput = { readonly "productId": string; };
|
|
226
|
+
export type product_activation_retrieveOutput = { readonly "environment": "sandbox" | "live"; readonly "tenantId": string; readonly "productId": string; readonly "readiness": product_activation_retrieveOutput_ProductActivationReadiness; readonly "cost": product_activation_retrieveOutput_ProductLiveCostEstimate; };
|
|
227
|
+
type product_activation_retrieveOutput_ProductActivationReadiness = { readonly "live": boolean; readonly "outstandingLiveRequirements": ReadonlyArray<product_activation_retrieveOutput_OutstandingLiveRequirement>; readonly "liveUnavailableCapabilities": ReadonlyArray<"identity" | "accounts" | "deposits" | "internal_transfers" | "payouts" | "beneficiary_verification" | "products" | "activity" | "usage" | "billing" | "webhooks" | "verification">; };
|
|
228
|
+
type product_activation_retrieveOutput_OutstandingLiveRequirement = { readonly "key": string; readonly "label": string; readonly "description": string; readonly "remedy": string; readonly "owner": "founder" | "platform_operator" | "provider_partner"; };
|
|
229
|
+
type product_activation_retrieveOutput_ProductLiveCostEstimate = { readonly "currency": string; readonly "platformMonthly": string | null; readonly "platformSetup": string | null; readonly "liveCapableCount": number; readonly "recurringCharges": ReadonlyArray<product_activation_retrieveOutput_ProductLiveCostCharge>; readonly "usageCharges": ReadonlyArray<product_activation_retrieveOutput_ProductLiveCostCharge>; readonly "estimatedMonthlyFixed": string | null; readonly "blockers": ReadonlyArray<product_activation_retrieveOutput_ProductLiveCostBlocker>; readonly "complete": boolean; };
|
|
230
|
+
type product_activation_retrieveOutput_ProductLiveCostCharge = { readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "kind": "recurring" | "per_event" | "volume_bps"; readonly "unit": string; readonly "amount": string | null; readonly "bps": string | null; readonly "summary": string; readonly "custom": boolean; };
|
|
231
|
+
type product_activation_retrieveOutput_ProductLiveCostBlocker = { readonly "code": "unpriced_meters" | "custom_pricing"; readonly "meters": ReadonlyArray<"account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation">; };
|
|
232
|
+
export type product_balance_sheet_retrieveInput = { readonly "productId": string; };
|
|
233
|
+
export type product_balance_sheet_retrieveOutput = { readonly "environment": "sandbox" | "live"; readonly "tenantId": string; readonly "productId": string; readonly "asOf": string; readonly "currency": string; readonly "liabilities": product_balance_sheet_retrieveOutput_ProductBalanceSheetSection; readonly "assets": product_balance_sheet_retrieveOutput_ProductBalanceSheetSection; readonly "revenue": product_balance_sheet_retrieveOutput_ProductBalanceSheetSection; };
|
|
234
|
+
type product_balance_sheet_retrieveOutput_ProductBalanceSheetSection = { readonly "total": string; readonly "lines": ReadonlyArray<product_balance_sheet_retrieveOutput_ProductBalanceSheetLine>; };
|
|
235
|
+
type product_balance_sheet_retrieveOutput_ProductBalanceSheetLine = { readonly "role": "customer_balance" | "customer_investment" | "product_escrow" | "product_pool" | "product_revenue"; readonly "accountCount": number; readonly "settled": string; readonly "pending": string; readonly "available": string; };
|
|
236
|
+
export type product_earn_rate_listInput = { readonly "productId": string; readonly "limit"?: number; readonly "cursor"?: string; };
|
|
237
|
+
export type product_earn_rate_listOutput = { readonly "items": ReadonlyArray<{ readonly "operationName": string; readonly "bps"?: string; readonly "flatAmount"?: string; readonly "updatedAt": string; }>; readonly "nextCursor"?: string; };
|
|
238
|
+
export type product_earnings_settleInput = { readonly "productId": string; readonly "transferId"?: string; readonly "amount": string; readonly "currency": string; };
|
|
239
|
+
export type product_earnings_settleOutput = { readonly "transferId": string; readonly "tenantId": string; readonly "productId": string; readonly "sourceAccountId": string; readonly "destinationAccountId": string; readonly "amount": string; readonly "currency": string; readonly "transferStatus": "posted"; };
|
|
240
|
+
export type product_guidance_retrieveInput = { readonly "productId": string; };
|
|
241
|
+
export type product_guidance_retrieveOutput = { readonly "items": ReadonlyArray<product_guidance_retrieveOutput_ProductGuidanceItem>; readonly "nextPredicate": ("mint_api_key" | "make_first_call" | "resolve_unpriced_meters" | "contact_sales_custom_pricing" | "complete_live_requirement" | "promote_product" | null); };
|
|
242
|
+
type product_guidance_retrieveOutput_ProductGuidanceItem = { readonly "predicate": "mint_api_key" | "make_first_call" | "resolve_unpriced_meters" | "contact_sales_custom_pricing" | "complete_live_requirement" | "promote_product"; readonly "status": "satisfied" | "actionable" | "blocked"; readonly "title": string; readonly "detail": string; readonly "target": product_guidance_retrieveOutput_ProductGuidanceTarget; readonly "requirement"?: string; };
|
|
243
|
+
type product_guidance_retrieveOutput_ProductGuidanceTarget = { readonly "kind": "operation" | "view"; readonly "ref": string; };
|
|
244
|
+
export type product_instruments_listInput = { readonly "productId": string; };
|
|
245
|
+
export type product_instruments_listOutput = { readonly "productBuildId": string; readonly "buildDigest": string; readonly "currency": string; readonly "items": ReadonlyArray<{ readonly "id": string; readonly "title": string; readonly "summary": string; readonly "fields": ReadonlyArray<({ readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "money"; readonly "value"?: string; readonly "minimum"?: string; readonly "maximum"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "account"; readonly "owner": string; readonly "key"?: string; readonly "book": "cash" | "claim"; readonly "contra"?: true; readonly "external"?: true; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "ref"; readonly "target": (string | ReadonlyArray<string>); } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "date"; readonly "value"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "duration"; readonly "value"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "text"; readonly "value"?: string; readonly "maxLength"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "integer"; readonly "value"?: number; readonly "minimum"?: number; readonly "maximum"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "percent"; readonly "value"?: number; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "boolean"; readonly "value"?: boolean; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "enum"; readonly "values": ReadonlyArray<string>; readonly "value"?: string; } | { readonly "name": string; readonly "optional"?: true; readonly "description"?: string; readonly "type": "list"; readonly "item": "money" | "date" | "text" | "integer" | "ref"; readonly "target"?: string; readonly "maxItems": number; })>; readonly "lifecycle": { readonly "states": ReadonlyArray<string>; readonly "initial": string; readonly "transitions": { readonly [key: string]: { readonly "from": ReadonlyArray<string>; readonly "to": string; } }; }; }>; };
|
|
246
|
+
export type product_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "pending" | "active" | "disabled" | "closed"; };
|
|
247
|
+
export type product_listOutput = { readonly "items": ReadonlyArray<product_listOutput_ProductListItem>; readonly "nextCursor"?: string; };
|
|
248
|
+
type product_listOutput_ProductListItem = { readonly "productId": string; readonly "tenantId": string; readonly "environment": "sandbox" | "live"; readonly "displayName": string; readonly "slug": string; readonly "kind": "app" | "offering" | "listing" | "booking" | "pool"; readonly "status": "pending" | "active" | "disabled" | "closed"; readonly "createdAt": string; };
|
|
249
|
+
export type product_margin_retrieveInput = { readonly "productId": string; };
|
|
250
|
+
export type product_margin_retrieveOutput = { readonly "asOf": string; readonly "items": ReadonlyArray<{ readonly "operationName": string; readonly "sell": { readonly "bps"?: string; readonly "flatAmount"?: string; }; readonly "buy": { readonly "volumeBps"?: string; readonly "perEvent"?: string; }; readonly "net": { readonly "bps": string; readonly "perEvent": string; }; }>; };
|
|
251
|
+
export type product_operation_set_retrieveInput = { readonly "productId": string; };
|
|
252
|
+
export type product_operation_set_retrieveOutput = { readonly "status": "frozen"; readonly "productBuildId": string; readonly "tenantSurfaceVersion": 3; readonly "tenantOperationSetDigest": string; readonly "publicActions": ReadonlyArray<product_operation_set_retrieveOutput_ProductPublicAction>; readonly "tenantReadOperationSetDigest": string; readonly "tenantSetupOperationSetDigest": string; readonly "readOperationIds": ReadonlyArray<string>; readonly "readOperations": ReadonlyArray<{ readonly "operationId": string; readonly "operationName": string; readonly "outputSchema": { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue }; readonly "inputSchema": { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue }; }>; readonly "setupOperationIds": ReadonlyArray<string>; readonly "setupOperations": ReadonlyArray<{ readonly "operationId": string; readonly "operationName": string; readonly "outputSchema": { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue }; readonly "inputSchema": { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue }; }>; readonly "unresolvedSetupOperationIds": ReadonlyArray<string>; };
|
|
253
|
+
type product_operation_set_retrieveOutput_ProductPublicAction = { readonly "name": string; readonly "instrument": string; readonly "inputSchema": { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue }; readonly "outputSchema": { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue }; readonly "actorPolicy": { readonly "principal": "api_key" | "customer_session" | "user_session"; }; readonly "portPolicy": ({ readonly "kind": "none"; } | { readonly "kind": "tenant_decision"; readonly "allowedParties": ReadonlyArray<string>; }); readonly "idempotencyPolicy": { readonly "mode": "not_required" | "optional" | "required"; }; readonly "receiptPolicy": { readonly "type": string; readonly "includeEvidence": boolean; }; readonly "receiptEvidence": { readonly "required": ReadonlyArray<"ledger" | "local" | "external">; readonly "optional"?: ReadonlyArray<"ledger" | "local" | "external">; }; };
|
|
254
|
+
type product_operation_set_retrieveOutput_JsonValue = (string | number | boolean | null | ReadonlyArray<product_operation_set_retrieveOutput_JsonValue> | { readonly [key: string]: product_operation_set_retrieveOutput_JsonValue });
|
|
255
|
+
export type product_retrieveInput = { readonly "productId": string; };
|
|
256
|
+
export type product_retrieveOutput = { readonly "productId": string; readonly "tenantId": string; readonly "environment": "sandbox" | "live"; readonly "displayName": string; readonly "slug": string; readonly "kind": "app" | "offering" | "listing" | "booking" | "pool"; readonly "status": "pending" | "active" | "disabled" | "closed"; readonly "instrumentIds": ReadonlyArray<string>; readonly "pricing": product_retrieveOutput_ProductPricingSchedule; readonly "billingBoundaryAt"?: string; readonly "readiness": product_retrieveOutput_ProductActivationReadiness; readonly "capabilities": ReadonlyArray<product_retrieveOutput_ProductCapability>; readonly "cost": product_retrieveOutput_ProductLiveCostEstimate; };
|
|
257
|
+
type product_retrieveOutput_ProductPricingSchedule = { readonly "current": product_retrieveOutput_ProductPricingCurrent; readonly "scheduled": (product_retrieveOutput_ProductPricingScheduled | null); };
|
|
258
|
+
type product_retrieveOutput_ProductPricingCurrent = { readonly "monthly": string; readonly "setup": string; readonly "complexityScore": number | null; readonly "rates": ReadonlyArray<product_retrieveOutput_ProductPlanRate>; readonly "currency": string; readonly "pricingIdentity": string; readonly "priceBasisIdentity": string; };
|
|
259
|
+
type product_retrieveOutput_ProductPlanRate = { readonly "id": string; readonly "kind": string; readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "signature": string; readonly "unit": string; readonly "amount"?: string; readonly "bps"?: string; readonly "includedQuantity"?: string; readonly "summary": string; readonly "currency": string; };
|
|
260
|
+
type product_retrieveOutput_ProductPricingScheduled = { readonly "monthly": string; readonly "setup": string; readonly "complexityScore": number | null; readonly "rates": ReadonlyArray<product_retrieveOutput_ProductPlanRate>; readonly "currency": string; readonly "pricingIdentity": string; readonly "priceBasisIdentity": string; readonly "effectiveAt": string; };
|
|
261
|
+
type product_retrieveOutput_ProductActivationReadiness = { readonly "live": boolean; readonly "outstandingLiveRequirements": ReadonlyArray<product_retrieveOutput_OutstandingLiveRequirement>; readonly "liveUnavailableCapabilities": ReadonlyArray<"identity" | "accounts" | "deposits" | "internal_transfers" | "payouts" | "beneficiary_verification" | "products" | "activity" | "usage" | "billing" | "webhooks" | "verification">; };
|
|
262
|
+
type product_retrieveOutput_OutstandingLiveRequirement = { readonly "key": string; readonly "label": string; readonly "description": string; readonly "remedy": string; readonly "owner": "founder" | "platform_operator" | "provider_partner"; };
|
|
263
|
+
type product_retrieveOutput_ProductCapability = { readonly "capabilityId": "identity" | "accounts" | "deposits" | "internal_transfers" | "payouts" | "beneficiary_verification" | "products" | "activity" | "usage" | "billing" | "webhooks" | "verification"; readonly "name": string | null; };
|
|
264
|
+
type product_retrieveOutput_ProductLiveCostEstimate = { readonly "currency": string; readonly "platformMonthly": string | null; readonly "platformSetup": string | null; readonly "liveCapableCount": number; readonly "recurringCharges": ReadonlyArray<product_retrieveOutput_ProductLiveCostCharge>; readonly "usageCharges": ReadonlyArray<product_retrieveOutput_ProductLiveCostCharge>; readonly "estimatedMonthlyFixed": string | null; readonly "blockers": ReadonlyArray<product_retrieveOutput_ProductLiveCostBlocker>; readonly "complete": boolean; };
|
|
265
|
+
type product_retrieveOutput_ProductLiveCostCharge = { readonly "meter": "account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation"; readonly "kind": "recurring" | "per_event" | "volume_bps"; readonly "unit": string; readonly "amount": string | null; readonly "bps": string | null; readonly "summary": string; readonly "custom": boolean; };
|
|
266
|
+
type product_retrieveOutput_ProductLiveCostBlocker = { readonly "code": "unpriced_meters" | "custom_pricing"; readonly "meters": ReadonlyArray<"account.active_month" | "account.created.count" | "financial_address.issued.count" | "financial_address.active_month" | "transfer.internal.count" | "transfer.internal.volume_sar" | "transfer.internal.volume_usd" | "transfer.internal.volume_eur" | "transfer.internal.volume_gbp" | "deposit.attributed.count" | "deposit.attributed.volume_sar" | "deposit.attributed.volume_usd" | "deposit.attributed.volume_eur" | "deposit.attributed.volume_gbp" | "payout.external.count" | "payout.external.volume_sar" | "payout.external.volume_usd" | "payout.external.volume_eur" | "payout.external.volume_gbp" | "collection.pay_in.count" | "collection.pay_in.volume_sar" | "collection.pay_in.volume_usd" | "collection.pay_in.volume_eur" | "collection.pay_in.volume_gbp" | "instrument.event.count" | "kyb.application.review" | "verification.kyc.basic.count" | "verification.kyc.standard.count" | "verification.kyc.investment.count" | "verification.kyb.count" | "operation.executed.count" | "api.read.count" | "billing.invoice.settlement" | "billing.plan.recurring_month" | "billing.product.activation">; };
|
|
267
|
+
export type product_treasury_provisionInput = { readonly "productId": string; };
|
|
268
|
+
export type product_treasury_provisionOutput = { readonly "tenantId": string; readonly "productId": string; readonly "treasuryStatus": "provisioned" | "existing"; readonly "accounts": ReadonlyArray<{ readonly "accountId": string; readonly "role": "product_credit" | "product_revenue"; readonly "currency": string; }>; };
|
|
269
|
+
export type product_treasury_retrieveInput = { readonly "productId": string; };
|
|
270
|
+
export type product_treasury_retrieveOutput = { readonly "environment": "sandbox" | "live"; readonly "tenantId": string; readonly "productId": string; readonly "asOf": string; readonly "credit": { readonly "accountId": string; readonly "available": string; readonly "pending": string; readonly "settled": string; readonly "currency": string; }; readonly "revenue": { readonly "accountId": string; readonly "available": string; readonly "pending": string; readonly "settled": string; readonly "currency": string; }; };
|
|
271
|
+
export type receipt_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
272
|
+
export type receipt_listOutput = { readonly "items": ReadonlyArray<{ readonly "receiptId": string; readonly "tenantId"?: string; readonly "id": string; readonly "operationName"?: string; readonly "operationId"?: string; readonly "errorCode"?: string; readonly "errorMessage"?: string; readonly "status"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
273
|
+
export type receipt_retrieveInput = { readonly "productId"?: string; readonly "receiptId": string; };
|
|
274
|
+
export type receipt_retrieveOutput = { readonly "item": { readonly "receiptId": string; readonly "tenantId"?: string; readonly "id": string; readonly "operationName"?: string; readonly "operationId"?: string; readonly "errorCode"?: string; readonly "errorMessage"?: string; readonly "status"?: string; readonly "createdAt"?: string; }; };
|
|
275
|
+
export type sandbox_bank_credit_requestInput = { readonly "financialAddressId": string; readonly "amount": string; readonly "currency": string; readonly "remittanceReference"?: string; readonly "counterparty"?: string; readonly "occurredAt"?: string; };
|
|
276
|
+
export type sandbox_bank_credit_requestOutput = { readonly "sandboxBankCreditRequestId": string; readonly "tenantId": string; readonly "financialAddressId": string; readonly "status": "queued"; readonly "createdAt": string; };
|
|
277
|
+
export type sandbox_account_fundInput = { readonly "transferId"?: string; readonly "destinationAccountId": string; readonly "amount": string; readonly "currency": string; };
|
|
278
|
+
export type sandbox_account_fundOutput = { readonly "transferId": string; readonly "tenantId": string; readonly "sourceAccountId": string; readonly "destinationAccountId": string; readonly "amount": string; readonly "currency": string; readonly "transferStatus": "posted"; };
|
|
279
|
+
export type sandbox_beneficiary_acceptInput = { readonly "beneficiaryId": string; };
|
|
280
|
+
export type sandbox_beneficiary_acceptOutput = { readonly "tenantId": string; readonly "beneficiaryId": string; readonly "provider": "sarie_sponsor_bank"; readonly "providerReference": string; readonly "acceptedAt": string; readonly "activeAt": string; readonly "status": "active"; readonly "verificationId": string; };
|
|
281
|
+
export type sandbox_clock_advanceInput = { readonly "productId"?: string; readonly "at": string; };
|
|
282
|
+
export type sandbox_clock_advanceOutput = { readonly "tenantId": string; readonly "productId": string; readonly "previousAt": string; readonly "at": string; };
|
|
283
|
+
export type sandbox_customer_access_activateInput = { readonly "customerAccessId": string; };
|
|
284
|
+
export type sandbox_customer_access_activateOutput = { readonly "customerAccessId": string; readonly "tenantId": string; readonly "productId": string; readonly "customerId": string; readonly "entityId": string; readonly "entityStatus": "pending" | "verified" | "rejected" | "disabled"; readonly "status": "pending" | "active" | "suspended" | "closed"; readonly "kycStatus": "not_required" | "pending" | "verified" | "rejected"; readonly "amlStatus": "not_screened" | "clear" | "review" | "blocked"; readonly "trustReviewId"?: string; };
|
|
285
|
+
export type sandbox_customer_onboardInput = { readonly "productId": string; readonly "displayName"?: string; };
|
|
286
|
+
export type sandbox_customer_onboardOutput = { readonly "tenantId": string; readonly "productId": string; readonly "customerId": string; readonly "customerAccessId": string; readonly "entityId": string; readonly "entityStatus": "pending" | "verified" | "rejected" | "disabled"; readonly "profileId": string; };
|
|
287
|
+
export type sandbox_platform_fireInput = { readonly "operation": string; readonly "input": { readonly [key: string]: unknown }; };
|
|
288
|
+
export type sandbox_platform_fireOutput = { readonly "operation": string; } & { readonly [key: string]: unknown };
|
|
289
|
+
export type subject_kind_listInput = { readonly "limit"?: number; readonly "cursor"?: string; };
|
|
290
|
+
export type subject_kind_listOutput = { readonly "items": ReadonlyArray<{ readonly "kind": string; readonly "version": number; readonly "title": string; readonly "origin": "platform" | "tenant"; readonly "attributes": { readonly [key: string]: unknown }; readonly "declaredValue": "required"; }>; readonly "nextCursor"?: string; };
|
|
291
|
+
export type subject_createInput = { readonly "subjectId"?: string; readonly "productId": string; readonly "kind": string; readonly "kindVersion": number; readonly "attributes": { readonly [key: string]: unknown }; readonly "declaredValue": { readonly "amount": string; readonly "currency": string; }; readonly "metadata"?: subject_createInput_Metadata; };
|
|
292
|
+
type subject_createInput_Metadata = { readonly [key: string]: subject_createInput_MetadataValue };
|
|
293
|
+
type subject_createInput_MetadataValue = (subject_createInput_MetadataScalar | ReadonlyArray<subject_createInput_MetadataScalar> | { readonly [key: string]: subject_createInput_MetadataScalar });
|
|
294
|
+
type subject_createInput_MetadataScalar = (string | number | boolean | null);
|
|
295
|
+
export type subject_createOutput = { readonly "subjectId": string; readonly "tenantId": string; readonly "productId": string; readonly "kind": string; readonly "kindVersion": number; readonly "attributes": { readonly [key: string]: unknown }; readonly "declaredValue": { readonly "amount": string; readonly "currency": string; }; readonly "createdAt": string; readonly "metadata": subject_createOutput_Metadata; };
|
|
296
|
+
type subject_createOutput_Metadata = { readonly [key: string]: subject_createOutput_MetadataValue };
|
|
297
|
+
type subject_createOutput_MetadataValue = (subject_createOutput_MetadataScalar | ReadonlyArray<subject_createOutput_MetadataScalar> | { readonly [key: string]: subject_createOutput_MetadataScalar });
|
|
298
|
+
type subject_createOutput_MetadataScalar = (string | number | boolean | null);
|
|
299
|
+
export type subject_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
300
|
+
export type subject_listOutput = { readonly "items": ReadonlyArray<{ readonly "subjectId": string; readonly "tenantId": string; readonly "productId"?: string; readonly "kind"?: string; readonly "kindVersion"?: number; readonly "attributes"?: { readonly [key: string]: unknown }; readonly "declaredValueAmount"?: string; readonly "declaredValueCurrency"?: string; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
301
|
+
export type subject_retrieveInput = { readonly "productId"?: string; readonly "subjectId": string; };
|
|
302
|
+
export type subject_retrieveOutput = { readonly "item": { readonly "subjectId": string; readonly "tenantId": string; readonly "productId"?: string; readonly "kind"?: string; readonly "kindVersion"?: number; readonly "attributes"?: { readonly [key: string]: unknown }; readonly "declaredValueAmount"?: string; readonly "declaredValueCurrency"?: string; readonly "createdAt"?: string; }; };
|
|
303
|
+
export type transfer_return_createInput = { readonly "returnId"?: string; readonly "originalTransferId": string; readonly "payoutId"?: string; readonly "reason": "insufficient_funds" | "account_closed" | "no_account" | "invalid_account" | "balance_cap_exceeded" | "unauthorized" | "other"; };
|
|
304
|
+
export type transfer_return_createOutput = { readonly "returnId": string; readonly "tenantId": string; readonly "originalTransferId": string; readonly "payoutId"?: string; readonly "reason": "insufficient_funds" | "account_closed" | "no_account" | "invalid_account" | "balance_cap_exceeded" | "unauthorized" | "other"; readonly "windowExpiresAt": string; readonly "returnStatus": "initiated"; };
|
|
305
|
+
export type trust_evidence_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "trustReviewId"?: string; };
|
|
306
|
+
export type trust_evidence_listOutput = { readonly "items": ReadonlyArray<{ readonly "trustEvidenceId": string; readonly "tenantId": string; readonly "id": string; readonly "trustReviewId"?: string; readonly "kind"?: string; readonly "documentType"?: string; readonly "checksum"?: string; readonly "checksumAlgorithm"?: string; readonly "mimeType"?: string; readonly "byteSize"?: number; readonly "filename"?: string; readonly "providerReference"?: string; readonly "status"?: "pending" | "accepted" | "rejected" | "superseded"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
307
|
+
export type trust_evidence_retrieveInput = { readonly "productId"?: string; readonly "trustEvidenceId": string; };
|
|
308
|
+
export type trust_evidence_retrieveOutput = { readonly "item": { readonly "trustEvidenceId": string; readonly "tenantId": string; readonly "id": string; readonly "trustReviewId"?: string; readonly "kind"?: string; readonly "documentType"?: string; readonly "checksum"?: string; readonly "checksumAlgorithm"?: string; readonly "mimeType"?: string; readonly "byteSize"?: number; readonly "filename"?: string; readonly "providerReference"?: string; readonly "status"?: "pending" | "accepted" | "rejected" | "superseded"; readonly "createdAt"?: string; }; };
|
|
309
|
+
export type trust_requirement_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "trustReviewId"?: string; readonly "status"?: "open" | "satisfied" | "waived" | "rejected"; };
|
|
310
|
+
export type trust_requirement_listOutput = { readonly "items": ReadonlyArray<{ readonly "trustRequirementId": string; readonly "tenantId": string; readonly "id": string; readonly "trustReviewId"?: string; readonly "requirementKey"?: string; readonly "status"?: "open" | "satisfied" | "waived" | "rejected"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
311
|
+
export type trust_requirement_respondInput = { readonly "trustReviewId": string; readonly "trustRequirementId": string; readonly "trustEvidenceId"?: string; readonly "response"?: string; readonly "metadata"?: trust_requirement_respondInput_Metadata; };
|
|
312
|
+
type trust_requirement_respondInput_Metadata = { readonly [key: string]: trust_requirement_respondInput_MetadataValue };
|
|
313
|
+
type trust_requirement_respondInput_MetadataValue = (trust_requirement_respondInput_MetadataScalar | ReadonlyArray<trust_requirement_respondInput_MetadataScalar> | { readonly [key: string]: trust_requirement_respondInput_MetadataScalar });
|
|
314
|
+
type trust_requirement_respondInput_MetadataScalar = (string | number | boolean | null);
|
|
315
|
+
export type trust_requirement_respondOutput = { readonly "trustRequirementId": string; readonly "trustReviewId": string; readonly "tenantId": string; readonly "status": "open" | "satisfied" | "waived" | "rejected"; };
|
|
316
|
+
export type trust_requirement_retrieveInput = { readonly "productId"?: string; readonly "trustRequirementId": string; };
|
|
317
|
+
export type trust_requirement_retrieveOutput = { readonly "item": { readonly "trustRequirementId": string; readonly "tenantId": string; readonly "id": string; readonly "trustReviewId"?: string; readonly "requirementKey"?: string; readonly "status"?: "open" | "satisfied" | "waived" | "rejected"; readonly "createdAt"?: string; }; };
|
|
318
|
+
export type trust_review_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "type"?: "product_activation" | "entity_kyb"; readonly "status"?: "draft" | "submitted" | "under_review" | "approved" | "rejected" | "cancelled"; };
|
|
319
|
+
export type trust_review_listOutput = { readonly "items": ReadonlyArray<{ readonly "trustReviewId": string; readonly "tenantId": string; readonly "type"?: string; readonly "productId"?: string; readonly "status"?: "draft" | "submitted" | "under_review" | "approved" | "rejected" | "cancelled"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
320
|
+
export type trust_review_retrieveInput = { readonly "productId"?: string; readonly "trustReviewId": string; };
|
|
321
|
+
export type trust_review_retrieveOutput = { readonly "item": { readonly "trustReviewId": string; readonly "tenantId": string; readonly "type"?: string; readonly "productId"?: string; readonly "status"?: "draft" | "submitted" | "under_review" | "approved" | "rejected" | "cancelled"; readonly "createdAt"?: string; }; };
|
|
322
|
+
export type usage_record_listInput = { readonly "productId"?: string; readonly "limit"?: number; readonly "cursor"?: string; readonly "query"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; };
|
|
323
|
+
export type usage_record_listOutput = { readonly "items": ReadonlyArray<{ readonly "usageRecordId": string; readonly "tenantId": string; readonly "meter": string; readonly "quantity"?: string; readonly "operationName"?: string; readonly "operationId"?: string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "settledAt": "execution" | "invoice"; readonly "createdAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
324
|
+
export type usage_record_retrieveInput = { readonly "productId"?: string; readonly "usageRecordId": string; };
|
|
325
|
+
export type usage_record_retrieveOutput = { readonly "item": { readonly "usageRecordId": string; readonly "tenantId": string; readonly "meter": string; readonly "quantity"?: string; readonly "operationName"?: string; readonly "operationId"?: string; readonly "sourceEventId"?: string; readonly "sourceOperationId"?: string; readonly "productId"?: string; readonly "settledAt": "execution" | "invoice"; readonly "createdAt"?: string; }; };
|
|
326
|
+
export type webhook_delivery_listInput = { readonly "limit"?: number; readonly "cursor"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "webhookEndpointId": string; readonly "status"?: "exhausted" | "failed" | "pending" | "succeeded"; };
|
|
327
|
+
export type webhook_delivery_listOutput = { readonly "items": ReadonlyArray<{ readonly "webhookDeliveryId": string; readonly "tenantId": string; readonly "id": string; readonly "webhookEndpointId": string; readonly "eventId": string; readonly "eventType": string; readonly "attempt": number; readonly "status": "exhausted" | "failed" | "pending" | "succeeded"; readonly "httpStatus"?: number; readonly "responseSnippet"?: string; readonly "createdAt": string; readonly "deliveredAt"?: string; readonly "nextAttemptAt"?: string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
328
|
+
export type webhook_delivery_resendInput = { readonly "webhookEndpointId": string; readonly "webhookDeliveryId": string; readonly "expectedEndpointUrl"?: string; };
|
|
329
|
+
export type webhook_delivery_resendOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "webhookDeliveryId": string; readonly "eventId": string; readonly "eventType": string; readonly "attempt": number; readonly "status": "exhausted" | "failed" | "pending" | "succeeded"; readonly "httpStatus": (number | null); readonly "responseSnippet": (string | null); readonly "nextAttemptAt": (string | null); readonly "deliveredAt": (string | null); readonly "createdAt": string; };
|
|
330
|
+
export type webhook_endpoint_createInput = { readonly "url": string; readonly "enabledEvents": ReadonlyArray<("*" | string)>; readonly "description"?: string; readonly "productId": string; readonly "entityAccountId"?: string; };
|
|
331
|
+
export type webhook_endpoint_createOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "productId": string; readonly "url": string; readonly "status": "deleted" | "disabled" | "enabled"; readonly "audience": "entity" | "tenant"; readonly "entityAccountId": (string | null); readonly "enabledEvents": ReadonlyArray<("*" | string)>; readonly "secretLast4": string; readonly "description": (string | null); readonly "lastDeliveryStatus": ("exhausted" | "failed" | "pending" | "succeeded" | null); readonly "lastDeliveryAt": (string | null); readonly "createdAt": string; readonly "updatedAt": string; readonly "signingSecret"?: string; };
|
|
332
|
+
export type webhook_endpoint_deleteInput = { readonly "webhookEndpointId": string; readonly "reason": string; };
|
|
333
|
+
export type webhook_endpoint_deleteOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "disabled" | "enabled"; readonly "status": "deleted"; };
|
|
334
|
+
export type webhook_endpoint_disableInput = { readonly "webhookEndpointId": string; readonly "reason": string; };
|
|
335
|
+
export type webhook_endpoint_disableOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "enabled"; readonly "status": "disabled"; };
|
|
336
|
+
export type webhook_endpoint_enableInput = { readonly "webhookEndpointId": string; readonly "reason": string; };
|
|
337
|
+
export type webhook_endpoint_enableOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "updatedAt": string; readonly "reason": string; readonly "previousStatus": "disabled"; readonly "status": "enabled"; };
|
|
338
|
+
export type webhook_endpoint_listInput = { readonly "limit"?: number; readonly "cursor"?: string; readonly "createdFrom"?: string; readonly "createdTo"?: string; readonly "status"?: "deleted" | "disabled" | "enabled"; readonly "productId"?: string; };
|
|
339
|
+
export type webhook_endpoint_listOutput = { readonly "items": ReadonlyArray<{ readonly "webhookEndpointId": string; readonly "tenantId": string; readonly "id": string; readonly "url": string; readonly "status": "deleted" | "disabled" | "enabled"; readonly "audience": "entity" | "tenant"; readonly "entityAccountId"?: string; readonly "productId"?: string; readonly "enabledEvents": ReadonlyArray<("*" | string)>; readonly "secretLast4": string; readonly "description"?: string; readonly "lastDeliveryStatus"?: "exhausted" | "failed" | "pending" | "succeeded"; readonly "lastDeliveryAt"?: string; readonly "createdAt": string; readonly "updatedAt": string; }>; readonly "nextCursor"?: string; readonly "statusCounts"?: { readonly [key: string]: number }; };
|
|
340
|
+
export type webhook_endpoint_recoverInput = { readonly "webhookEndpointId": string; readonly "since": string; };
|
|
341
|
+
export type webhook_endpoint_recoverOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "since": string; readonly "recoveredAt": string; readonly "enqueuedCount": number; readonly "eventIds": ReadonlyArray<string>; };
|
|
342
|
+
export type webhook_endpoint_retrieveInput = { readonly "webhookEndpointId": string; };
|
|
343
|
+
export type webhook_endpoint_retrieveOutput = { readonly "item": { readonly "webhookEndpointId": string; readonly "tenantId": string; readonly "id": string; readonly "url": string; readonly "status": "deleted" | "disabled" | "enabled"; readonly "audience": "entity" | "tenant"; readonly "entityAccountId"?: string; readonly "productId"?: string; readonly "enabledEvents": ReadonlyArray<("*" | string)>; readonly "secretLast4": string; readonly "description"?: string; readonly "lastDeliveryStatus"?: "exhausted" | "failed" | "pending" | "succeeded"; readonly "lastDeliveryAt"?: string; readonly "createdAt": string; readonly "updatedAt": string; }; };
|
|
344
|
+
export type webhook_endpoint_secret_rotateInput = { readonly "webhookEndpointId": string; };
|
|
345
|
+
export type webhook_endpoint_secret_rotateOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "productId": string; readonly "url": string; readonly "status": "deleted" | "disabled" | "enabled"; readonly "audience": "entity" | "tenant"; readonly "entityAccountId": (string | null); readonly "enabledEvents": ReadonlyArray<("*" | string)>; readonly "secretLast4": string; readonly "description": (string | null); readonly "lastDeliveryStatus": ("exhausted" | "failed" | "pending" | "succeeded" | null); readonly "lastDeliveryAt": (string | null); readonly "createdAt": string; readonly "updatedAt": string; readonly "signingSecret"?: string; readonly "previousSecretExpiresAt": string; };
|
|
346
|
+
export type webhook_endpoint_updateInput = { readonly "webhookEndpointId": string; readonly "reason": string; readonly "url"?: string; readonly "enabledEvents"?: ReadonlyArray<("*" | string)>; readonly "description"?: (string | null); };
|
|
347
|
+
export type webhook_endpoint_updateOutput = { readonly "tenantId": string; readonly "webhookEndpointId": string; readonly "productId": string; readonly "url": string; readonly "status": "deleted" | "disabled" | "enabled"; readonly "audience": "entity" | "tenant"; readonly "entityAccountId": (string | null); readonly "enabledEvents": ReadonlyArray<("*" | string)>; readonly "secretLast4": string; readonly "description": (string | null); readonly "lastDeliveryStatus": ("exhausted" | "failed" | "pending" | "succeeded" | null); readonly "lastDeliveryAt": (string | null); readonly "createdAt": string; readonly "updatedAt": string; readonly "reason": string; };
|
|
348
|
+
export interface Operations {
|
|
349
|
+
readonly "account.balance.retrieve": { input: account_balance_retrieveInput; output: account_balance_retrieveOutput };
|
|
350
|
+
readonly "account.bank.link": { input: account_bank_linkInput; output: account_bank_linkOutput };
|
|
351
|
+
readonly "account.close": { input: account_closeInput; output: account_closeOutput };
|
|
352
|
+
readonly "account.create": { input: account_createInput; output: account_createOutput };
|
|
353
|
+
readonly "account.freeze": { input: account_freezeInput; output: account_freezeOutput };
|
|
354
|
+
readonly "account.list": { input: account_listInput; output: account_listOutput };
|
|
355
|
+
readonly "account.retrieve": { input: account_retrieveInput; output: account_retrieveOutput };
|
|
356
|
+
readonly "account.statement.export": { input: account_statement_exportInput; output: account_statement_exportOutput };
|
|
357
|
+
readonly "account.statement.retrieve": { input: account_statement_retrieveInput; output: account_statement_retrieveOutput };
|
|
358
|
+
readonly "account.unfreeze": { input: account_unfreezeInput; output: account_unfreezeOutput };
|
|
359
|
+
readonly "activity.list": { input: activity_listInput; output: activity_listOutput };
|
|
360
|
+
readonly "audit_event.list": { input: audit_event_listInput; output: audit_event_listOutput };
|
|
361
|
+
readonly "audit_event.retrieve": { input: audit_event_retrieveInput; output: audit_event_retrieveOutput };
|
|
362
|
+
readonly "beneficiary.create": { input: beneficiary_createInput; output: beneficiary_createOutput };
|
|
363
|
+
readonly "beneficiary.list": { input: beneficiary_listInput; output: beneficiary_listOutput };
|
|
364
|
+
readonly "beneficiary.retrieve": { input: beneficiary_retrieveInput; output: beneficiary_retrieveOutput };
|
|
365
|
+
readonly "beneficiary.verify": { input: beneficiary_verifyInput; output: beneficiary_verifyOutput };
|
|
366
|
+
readonly "billing_adjustment.list": { input: billing_adjustment_listInput; output: billing_adjustment_listOutput };
|
|
367
|
+
readonly "billing_adjustment.retrieve": { input: billing_adjustment_retrieveInput; output: billing_adjustment_retrieveOutput };
|
|
368
|
+
readonly "billing_period.list": { input: billing_period_listInput; output: billing_period_listOutput };
|
|
369
|
+
readonly "billing_period.retrieve": { input: billing_period_retrieveInput; output: billing_period_retrieveOutput };
|
|
370
|
+
readonly "billing_subscription.list": { input: billing_subscription_listInput; output: billing_subscription_listOutput };
|
|
371
|
+
readonly "billing_subscription.retrieve": { input: billing_subscription_retrieveInput; output: billing_subscription_retrieveOutput };
|
|
372
|
+
readonly "charge.list": { input: charge_listInput; output: charge_listOutput };
|
|
373
|
+
readonly "charge.retrieve": { input: charge_retrieveInput; output: charge_retrieveOutput };
|
|
374
|
+
readonly "collection.list": { input: collection_listInput; output: collection_listOutput };
|
|
375
|
+
readonly "collection.pay_in.cancel": { input: collection_pay_in_cancelInput; output: collection_pay_in_cancelOutput };
|
|
376
|
+
readonly "collection.pay_in.capture": { input: collection_pay_in_captureInput; output: collection_pay_in_captureOutput };
|
|
377
|
+
readonly "collection.pay_in.reserve": { input: collection_pay_in_reserveInput; output: collection_pay_in_reserveOutput };
|
|
378
|
+
readonly "collection.retrieve": { input: collection_retrieveInput; output: collection_retrieveOutput };
|
|
379
|
+
readonly "consent.list": { input: consent_listInput; output: consent_listOutput };
|
|
380
|
+
readonly "consent.retrieve": { input: consent_retrieveInput; output: consent_retrieveOutput };
|
|
381
|
+
readonly "consent.revoke": { input: consent_revokeInput; output: consent_revokeOutput };
|
|
382
|
+
readonly "credit_balance.list": { input: credit_balance_listInput; output: credit_balance_listOutput };
|
|
383
|
+
readonly "credit_balance.retrieve": { input: credit_balance_retrieveInput; output: credit_balance_retrieveOutput };
|
|
384
|
+
readonly "credit_grant.list": { input: credit_grant_listInput; output: credit_grant_listOutput };
|
|
385
|
+
readonly "credit_grant.retrieve": { input: credit_grant_retrieveInput; output: credit_grant_retrieveOutput };
|
|
386
|
+
readonly "credit_ledger_entry.list": { input: credit_ledger_entry_listInput; output: credit_ledger_entry_listOutput };
|
|
387
|
+
readonly "credit_ledger_entry.retrieve": { input: credit_ledger_entry_retrieveInput; output: credit_ledger_entry_retrieveOutput };
|
|
388
|
+
readonly "credit_note_line.list": { input: credit_note_line_listInput; output: credit_note_line_listOutput };
|
|
389
|
+
readonly "credit_note_line.retrieve": { input: credit_note_line_retrieveInput; output: credit_note_line_retrieveOutput };
|
|
390
|
+
readonly "credit_note.list": { input: credit_note_listInput; output: credit_note_listOutput };
|
|
391
|
+
readonly "credit_note.retrieve": { input: credit_note_retrieveInput; output: credit_note_retrieveOutput };
|
|
392
|
+
readonly "customer_access.close": { input: customer_access_closeInput; output: customer_access_closeOutput };
|
|
393
|
+
readonly "customer_access.list": { input: customer_access_listInput; output: customer_access_listOutput };
|
|
394
|
+
readonly "customer_access.reactivate": { input: customer_access_reactivateInput; output: customer_access_reactivateOutput };
|
|
395
|
+
readonly "customer_access.retrieve": { input: customer_access_retrieveInput; output: customer_access_retrieveOutput };
|
|
396
|
+
readonly "customer_access.suspend": { input: customer_access_suspendInput; output: customer_access_suspendOutput };
|
|
397
|
+
readonly "customer.create": { input: customer_createInput; output: customer_createOutput };
|
|
398
|
+
readonly "customer.list": { input: customer_listInput; output: customer_listOutput };
|
|
399
|
+
readonly "customer.login": { input: customer_loginInput; output: customer_loginOutput };
|
|
400
|
+
readonly "customer.logout": { input: customer_logoutInput; output: customer_logoutOutput };
|
|
401
|
+
readonly "customer.retrieve": { input: customer_retrieveInput; output: customer_retrieveOutput };
|
|
402
|
+
readonly "customer.session.revoke": { input: customer_session_revokeInput; output: customer_session_revokeOutput };
|
|
403
|
+
readonly "customer.signup": { input: customer_signupInput; output: customer_signupOutput };
|
|
404
|
+
readonly "deposit.list": { input: deposit_listInput; output: deposit_listOutput };
|
|
405
|
+
readonly "deposit.retrieve": { input: deposit_retrieveInput; output: deposit_retrieveOutput };
|
|
406
|
+
readonly "developer.log.list": { input: developer_log_listInput; output: developer_log_listOutput };
|
|
407
|
+
readonly "developer.log.retrieve": { input: developer_log_retrieveInput; output: developer_log_retrieveOutput };
|
|
408
|
+
readonly "event.list": { input: event_listInput; output: event_listOutput };
|
|
409
|
+
readonly "event.retrieve": { input: event_retrieveInput; output: event_retrieveOutput };
|
|
410
|
+
readonly "expected_payment.cancel": { input: expected_payment_cancelInput; output: expected_payment_cancelOutput };
|
|
411
|
+
readonly "expected_payment.create": { input: expected_payment_createInput; output: expected_payment_createOutput };
|
|
412
|
+
readonly "expected_payment.list": { input: expected_payment_listInput; output: expected_payment_listOutput };
|
|
413
|
+
readonly "expected_payment.retrieve": { input: expected_payment_retrieveInput; output: expected_payment_retrieveOutput };
|
|
414
|
+
readonly "extension.list": { input: extension_listInput; output: extension_listOutput };
|
|
415
|
+
readonly "financial_address.create": { input: financial_address_createInput; output: financial_address_createOutput };
|
|
416
|
+
readonly "financial_address.disable": { input: financial_address_disableInput; output: financial_address_disableOutput };
|
|
417
|
+
readonly "financial_address.list": { input: financial_address_listInput; output: financial_address_listOutput };
|
|
418
|
+
readonly "financial_address.retrieve": { input: financial_address_retrieveInput; output: financial_address_retrieveOutput };
|
|
419
|
+
readonly "human_approval.approver.list": { input: human_approval_approver_listInput; output: human_approval_approver_listOutput };
|
|
420
|
+
readonly "human_approval.cancel": { input: human_approval_cancelInput; output: human_approval_cancelOutput };
|
|
421
|
+
readonly "human_approval.expire": { input: human_approval_expireInput; output: human_approval_expireOutput };
|
|
422
|
+
readonly "human_approval.request.create": { input: human_approval_request_createInput; output: human_approval_request_createOutput };
|
|
423
|
+
readonly "human_approval.request.list": { input: human_approval_request_listInput; output: human_approval_request_listOutput };
|
|
424
|
+
readonly "human_approval.request.retrieve": { input: human_approval_request_retrieveInput; output: human_approval_request_retrieveOutput };
|
|
425
|
+
readonly "internal_transfer.list": { input: internal_transfer_listInput; output: internal_transfer_listOutput };
|
|
426
|
+
readonly "internal_transfer.retrieve": { input: internal_transfer_retrieveInput; output: internal_transfer_retrieveOutput };
|
|
427
|
+
readonly "invoice_line.list": { input: invoice_line_listInput; output: invoice_line_listOutput };
|
|
428
|
+
readonly "invoice_line.retrieve": { input: invoice_line_retrieveInput; output: invoice_line_retrieveOutput };
|
|
429
|
+
readonly "invoice.list": { input: invoice_listInput; output: invoice_listOutput };
|
|
430
|
+
readonly "invoice.retrieve": { input: invoice_retrieveInput; output: invoice_retrieveOutput };
|
|
431
|
+
readonly "kyc.requirements.retrieve": { input: kyc_requirements_retrieveInput; output: kyc_requirements_retrieveOutput };
|
|
432
|
+
readonly "meter_period_snapshot.list": { input: meter_period_snapshot_listInput; output: meter_period_snapshot_listOutput };
|
|
433
|
+
readonly "meter_period_snapshot.retrieve": { input: meter_period_snapshot_retrieveInput; output: meter_period_snapshot_retrieveOutput };
|
|
434
|
+
readonly "operation.list": { input: operation_listInput; output: operation_listOutput };
|
|
435
|
+
readonly "operation.retrieve": { input: operation_retrieveInput; output: operation_retrieveOutput };
|
|
436
|
+
readonly "payout.create": { input: payout_createInput; output: payout_createOutput };
|
|
437
|
+
readonly "payout.list": { input: payout_listInput; output: payout_listOutput };
|
|
438
|
+
readonly "payout.retrieve": { input: payout_retrieveInput; output: payout_retrieveOutput };
|
|
439
|
+
readonly "product.actions.list": { input: product_actions_listInput; output: product_actions_listOutput };
|
|
440
|
+
readonly "product.activation.retrieve": { input: product_activation_retrieveInput; output: product_activation_retrieveOutput };
|
|
441
|
+
readonly "product.balance_sheet.retrieve": { input: product_balance_sheet_retrieveInput; output: product_balance_sheet_retrieveOutput };
|
|
442
|
+
readonly "product.earn.rate.list": { input: product_earn_rate_listInput; output: product_earn_rate_listOutput };
|
|
443
|
+
readonly "product.earnings.settle": { input: product_earnings_settleInput; output: product_earnings_settleOutput };
|
|
444
|
+
readonly "product.guidance.retrieve": { input: product_guidance_retrieveInput; output: product_guidance_retrieveOutput };
|
|
445
|
+
readonly "product.instruments.list": { input: product_instruments_listInput; output: product_instruments_listOutput };
|
|
446
|
+
readonly "product.list": { input: product_listInput; output: product_listOutput };
|
|
447
|
+
readonly "product.margin.retrieve": { input: product_margin_retrieveInput; output: product_margin_retrieveOutput };
|
|
448
|
+
readonly "product.operation_set.retrieve": { input: product_operation_set_retrieveInput; output: product_operation_set_retrieveOutput };
|
|
449
|
+
readonly "product.retrieve": { input: product_retrieveInput; output: product_retrieveOutput };
|
|
450
|
+
readonly "product.treasury.provision": { input: product_treasury_provisionInput; output: product_treasury_provisionOutput };
|
|
451
|
+
readonly "product.treasury.retrieve": { input: product_treasury_retrieveInput; output: product_treasury_retrieveOutput };
|
|
452
|
+
readonly "receipt.list": { input: receipt_listInput; output: receipt_listOutput };
|
|
453
|
+
readonly "receipt.retrieve": { input: receipt_retrieveInput; output: receipt_retrieveOutput };
|
|
454
|
+
readonly "sandbox_bank_credit.request": { input: sandbox_bank_credit_requestInput; output: sandbox_bank_credit_requestOutput };
|
|
455
|
+
readonly "sandbox.account.fund": { input: sandbox_account_fundInput; output: sandbox_account_fundOutput };
|
|
456
|
+
readonly "sandbox.beneficiary.accept": { input: sandbox_beneficiary_acceptInput; output: sandbox_beneficiary_acceptOutput };
|
|
457
|
+
readonly "sandbox.clock.advance": { input: sandbox_clock_advanceInput; output: sandbox_clock_advanceOutput };
|
|
458
|
+
readonly "sandbox.customer_access.activate": { input: sandbox_customer_access_activateInput; output: sandbox_customer_access_activateOutput };
|
|
459
|
+
readonly "sandbox.customer.onboard": { input: sandbox_customer_onboardInput; output: sandbox_customer_onboardOutput };
|
|
460
|
+
readonly "sandbox.platform.fire": { input: sandbox_platform_fireInput; output: sandbox_platform_fireOutput };
|
|
461
|
+
readonly "subject_kind.list": { input: subject_kind_listInput; output: subject_kind_listOutput };
|
|
462
|
+
readonly "subject.create": { input: subject_createInput; output: subject_createOutput };
|
|
463
|
+
readonly "subject.list": { input: subject_listInput; output: subject_listOutput };
|
|
464
|
+
readonly "subject.retrieve": { input: subject_retrieveInput; output: subject_retrieveOutput };
|
|
465
|
+
readonly "transfer_return.create": { input: transfer_return_createInput; output: transfer_return_createOutput };
|
|
466
|
+
readonly "trust_evidence.list": { input: trust_evidence_listInput; output: trust_evidence_listOutput };
|
|
467
|
+
readonly "trust_evidence.retrieve": { input: trust_evidence_retrieveInput; output: trust_evidence_retrieveOutput };
|
|
468
|
+
readonly "trust_requirement.list": { input: trust_requirement_listInput; output: trust_requirement_listOutput };
|
|
469
|
+
readonly "trust_requirement.respond": { input: trust_requirement_respondInput; output: trust_requirement_respondOutput };
|
|
470
|
+
readonly "trust_requirement.retrieve": { input: trust_requirement_retrieveInput; output: trust_requirement_retrieveOutput };
|
|
471
|
+
readonly "trust_review.list": { input: trust_review_listInput; output: trust_review_listOutput };
|
|
472
|
+
readonly "trust_review.retrieve": { input: trust_review_retrieveInput; output: trust_review_retrieveOutput };
|
|
473
|
+
readonly "usage_record.list": { input: usage_record_listInput; output: usage_record_listOutput };
|
|
474
|
+
readonly "usage_record.retrieve": { input: usage_record_retrieveInput; output: usage_record_retrieveOutput };
|
|
475
|
+
readonly "webhook.delivery.list": { input: webhook_delivery_listInput; output: webhook_delivery_listOutput };
|
|
476
|
+
readonly "webhook.delivery.resend": { input: webhook_delivery_resendInput; output: webhook_delivery_resendOutput };
|
|
477
|
+
readonly "webhook.endpoint.create": { input: webhook_endpoint_createInput; output: webhook_endpoint_createOutput };
|
|
478
|
+
readonly "webhook.endpoint.delete": { input: webhook_endpoint_deleteInput; output: webhook_endpoint_deleteOutput };
|
|
479
|
+
readonly "webhook.endpoint.disable": { input: webhook_endpoint_disableInput; output: webhook_endpoint_disableOutput };
|
|
480
|
+
readonly "webhook.endpoint.enable": { input: webhook_endpoint_enableInput; output: webhook_endpoint_enableOutput };
|
|
481
|
+
readonly "webhook.endpoint.list": { input: webhook_endpoint_listInput; output: webhook_endpoint_listOutput };
|
|
482
|
+
readonly "webhook.endpoint.recover": { input: webhook_endpoint_recoverInput; output: webhook_endpoint_recoverOutput };
|
|
483
|
+
readonly "webhook.endpoint.retrieve": { input: webhook_endpoint_retrieveInput; output: webhook_endpoint_retrieveOutput };
|
|
484
|
+
readonly "webhook.endpoint.secret.rotate": { input: webhook_endpoint_secret_rotateInput; output: webhook_endpoint_secret_rotateOutput };
|
|
485
|
+
readonly "webhook.endpoint.update": { input: webhook_endpoint_updateInput; output: webhook_endpoint_updateOutput };
|
|
486
|
+
}
|