@paxosglobal/sdk 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +268 -0
- package/CHANGELOG.md +35 -0
- package/LICENSE +191 -0
- package/README.md +445 -2
- package/dist/auth.d.ts +60 -0
- package/dist/auth.js +248 -0
- package/dist/auth.js.map +1 -0
- package/dist/client.d.ts +353 -0
- package/dist/client.js +967 -0
- package/dist/client.js.map +1 -0
- package/dist/constants.d.ts +16 -0
- package/dist/constants.js +17 -0
- package/dist/constants.js.map +1 -0
- package/dist/decimal-fields.d.ts +16 -0
- package/dist/decimal-fields.js +570 -0
- package/dist/decimal-fields.js.map +1 -0
- package/dist/decimal.d.ts +25 -0
- package/dist/decimal.js +93 -0
- package/dist/decimal.js.map +1 -0
- package/dist/decode.d.ts +34 -0
- package/dist/decode.js +118 -0
- package/dist/decode.js.map +1 -0
- package/dist/enums.d.ts +1080 -0
- package/dist/enums.js +1031 -0
- package/dist/enums.js.map +1 -0
- package/dist/errors.d.ts +142 -0
- package/dist/errors.js +261 -0
- package/dist/errors.js.map +1 -0
- package/dist/generated-types.d.ts +13629 -0
- package/dist/generated-types.js +3 -0
- package/dist/generated-types.js.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.js +31 -0
- package/dist/index.js.map +1 -0
- package/dist/models.d.ts +299 -0
- package/dist/models.js +3 -0
- package/dist/models.js.map +1 -0
- package/dist/paxos-client.d.ts +107 -0
- package/dist/paxos-client.js +157 -0
- package/dist/paxos-client.js.map +1 -0
- package/dist/query-keys.d.ts +1 -0
- package/dist/query-keys.js +31 -0
- package/dist/query-keys.js.map +1 -0
- package/dist/response-defaults.d.ts +2 -0
- package/dist/response-defaults.js +109 -0
- package/dist/response-defaults.js.map +1 -0
- package/dist/services/account-members.d.ts +32 -0
- package/dist/services/account-members.js +46 -0
- package/dist/services/account-members.js.map +1 -0
- package/dist/services/accounts.d.ts +74 -0
- package/dist/services/accounts.js +71 -0
- package/dist/services/accounts.js.map +1 -0
- package/dist/services/address-verification.d.ts +72 -0
- package/dist/services/address-verification.js +64 -0
- package/dist/services/address-verification.js.map +1 -0
- package/dist/services/api-credentials.d.ts +44 -0
- package/dist/services/api-credentials.js +42 -0
- package/dist/services/api-credentials.js.map +1 -0
- package/dist/services/claims.d.ts +68 -0
- package/dist/services/claims.js +67 -0
- package/dist/services/claims.js.map +1 -0
- package/dist/services/cross-chain-transfer.d.ts +71 -0
- package/dist/services/cross-chain-transfer.js +68 -0
- package/dist/services/cross-chain-transfer.js.map +1 -0
- package/dist/services/crypto-deposits.d.ts +30 -0
- package/dist/services/crypto-deposits.js +39 -0
- package/dist/services/crypto-deposits.js.map +1 -0
- package/dist/services/crypto-withdrawals.d.ts +60 -0
- package/dist/services/crypto-withdrawals.js +42 -0
- package/dist/services/crypto-withdrawals.js.map +1 -0
- package/dist/services/deposit-addresses.d.ts +54 -0
- package/dist/services/deposit-addresses.js +36 -0
- package/dist/services/deposit-addresses.js.map +1 -0
- package/dist/services/events.d.ts +53 -0
- package/dist/services/events.js +39 -0
- package/dist/services/events.js.map +1 -0
- package/dist/services/exchange.d.ts +52 -0
- package/dist/services/exchange.js +30 -0
- package/dist/services/exchange.js.map +1 -0
- package/dist/services/fees.d.ts +15 -0
- package/dist/services/fees.js +24 -0
- package/dist/services/fees.js.map +1 -0
- package/dist/services/fiat-transfers.d.ts +133 -0
- package/dist/services/fiat-transfers.js +127 -0
- package/dist/services/fiat-transfers.js.map +1 -0
- package/dist/services/identity-controls.d.ts +43 -0
- package/dist/services/identity-controls.js +42 -0
- package/dist/services/identity-controls.js.map +1 -0
- package/dist/services/identity-documents.d.ts +45 -0
- package/dist/services/identity-documents.js +50 -0
- package/dist/services/identity-documents.js.map +1 -0
- package/dist/services/identity.d.ts +122 -0
- package/dist/services/identity.js +66 -0
- package/dist/services/identity.js.map +1 -0
- package/dist/services/index.d.ts +89 -0
- package/dist/services/index.js +55 -0
- package/dist/services/index.js.map +1 -0
- package/dist/services/institution-members.d.ts +30 -0
- package/dist/services/institution-members.js +44 -0
- package/dist/services/institution-members.js.map +1 -0
- package/dist/services/internal-transfers.d.ts +15 -0
- package/dist/services/internal-transfers.js +26 -0
- package/dist/services/internal-transfers.js.map +1 -0
- package/dist/services/issuer-quotes.d.ts +72 -0
- package/dist/services/issuer-quotes.js +66 -0
- package/dist/services/issuer-quotes.js.map +1 -0
- package/dist/services/limits.d.ts +20 -0
- package/dist/services/limits.js +23 -0
- package/dist/services/limits.js.map +1 -0
- package/dist/services/market-data.d.ts +15 -0
- package/dist/services/market-data.js +23 -0
- package/dist/services/market-data.js.map +1 -0
- package/dist/services/monitoring-addresses.d.ts +64 -0
- package/dist/services/monitoring-addresses.js +68 -0
- package/dist/services/monitoring-addresses.js.map +1 -0
- package/dist/services/orchestration-rules.d.ts +53 -0
- package/dist/services/orchestration-rules.js +47 -0
- package/dist/services/orchestration-rules.js.map +1 -0
- package/dist/services/orchestrations.d.ts +70 -0
- package/dist/services/orchestrations.js +45 -0
- package/dist/services/orchestrations.js.map +1 -0
- package/dist/services/orders.d.ts +86 -0
- package/dist/services/orders.js +67 -0
- package/dist/services/orders.js.map +1 -0
- package/dist/services/paxos-transfers.d.ts +24 -0
- package/dist/services/paxos-transfers.js +35 -0
- package/dist/services/paxos-transfers.js.map +1 -0
- package/dist/services/payments.d.ts +46 -0
- package/dist/services/payments.js +35 -0
- package/dist/services/payments.js.map +1 -0
- package/dist/services/payout-groups.d.ts +59 -0
- package/dist/services/payout-groups.js +59 -0
- package/dist/services/payout-groups.js.map +1 -0
- package/dist/services/pricing.d.ts +67 -0
- package/dist/services/pricing.js +42 -0
- package/dist/services/pricing.js.map +1 -0
- package/dist/services/profiles.d.ts +106 -0
- package/dist/services/profiles.js +84 -0
- package/dist/services/profiles.js.map +1 -0
- package/dist/services/quote-executions.d.ts +51 -0
- package/dist/services/quote-executions.js +41 -0
- package/dist/services/quote-executions.js.map +1 -0
- package/dist/services/quotes.d.ts +44 -0
- package/dist/services/quotes.js +48 -0
- package/dist/services/quotes.js.map +1 -0
- package/dist/services/reward-addresses.d.ts +80 -0
- package/dist/services/reward-addresses.js +79 -0
- package/dist/services/reward-addresses.js.map +1 -0
- package/dist/services/rewards-statements.d.ts +35 -0
- package/dist/services/rewards-statements.js +32 -0
- package/dist/services/rewards-statements.js.map +1 -0
- package/dist/services/rewards.d.ts +34 -0
- package/dist/services/rewards.js +37 -0
- package/dist/services/rewards.js.map +1 -0
- package/dist/services/sandbox-deposits.d.ts +15 -0
- package/dist/services/sandbox-deposits.js +22 -0
- package/dist/services/sandbox-deposits.js.map +1 -0
- package/dist/services/sandbox-fiat-transfers.d.ts +15 -0
- package/dist/services/sandbox-fiat-transfers.js +24 -0
- package/dist/services/sandbox-fiat-transfers.js.map +1 -0
- package/dist/services/sandbox-identity.d.ts +39 -0
- package/dist/services/sandbox-identity.js +60 -0
- package/dist/services/sandbox-identity.js.map +1 -0
- package/dist/services/settlement.d.ts +76 -0
- package/dist/services/settlement.js +79 -0
- package/dist/services/settlement.js.map +1 -0
- package/dist/services/stablecoin-conversion.d.ts +70 -0
- package/dist/services/stablecoin-conversion.js +65 -0
- package/dist/services/stablecoin-conversion.js.map +1 -0
- package/dist/services/statements.d.ts +44 -0
- package/dist/services/statements.js +35 -0
- package/dist/services/statements.js.map +1 -0
- package/dist/services/tax-documentation.d.ts +21 -0
- package/dist/services/tax-documentation.js +33 -0
- package/dist/services/tax-documentation.js.map +1 -0
- package/dist/services/tax-forms.d.ts +45 -0
- package/dist/services/tax-forms.js +38 -0
- package/dist/services/tax-forms.js.map +1 -0
- package/dist/services/transfers.d.ts +96 -0
- package/dist/services/transfers.js +37 -0
- package/dist/services/transfers.js.map +1 -0
- package/dist/services/travel-rule.d.ts +32 -0
- package/dist/services/travel-rule.js +30 -0
- package/dist/services/travel-rule.js.map +1 -0
- package/dist/services/user-audit-logs.d.ts +45 -0
- package/dist/services/user-audit-logs.js +27 -0
- package/dist/services/user-audit-logs.js.map +1 -0
- package/dist/services/webhooks.d.ts +58 -0
- package/dist/services/webhooks.js +42 -0
- package/dist/services/webhooks.js.map +1 -0
- package/dist/signing.d.ts +33 -0
- package/dist/signing.js +186 -0
- package/dist/signing.js.map +1 -0
- package/dist/testing/fixtures.d.ts +40 -0
- package/dist/testing/fixtures.js +131 -0
- package/dist/testing/fixtures.js.map +1 -0
- package/dist/testing/index.d.ts +28 -0
- package/dist/testing/index.js +28 -0
- package/dist/testing/index.js.map +1 -0
- package/dist/testing/mock-server.d.ts +121 -0
- package/dist/testing/mock-server.js +276 -0
- package/dist/testing/mock-server.js.map +1 -0
- package/dist/timeouts.d.ts +13 -0
- package/dist/timeouts.js +71 -0
- package/dist/timeouts.js.map +1 -0
- package/dist/types.d.ts +6 -0
- package/dist/types.js +7 -0
- package/dist/types.js.map +1 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.js +2 -0
- package/dist/version.js.map +1 -0
- package/package.json +67 -4
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
|
|
2
|
+
import { buildPath } from "../client.js";
|
|
3
|
+
/**
|
|
4
|
+
* MonitoringAddressesService — A Monitoring Address is a blockchain address
|
|
5
|
+
* that Paxos monitors daily for eligible stablecoin activity and determines
|
|
6
|
+
* the amount of rewards your organization will earn. We recommend adding any
|
|
7
|
+
* addresses you expect to hold, receive, or mint Paxos stablecoins as a
|
|
8
|
+
* monitoring address in order to receive rewards for all of your qualifying
|
|
9
|
+
* on-chain activity.
|
|
10
|
+
*
|
|
11
|
+
* \> Monitoring addresses must be added by month end (`23:59 UTC+0`) in order
|
|
12
|
+
* to earn rewards for that month. Addresses added after month end will start
|
|
13
|
+
* earning rewards for the following month.
|
|
14
|
+
*
|
|
15
|
+
* *These endpoints are only relevant for Global Dollar Network (GDN)
|
|
16
|
+
* partners.*
|
|
17
|
+
*
|
|
18
|
+
* Access via `client.monitoringAddresses`.
|
|
19
|
+
*/
|
|
20
|
+
export class MonitoringAddressesService {
|
|
21
|
+
client;
|
|
22
|
+
/** @internal */
|
|
23
|
+
constructor(client) {
|
|
24
|
+
this.client = client;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* List Monitoring Address
|
|
28
|
+
*
|
|
29
|
+
* Requires scope: rewards:read_monitoring_address
|
|
30
|
+
* @deprecated This API operation is deprecated.
|
|
31
|
+
*/
|
|
32
|
+
listMonitoringAddress(params, opts) {
|
|
33
|
+
return this.client.paginate("/rewards/monitor/address", "addresses", params, opts, {
|
|
34
|
+
responseSchema: "ListMonitoringAddressResponse",
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Create Monitoring Address
|
|
39
|
+
*
|
|
40
|
+
* Requires scope: rewards:write_monitoring_address
|
|
41
|
+
* @deprecated This API operation is deprecated.
|
|
42
|
+
*/
|
|
43
|
+
async createMonitoringAddress(request, opts) {
|
|
44
|
+
return this.client.post("/rewards/monitor/address", request, opts, {
|
|
45
|
+
responseSchema: "CreateMonitoringAddressResponse",
|
|
46
|
+
requestSchema: "CreateMonitoringAddressRequest",
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Get Monitoring Address
|
|
51
|
+
*
|
|
52
|
+
* Requires scope: rewards:read_monitoring_address
|
|
53
|
+
* @deprecated This API operation is deprecated.
|
|
54
|
+
*/
|
|
55
|
+
async getMonitoringAddress(id, opts) {
|
|
56
|
+
return this.client.get(buildPath("/rewards/monitor/address/{id}", { id: id }), undefined, opts, { responseSchema: "GetMonitoringAddressResponse" });
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Update Monitoring Address
|
|
60
|
+
*
|
|
61
|
+
* Requires scope: rewards:write_monitoring_address
|
|
62
|
+
* @deprecated This API operation is deprecated.
|
|
63
|
+
*/
|
|
64
|
+
async updateMonitoringAddress(id, request, opts) {
|
|
65
|
+
return this.client.put(buildPath("/rewards/monitor/address/{id}", { id: id }), request, opts, { responseSchema: "UpdateMonitoringAddressResponse", requestSchema: "UpdateMonitoringAddressRequest" });
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
//# sourceMappingURL=monitoring-addresses.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"monitoring-addresses.js","sourceRoot":"","sources":["../../src/services/monitoring-addresses.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AA0BzC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,0BAA0B;IAER;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;;OAKG;IACH,qBAAqB,CACnB,MAAoC,EACpC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAA6B,0BAA0B,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE;YAC7G,cAAc,EAAE,+BAA+B;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAuC,EACvC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAA2C,0BAA0B,EAAE,OAAO,EAAE,IAAI,EAAE;YAC3G,cAAc,EAAE,iCAAiC;YACjD,aAAa,EAAE,gCAAgC;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CAAC,EAAU,EAAE,IAAqB;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,+BAA+B,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACtD,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,8BAA8B,EAAE,CACnD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,EAAU,EACV,OAAuC,EACvC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,+BAA+B,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACtD,OAAO,EACP,IAAI,EACJ,EAAE,cAAc,EAAE,iCAAiC,EAAE,aAAa,EAAE,gCAAgC,EAAE,CACvG,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownCryptoNetwork, KnownSortOrder } from \"../enums.js\";\nimport type {\n CreateMonitoringAddressRequest,\n CreateMonitoringAddressResponse,\n GetMonitoringAddressResponse,\n MonitoringAddress,\n UpdateMonitoringAddressRequest,\n UpdateMonitoringAddressResponse,\n} from \"../models.js\";\n\nexport interface ListMonitoringAddressParams {\n /** On-chain address Paxos is monitoring for eligible reward activity. Must be valid for the specified network.\nFor `SOLANA` specify the wallet account (ie: not a derived/token account like an ATA). */\n address?: string;\n /** Network the address belongs to. Supported: `ETHEREUM`, `SOLANA`, `INK`, `XLAYER`. */\n crypto_network?: KnownCryptoNetwork | (string & {});\n /** Number of results to return. Defaults to `100` if no limit is provided. Maximum `1000`. */\n limit?: number;\n /** Results are ordered by `created_at`. Specify the ordering of the results. Defaults to `DESC`. */\n order?: KnownSortOrder | (string & {});\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * MonitoringAddressesService — A Monitoring Address is a blockchain address\n * that Paxos monitors daily for eligible stablecoin activity and determines\n * the amount of rewards your organization will earn. We recommend adding any\n * addresses you expect to hold, receive, or mint Paxos stablecoins as a\n * monitoring address in order to receive rewards for all of your qualifying\n * on-chain activity.\n *\n * \\> Monitoring addresses must be added by month end (`23:59 UTC+0`) in order\n * to earn rewards for that month. Addresses added after month end will start\n * earning rewards for the following month.\n *\n * *These endpoints are only relevant for Global Dollar Network (GDN)\n * partners.*\n *\n * Access via `client.monitoringAddresses`.\n */\nexport class MonitoringAddressesService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List Monitoring Address\n *\n * Requires scope: rewards:read_monitoring_address\n * @deprecated This API operation is deprecated.\n */\n listMonitoringAddress(\n params?: ListMonitoringAddressParams,\n opts?: RequestOptions,\n ): PageIterator<WithRaw<MonitoringAddress>> {\n return this.client.paginate<WithRaw<MonitoringAddress>>(\"/rewards/monitor/address\", \"addresses\", params, opts, {\n responseSchema: \"ListMonitoringAddressResponse\",\n });\n }\n\n /**\n * Create Monitoring Address\n *\n * Requires scope: rewards:write_monitoring_address\n * @deprecated This API operation is deprecated.\n */\n async createMonitoringAddress(\n request: CreateMonitoringAddressRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<CreateMonitoringAddressResponse>> {\n return this.client.post<WithRaw<CreateMonitoringAddressResponse>>(\"/rewards/monitor/address\", request, opts, {\n responseSchema: \"CreateMonitoringAddressResponse\",\n requestSchema: \"CreateMonitoringAddressRequest\",\n });\n }\n\n /**\n * Get Monitoring Address\n *\n * Requires scope: rewards:read_monitoring_address\n * @deprecated This API operation is deprecated.\n */\n async getMonitoringAddress(id: string, opts?: RequestOptions): Promise<WithRaw<GetMonitoringAddressResponse>> {\n return this.client.get<WithRaw<GetMonitoringAddressResponse>>(\n buildPath(\"/rewards/monitor/address/{id}\", { id: id }),\n undefined,\n opts,\n { responseSchema: \"GetMonitoringAddressResponse\" },\n );\n }\n\n /**\n * Update Monitoring Address\n *\n * Requires scope: rewards:write_monitoring_address\n * @deprecated This API operation is deprecated.\n */\n async updateMonitoringAddress(\n id: string,\n request: UpdateMonitoringAddressRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<UpdateMonitoringAddressResponse>> {\n return this.client.put<WithRaw<UpdateMonitoringAddressResponse>>(\n buildPath(\"/rewards/monitor/address/{id}\", { id: id }),\n request,\n opts,\n { responseSchema: \"UpdateMonitoringAddressResponse\", requestSchema: \"UpdateMonitoringAddressRequest\" },\n );\n }\n}\n"]}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
|
|
2
|
+
import type { KnownOrchestrationRuleStatus, KnownSortOrder } from "../enums.js";
|
|
3
|
+
import type { CreateOrchestrationRuleRequest, CreateOrchestrationRuleResponse, DeleteOrchestrationRuleResponse, OrchestrationRule } from "../models.js";
|
|
4
|
+
export interface ListOrchestrationRulesParams {
|
|
5
|
+
/** Optional filter by profile ID */
|
|
6
|
+
profile_id?: string;
|
|
7
|
+
/** Optional filter by statuses
|
|
8
|
+
|
|
9
|
+
- ACTIVE: The rule is active, deposits matching the `source_asset` and `source` of this rule start a conversion and
|
|
10
|
+
subsequent delivery of the `destination_asset` to the specified `destination`.
|
|
11
|
+
- DELETED: The rule has been deleted, newly deposited `source_assets` to the `source` of this rule will not be converted.
|
|
12
|
+
The deposited `source_asset` is still going to be credited to the Profile specified by `profile_id`.
|
|
13
|
+
- PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE.
|
|
14
|
+
- REJECTED: The rule creation has been rejected during the approval process. */
|
|
15
|
+
status?: (KnownOrchestrationRuleStatus | (string & {}))[];
|
|
16
|
+
/** Optional filter by source asset */
|
|
17
|
+
source_asset?: string;
|
|
18
|
+
/** Optional filter by destination asset */
|
|
19
|
+
destination_asset?: string;
|
|
20
|
+
/** Optionally filter by the UUIDs of the orchestration rules. Limit 100. */
|
|
21
|
+
ids?: string[];
|
|
22
|
+
/** Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. */
|
|
23
|
+
limit?: number;
|
|
24
|
+
/** Sort order for the results. Defaults to DESC by created_at time. */
|
|
25
|
+
order?: KnownSortOrder | (string & {});
|
|
26
|
+
/** Resume from a cursor previously returned as a page's `nextCursor`. */
|
|
27
|
+
page_cursor?: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* OrchestrationRulesService provides access to OrchestrationRules API operations.
|
|
31
|
+
* Access via `client.orchestrationRules`.
|
|
32
|
+
*/
|
|
33
|
+
export declare class OrchestrationRulesService {
|
|
34
|
+
private readonly client;
|
|
35
|
+
/**
|
|
36
|
+
* List Orchestration Rules
|
|
37
|
+
*
|
|
38
|
+
* Requires scope: orchestration:read_orchestration_rule
|
|
39
|
+
*/
|
|
40
|
+
listOrchestrationRules(params?: ListOrchestrationRulesParams, opts?: RequestOptions): PageIterator<WithRaw<OrchestrationRule>>;
|
|
41
|
+
/**
|
|
42
|
+
* Create Orchestration Rule
|
|
43
|
+
*
|
|
44
|
+
* Requires scope: orchestration:write_orchestration_rule
|
|
45
|
+
*/
|
|
46
|
+
createOrchestrationRule(request: CreateOrchestrationRuleRequest, opts?: RequestOptions): Promise<WithRaw<CreateOrchestrationRuleResponse>>;
|
|
47
|
+
/**
|
|
48
|
+
* Delete Orchestration Rule
|
|
49
|
+
*
|
|
50
|
+
* Requires scope: orchestration:write_orchestration_rule
|
|
51
|
+
*/
|
|
52
|
+
deleteOrchestrationRule(id: string, opts?: RequestOptions): Promise<WithRaw<DeleteOrchestrationRuleResponse>>;
|
|
53
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
|
|
2
|
+
import { buildPath } from "../client.js";
|
|
3
|
+
/**
|
|
4
|
+
* OrchestrationRulesService provides access to OrchestrationRules API operations.
|
|
5
|
+
* Access via `client.orchestrationRules`.
|
|
6
|
+
*/
|
|
7
|
+
export class OrchestrationRulesService {
|
|
8
|
+
client;
|
|
9
|
+
/** @internal */
|
|
10
|
+
constructor(client) {
|
|
11
|
+
this.client = client;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List Orchestration Rules
|
|
15
|
+
*
|
|
16
|
+
* Requires scope: orchestration:read_orchestration_rule
|
|
17
|
+
*/
|
|
18
|
+
listOrchestrationRules(params, opts) {
|
|
19
|
+
return this.client.paginate("/orchestration/rules", "items", params, opts, {
|
|
20
|
+
responseSchema: "ListOrchestrationRulesResponse",
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Create Orchestration Rule
|
|
25
|
+
*
|
|
26
|
+
* Requires scope: orchestration:write_orchestration_rule
|
|
27
|
+
*/
|
|
28
|
+
async createOrchestrationRule(request, opts) {
|
|
29
|
+
const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };
|
|
30
|
+
return this.client.post("/orchestration/rules", body, opts, {
|
|
31
|
+
responseSchema: "CreateOrchestrationRuleResponse",
|
|
32
|
+
requestSchema: "CreateOrchestrationRuleRequest",
|
|
33
|
+
replayProtected: true,
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Delete Orchestration Rule
|
|
38
|
+
*
|
|
39
|
+
* Requires scope: orchestration:write_orchestration_rule
|
|
40
|
+
*/
|
|
41
|
+
async deleteOrchestrationRule(id, opts) {
|
|
42
|
+
return this.client.delete(buildPath("/orchestration/rules/{id}", { id: id }), undefined, opts, {
|
|
43
|
+
responseSchema: "DeleteOrchestrationRuleResponse",
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=orchestration-rules.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"orchestration-rules.js","sourceRoot":"","sources":["../../src/services/orchestration-rules.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAoCzC;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAEP;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,sBAAsB,CACpB,MAAqC,EACrC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAA6B,sBAAsB,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YACrG,cAAc,EAAE,gCAAgC;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAuC,EACvC,IAAqB;QAErB,MAAM,IAAI,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAA2C,sBAAsB,EAAE,IAAI,EAAE,IAAI,EAAE;YACpG,cAAc,EAAE,iCAAiC;YACjD,aAAa,EAAE,gCAAgC;YAC/C,eAAe,EAAE,IAAI;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,uBAAuB,CAAC,EAAU,EAAE,IAAqB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,2BAA2B,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE;YAC7F,cAAc,EAAE,iCAAiC;SAClD,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownOrchestrationRuleStatus, KnownSortOrder } from \"../enums.js\";\nimport type {\n CreateOrchestrationRuleRequest,\n CreateOrchestrationRuleResponse,\n DeleteOrchestrationRuleResponse,\n OrchestrationRule,\n} from \"../models.js\";\n\nexport interface ListOrchestrationRulesParams {\n /** Optional filter by profile ID */\n profile_id?: string;\n /** Optional filter by statuses\n\n - ACTIVE: The rule is active, deposits matching the `source_asset` and `source` of this rule start a conversion and\nsubsequent delivery of the `destination_asset` to the specified `destination`.\n - DELETED: The rule has been deleted, newly deposited `source_assets` to the `source` of this rule will not be converted.\nThe deposited `source_asset` is still going to be credited to the Profile specified by `profile_id`.\n - PENDING: The rule creation is pending approval(s) before the rule becomes ACTIVE.\n - REJECTED: The rule creation has been rejected during the approval process. */\n status?: (KnownOrchestrationRuleStatus | (string & {}))[];\n /** Optional filter by source asset */\n source_asset?: string;\n /** Optional filter by destination asset */\n destination_asset?: string;\n /** Optionally filter by the UUIDs of the orchestration rules. Limit 100. */\n ids?: string[];\n /** Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. */\n limit?: number;\n /** Sort order for the results. Defaults to DESC by created_at time. */\n order?: KnownSortOrder | (string & {});\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * OrchestrationRulesService provides access to OrchestrationRules API operations.\n * Access via `client.orchestrationRules`.\n */\nexport class OrchestrationRulesService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List Orchestration Rules\n *\n * Requires scope: orchestration:read_orchestration_rule\n */\n listOrchestrationRules(\n params?: ListOrchestrationRulesParams,\n opts?: RequestOptions,\n ): PageIterator<WithRaw<OrchestrationRule>> {\n return this.client.paginate<WithRaw<OrchestrationRule>>(\"/orchestration/rules\", \"items\", params, opts, {\n responseSchema: \"ListOrchestrationRulesResponse\",\n });\n }\n\n /**\n * Create Orchestration Rule\n *\n * Requires scope: orchestration:write_orchestration_rule\n */\n async createOrchestrationRule(\n request: CreateOrchestrationRuleRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<CreateOrchestrationRuleResponse>> {\n const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };\n return this.client.post<WithRaw<CreateOrchestrationRuleResponse>>(\"/orchestration/rules\", body, opts, {\n responseSchema: \"CreateOrchestrationRuleResponse\",\n requestSchema: \"CreateOrchestrationRuleRequest\",\n replayProtected: true,\n });\n }\n\n /**\n * Delete Orchestration Rule\n *\n * Requires scope: orchestration:write_orchestration_rule\n */\n async deleteOrchestrationRule(id: string, opts?: RequestOptions): Promise<WithRaw<DeleteOrchestrationRuleResponse>> {\n return this.client.delete(buildPath(\"/orchestration/rules/{id}\", { id: id }), undefined, opts, {\n responseSchema: \"DeleteOrchestrationRuleResponse\",\n });\n }\n}\n"]}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
|
|
2
|
+
import type { KnownSortOrder } from "../enums.js";
|
|
3
|
+
import type { CreateOrchestrationRequest, Orchestration } from "../models.js";
|
|
4
|
+
export interface ListOrchestrationsParams {
|
|
5
|
+
/** Optionally filter by the initiating orchestration rule ids. There is a limit of 100 orchestration rule ids that can be specified in a single request. */
|
|
6
|
+
orchestration_rule_id?: string[];
|
|
7
|
+
/** Optionally filter by source assets. There is a limit of 100 source assets that can be specified in a single request. */
|
|
8
|
+
source_asset?: string[];
|
|
9
|
+
/** Optionally filter by destination assets. There is a limit of 100 destination assets ids that can be specified in a single request. */
|
|
10
|
+
destination_asset?: string[];
|
|
11
|
+
/** Optionally filter by statuses. There is a limit of 100 statuses that can be specified in a single request. */
|
|
12
|
+
status?: string[];
|
|
13
|
+
/** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
14
|
+
created_at_lt?: string;
|
|
15
|
+
/** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
16
|
+
created_at_lte?: string;
|
|
17
|
+
/** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
18
|
+
created_at_eq?: string;
|
|
19
|
+
/** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
20
|
+
created_at_gte?: string;
|
|
21
|
+
/** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
22
|
+
created_at_gt?: string;
|
|
23
|
+
/** Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. */
|
|
24
|
+
limit?: number;
|
|
25
|
+
/** Sort order for the results. Defaults to DESC by created_at time. */
|
|
26
|
+
order?: KnownSortOrder | (string & {});
|
|
27
|
+
/** Optionally filter by a list of orchestration IDs. There is a limit of 100 orchestration ids that can be specified in a single request. */
|
|
28
|
+
orchestration_id?: string[];
|
|
29
|
+
/** Optionally filter by the target profiles. There is a limit of 100 profiles that can be specified in a single request. */
|
|
30
|
+
profile_id?: string[];
|
|
31
|
+
/** Optionally filter by client-provided reference IDs. There is a limit of 100 ref_ids that can be specified in a single request. */
|
|
32
|
+
ref_id?: string[];
|
|
33
|
+
/** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
34
|
+
updated_at_lt?: string;
|
|
35
|
+
/** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
36
|
+
updated_at_lte?: string;
|
|
37
|
+
/** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
38
|
+
updated_at_eq?: string;
|
|
39
|
+
/** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
40
|
+
updated_at_gte?: string;
|
|
41
|
+
/** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
42
|
+
updated_at_gt?: string;
|
|
43
|
+
/** Resume from a cursor previously returned as a page's `nextCursor`. */
|
|
44
|
+
page_cursor?: string;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* OrchestrationsService provides access to Orchestrations API operations.
|
|
48
|
+
* Access via `client.orchestrations`.
|
|
49
|
+
*/
|
|
50
|
+
export declare class OrchestrationsService {
|
|
51
|
+
private readonly client;
|
|
52
|
+
/**
|
|
53
|
+
* List Orchestrations
|
|
54
|
+
*
|
|
55
|
+
* Requires scope: orchestration:read_orchestration
|
|
56
|
+
*/
|
|
57
|
+
listOrchestrations(params?: ListOrchestrationsParams, opts?: RequestOptions): PageIterator<WithRaw<Orchestration>>;
|
|
58
|
+
/**
|
|
59
|
+
* Create Orchestration
|
|
60
|
+
*
|
|
61
|
+
* Requires scope: orchestration:write_orchestration
|
|
62
|
+
*/
|
|
63
|
+
createOrchestration(request: CreateOrchestrationRequest, opts?: RequestOptions): Promise<WithRaw<Orchestration>>;
|
|
64
|
+
/**
|
|
65
|
+
* Get Orchestration
|
|
66
|
+
*
|
|
67
|
+
* Requires scope: orchestration:read_orchestration
|
|
68
|
+
*/
|
|
69
|
+
getOrchestration(id: string, opts?: RequestOptions): Promise<WithRaw<Orchestration>>;
|
|
70
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
|
|
2
|
+
import { buildPath } from "../client.js";
|
|
3
|
+
/**
|
|
4
|
+
* OrchestrationsService provides access to Orchestrations API operations.
|
|
5
|
+
* Access via `client.orchestrations`.
|
|
6
|
+
*/
|
|
7
|
+
export class OrchestrationsService {
|
|
8
|
+
client;
|
|
9
|
+
/** @internal */
|
|
10
|
+
constructor(client) {
|
|
11
|
+
this.client = client;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List Orchestrations
|
|
15
|
+
*
|
|
16
|
+
* Requires scope: orchestration:read_orchestration
|
|
17
|
+
*/
|
|
18
|
+
listOrchestrations(params, opts) {
|
|
19
|
+
return this.client.paginate("/orchestration/orchestrations", "items", params, opts, {
|
|
20
|
+
responseSchema: "ListOrchestrationsResponse",
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Create Orchestration
|
|
25
|
+
*
|
|
26
|
+
* Requires scope: orchestration:write_orchestration
|
|
27
|
+
*/
|
|
28
|
+
async createOrchestration(request, opts) {
|
|
29
|
+
const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };
|
|
30
|
+
return this.client.post("/orchestration/orchestrations", body, opts, {
|
|
31
|
+
responseSchema: "Orchestration",
|
|
32
|
+
requestSchema: "CreateOrchestrationRequest",
|
|
33
|
+
replayProtected: true,
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Get Orchestration
|
|
38
|
+
*
|
|
39
|
+
* Requires scope: orchestration:read_orchestration
|
|
40
|
+
*/
|
|
41
|
+
async getOrchestration(id, opts) {
|
|
42
|
+
return this.client.get(buildPath("/orchestration/orchestrations/{id}", { id: id }), undefined, opts, { responseSchema: "Orchestration" });
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=orchestrations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"orchestrations.js","sourceRoot":"","sources":["../../src/services/orchestrations.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAgDzC;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAEH;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,kBAAkB,CAAC,MAAiC,EAAE,IAAqB;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAyB,+BAA+B,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YAC1G,cAAc,EAAE,4BAA4B;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAmC,EACnC,IAAqB;QAErB,MAAM,IAAI,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAyB,+BAA+B,EAAE,IAAI,EAAE,IAAI,EAAE;YAC3F,cAAc,EAAE,eAAe;YAC/B,aAAa,EAAE,4BAA4B;YAC3C,eAAe,EAAE,IAAI;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CAAC,EAAU,EAAE,IAAqB;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,oCAAoC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAC3D,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,eAAe,EAAE,CACpC,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownSortOrder } from \"../enums.js\";\nimport type { CreateOrchestrationRequest, Orchestration } from \"../models.js\";\n\nexport interface ListOrchestrationsParams {\n /** Optionally filter by the initiating orchestration rule ids. There is a limit of 100 orchestration rule ids that can be specified in a single request. */\n orchestration_rule_id?: string[];\n /** Optionally filter by source assets. There is a limit of 100 source assets that can be specified in a single request. */\n source_asset?: string[];\n /** Optionally filter by destination assets. There is a limit of 100 destination assets ids that can be specified in a single request. */\n destination_asset?: string[];\n /** Optionally filter by statuses. There is a limit of 100 statuses that can be specified in a single request. */\n status?: string[];\n /** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_lt?: string;\n /** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_lte?: string;\n /** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_eq?: string;\n /** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_gte?: string;\n /** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_gt?: string;\n /** Number of results to return. Defaults to 100 if no limit is provided. Maximum 1000. */\n limit?: number;\n /** Sort order for the results. Defaults to DESC by created_at time. */\n order?: KnownSortOrder | (string & {});\n /** Optionally filter by a list of orchestration IDs. There is a limit of 100 orchestration ids that can be specified in a single request. */\n orchestration_id?: string[];\n /** Optionally filter by the target profiles. There is a limit of 100 profiles that can be specified in a single request. */\n profile_id?: string[];\n /** Optionally filter by client-provided reference IDs. There is a limit of 100 ref_ids that can be specified in a single request. */\n ref_id?: string[];\n /** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_lt?: string;\n /** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_lte?: string;\n /** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_eq?: string;\n /** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_gte?: string;\n /** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_gt?: string;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * OrchestrationsService provides access to Orchestrations API operations.\n * Access via `client.orchestrations`.\n */\nexport class OrchestrationsService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List Orchestrations\n *\n * Requires scope: orchestration:read_orchestration\n */\n listOrchestrations(params?: ListOrchestrationsParams, opts?: RequestOptions): PageIterator<WithRaw<Orchestration>> {\n return this.client.paginate<WithRaw<Orchestration>>(\"/orchestration/orchestrations\", \"items\", params, opts, {\n responseSchema: \"ListOrchestrationsResponse\",\n });\n }\n\n /**\n * Create Orchestration\n *\n * Requires scope: orchestration:write_orchestration\n */\n async createOrchestration(\n request: CreateOrchestrationRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<Orchestration>> {\n const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };\n return this.client.post<WithRaw<Orchestration>>(\"/orchestration/orchestrations\", body, opts, {\n responseSchema: \"Orchestration\",\n requestSchema: \"CreateOrchestrationRequest\",\n replayProtected: true,\n });\n }\n\n /**\n * Get Orchestration\n *\n * Requires scope: orchestration:read_orchestration\n */\n async getOrchestration(id: string, opts?: RequestOptions): Promise<WithRaw<Orchestration>> {\n return this.client.get<WithRaw<Orchestration>>(\n buildPath(\"/orchestration/orchestrations/{id}\", { id: id }),\n undefined,\n opts,\n { responseSchema: \"Orchestration\" },\n );\n }\n}\n"]}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
|
|
2
|
+
import type { KnownMarket, KnownOrderStatus } from "../enums.js";
|
|
3
|
+
import type { CancelOrderResponse, CreateOrderRequest, Execution, Order } from "../models.js";
|
|
4
|
+
export interface ListExecutionsParams {
|
|
5
|
+
/** Filter executions by the Profile ID associated with the orders. */
|
|
6
|
+
profile_id?: string;
|
|
7
|
+
/** Filter executions by the Account ID associated with the orders. */
|
|
8
|
+
account_id?: string;
|
|
9
|
+
/** Filter executions for a single order ID. */
|
|
10
|
+
order_id?: string;
|
|
11
|
+
/** Excludes executions after the given ID. */
|
|
12
|
+
since_execution_id?: string;
|
|
13
|
+
/** Only return records after this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
14
|
+
range_begin?: string;
|
|
15
|
+
/** Only return records before this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
16
|
+
range_end?: string;
|
|
17
|
+
/** Number of results to return. */
|
|
18
|
+
limit?: number;
|
|
19
|
+
/** Resume from a cursor previously returned as a page's `nextCursor`. */
|
|
20
|
+
page_cursor?: string;
|
|
21
|
+
}
|
|
22
|
+
export interface ListOrdersParams {
|
|
23
|
+
/** The profile associated with the orders. */
|
|
24
|
+
profile_id?: string;
|
|
25
|
+
/** The account under which these orders are placed. */
|
|
26
|
+
account_id?: string;
|
|
27
|
+
/** Filter by the trading pair. */
|
|
28
|
+
market?: KnownMarket | (string & {});
|
|
29
|
+
/** Filter by the status of the order. */
|
|
30
|
+
status?: KnownOrderStatus | (string & {});
|
|
31
|
+
/** Only return records after this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
32
|
+
order_time_begin?: string;
|
|
33
|
+
/** Only return records before this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */
|
|
34
|
+
order_time_end?: string;
|
|
35
|
+
/** The idempotence IDs provided during order creation. */
|
|
36
|
+
ref_ids?: string[];
|
|
37
|
+
/** Number of results to return. If using this then do not use paginationLimit and paginationOffset fields. */
|
|
38
|
+
limit?: number;
|
|
39
|
+
/** Resume from a cursor previously returned as a page's `nextCursor`. */
|
|
40
|
+
page_cursor?: string;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* OrdersService — There are four types of orders: market, limit, stop market,
|
|
44
|
+
* and stop limit.
|
|
45
|
+
*
|
|
46
|
+
* Market orders guarantee execution at a variable price and quantity. Limit
|
|
47
|
+
* orders guarantee price and quantity at the time of execution but do not
|
|
48
|
+
* guarantee execution. Stop-market orders convert to market orders when the
|
|
49
|
+
* stop price is reached. Stop-limit orders convert to limit orders at the
|
|
50
|
+
* specified price or better when the stop price is reached.
|
|
51
|
+
*
|
|
52
|
+
* Access via `client.orders`.
|
|
53
|
+
*/
|
|
54
|
+
export declare class OrdersService {
|
|
55
|
+
private readonly client;
|
|
56
|
+
/**
|
|
57
|
+
* List Executions
|
|
58
|
+
*
|
|
59
|
+
* Requires scope: exchange:read_order
|
|
60
|
+
*/
|
|
61
|
+
listExecutions(params?: ListExecutionsParams, opts?: RequestOptions): PageIterator<WithRaw<Execution>>;
|
|
62
|
+
/**
|
|
63
|
+
* List Orders
|
|
64
|
+
*
|
|
65
|
+
* Requires scope: exchange:read_order
|
|
66
|
+
*/
|
|
67
|
+
listOrders(params?: ListOrdersParams, opts?: RequestOptions): PageIterator<WithRaw<Order>>;
|
|
68
|
+
/**
|
|
69
|
+
* Create Order
|
|
70
|
+
*
|
|
71
|
+
* Requires scope: exchange:write_order
|
|
72
|
+
*/
|
|
73
|
+
createOrder(profileId: string, request: CreateOrderRequest, opts?: RequestOptions): Promise<WithRaw<Order>>;
|
|
74
|
+
/**
|
|
75
|
+
* Get Order
|
|
76
|
+
*
|
|
77
|
+
* Requires scope: exchange:read_order
|
|
78
|
+
*/
|
|
79
|
+
getOrder(profileId: string, id: string, opts?: RequestOptions): Promise<WithRaw<Order>>;
|
|
80
|
+
/**
|
|
81
|
+
* Cancel Order
|
|
82
|
+
*
|
|
83
|
+
* Requires scope: exchange:write_order
|
|
84
|
+
*/
|
|
85
|
+
cancelOrder(profileId: string, id: string, opts?: RequestOptions): Promise<WithRaw<CancelOrderResponse>>;
|
|
86
|
+
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
|
|
2
|
+
import { buildPath } from "../client.js";
|
|
3
|
+
/**
|
|
4
|
+
* OrdersService — There are four types of orders: market, limit, stop market,
|
|
5
|
+
* and stop limit.
|
|
6
|
+
*
|
|
7
|
+
* Market orders guarantee execution at a variable price and quantity. Limit
|
|
8
|
+
* orders guarantee price and quantity at the time of execution but do not
|
|
9
|
+
* guarantee execution. Stop-market orders convert to market orders when the
|
|
10
|
+
* stop price is reached. Stop-limit orders convert to limit orders at the
|
|
11
|
+
* specified price or better when the stop price is reached.
|
|
12
|
+
*
|
|
13
|
+
* Access via `client.orders`.
|
|
14
|
+
*/
|
|
15
|
+
export class OrdersService {
|
|
16
|
+
client;
|
|
17
|
+
/** @internal */
|
|
18
|
+
constructor(client) {
|
|
19
|
+
this.client = client;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* List Executions
|
|
23
|
+
*
|
|
24
|
+
* Requires scope: exchange:read_order
|
|
25
|
+
*/
|
|
26
|
+
listExecutions(params, opts) {
|
|
27
|
+
return this.client.paginate("/executions", "items", params, opts, {
|
|
28
|
+
responseSchema: "ListExecutionsResponse",
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* List Orders
|
|
33
|
+
*
|
|
34
|
+
* Requires scope: exchange:read_order
|
|
35
|
+
*/
|
|
36
|
+
listOrders(params, opts) {
|
|
37
|
+
return this.client.paginate("/orders", "items", params, opts, {
|
|
38
|
+
responseSchema: "ListOrdersResponse",
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Create Order
|
|
43
|
+
*
|
|
44
|
+
* Requires scope: exchange:write_order
|
|
45
|
+
*/
|
|
46
|
+
async createOrder(profileId, request, opts) {
|
|
47
|
+
const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };
|
|
48
|
+
return this.client.post(buildPath("/profiles/{profile_id}/orders", { profile_id: profileId }), body, opts, { responseSchema: "Order", requestSchema: "CreateOrderRequest", replayProtected: true });
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Get Order
|
|
52
|
+
*
|
|
53
|
+
* Requires scope: exchange:read_order
|
|
54
|
+
*/
|
|
55
|
+
async getOrder(profileId, id, opts) {
|
|
56
|
+
return this.client.get(buildPath("/profiles/{profile_id}/orders/{id}", { profile_id: profileId, id: id }), undefined, opts, { responseSchema: "Order" });
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Cancel Order
|
|
60
|
+
*
|
|
61
|
+
* Requires scope: exchange:write_order
|
|
62
|
+
*/
|
|
63
|
+
async cancelOrder(profileId, id, opts) {
|
|
64
|
+
return this.client.delete(buildPath("/profiles/{profile_id}/orders/{id}", { profile_id: profileId, id: id }), undefined, opts, { responseSchema: "CancelOrderResponse" });
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
//# sourceMappingURL=orders.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"orders.js","sourceRoot":"","sources":["../../src/services/orders.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AA6CzC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,aAAa;IAEK;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,cAAc,CAAC,MAA6B,EAAE,IAAqB;QACjE,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAqB,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YACpF,cAAc,EAAE,wBAAwB;SACzC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAyB,EAAE,IAAqB;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAiB,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YAC5E,cAAc,EAAE,oBAAoB;SACrC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,OAA2B,EAAE,IAAqB;QACrF,MAAM,IAAI,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CACrB,SAAS,CAAC,+BAA+B,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,EACrE,IAAI,EACJ,IAAI,EACJ,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,eAAe,EAAE,IAAI,EAAE,CACxF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,EAAU,EAAE,IAAqB;QACjE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,oCAAoC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAClF,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,OAAO,EAAE,CAC5B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,EAAU,EAAE,IAAqB;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CACvB,SAAS,CAAC,oCAAoC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAClF,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,qBAAqB,EAAE,CAC1C,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownMarket, KnownOrderStatus } from \"../enums.js\";\nimport type { CancelOrderResponse, CreateOrderRequest, Execution, Order } from \"../models.js\";\n\nexport interface ListExecutionsParams {\n /** Filter executions by the Profile ID associated with the orders. */\n profile_id?: string;\n /** Filter executions by the Account ID associated with the orders. */\n account_id?: string;\n /** Filter executions for a single order ID. */\n order_id?: string;\n /** Excludes executions after the given ID. */\n since_execution_id?: string;\n /** Only return records after this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n range_begin?: string;\n /** Only return records before this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n range_end?: string;\n /** Number of results to return. */\n limit?: number;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\nexport interface ListOrdersParams {\n /** The profile associated with the orders. */\n profile_id?: string;\n /** The account under which these orders are placed. */\n account_id?: string;\n /** Filter by the trading pair. */\n market?: KnownMarket | (string & {});\n /** Filter by the status of the order. */\n status?: KnownOrderStatus | (string & {});\n /** Only return records after this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n order_time_begin?: string;\n /** Only return records before this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n order_time_end?: string;\n /** The idempotence IDs provided during order creation. */\n ref_ids?: string[];\n /** Number of results to return. If using this then do not use paginationLimit and paginationOffset fields. */\n limit?: number;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * OrdersService — There are four types of orders: market, limit, stop market,\n * and stop limit.\n *\n * Market orders guarantee execution at a variable price and quantity. Limit\n * orders guarantee price and quantity at the time of execution but do not\n * guarantee execution. Stop-market orders convert to market orders when the\n * stop price is reached. Stop-limit orders convert to limit orders at the\n * specified price or better when the stop price is reached.\n *\n * Access via `client.orders`.\n */\nexport class OrdersService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List Executions\n *\n * Requires scope: exchange:read_order\n */\n listExecutions(params?: ListExecutionsParams, opts?: RequestOptions): PageIterator<WithRaw<Execution>> {\n return this.client.paginate<WithRaw<Execution>>(\"/executions\", \"items\", params, opts, {\n responseSchema: \"ListExecutionsResponse\",\n });\n }\n\n /**\n * List Orders\n *\n * Requires scope: exchange:read_order\n */\n listOrders(params?: ListOrdersParams, opts?: RequestOptions): PageIterator<WithRaw<Order>> {\n return this.client.paginate<WithRaw<Order>>(\"/orders\", \"items\", params, opts, {\n responseSchema: \"ListOrdersResponse\",\n });\n }\n\n /**\n * Create Order\n *\n * Requires scope: exchange:write_order\n */\n async createOrder(profileId: string, request: CreateOrderRequest, opts?: RequestOptions): Promise<WithRaw<Order>> {\n const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };\n return this.client.post<WithRaw<Order>>(\n buildPath(\"/profiles/{profile_id}/orders\", { profile_id: profileId }),\n body,\n opts,\n { responseSchema: \"Order\", requestSchema: \"CreateOrderRequest\", replayProtected: true },\n );\n }\n\n /**\n * Get Order\n *\n * Requires scope: exchange:read_order\n */\n async getOrder(profileId: string, id: string, opts?: RequestOptions): Promise<WithRaw<Order>> {\n return this.client.get<WithRaw<Order>>(\n buildPath(\"/profiles/{profile_id}/orders/{id}\", { profile_id: profileId, id: id }),\n undefined,\n opts,\n { responseSchema: \"Order\" },\n );\n }\n\n /**\n * Cancel Order\n *\n * Requires scope: exchange:write_order\n */\n async cancelOrder(profileId: string, id: string, opts?: RequestOptions): Promise<WithRaw<CancelOrderResponse>> {\n return this.client.delete(\n buildPath(\"/profiles/{profile_id}/orders/{id}\", { profile_id: profileId, id: id }),\n undefined,\n opts,\n { responseSchema: \"CancelOrderResponse\" },\n );\n }\n}\n"]}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { RequestOptions, WithRaw } from "../client.js";
|
|
2
|
+
import type { CreatePaxosTransferRequest, Transfer } from "../models.js";
|
|
3
|
+
/**
|
|
4
|
+
* PaxosTransfersService — Move assets between two Entities belonging to the
|
|
5
|
+
* same Organization or to a different Organization on the Paxos platform.
|
|
6
|
+
*
|
|
7
|
+
* \> Transferring USD between Entities is prohibited in some jurisdictions.
|
|
8
|
+
* Contact Support if you run into any problems with this restriction.
|
|
9
|
+
*
|
|
10
|
+
* Ensure the destination Profile already exists before beginning the transfer.
|
|
11
|
+
* This may require contacting someone outside your Organization to get the
|
|
12
|
+
* destination Profile ID.
|
|
13
|
+
*
|
|
14
|
+
* Access via `client.paxosTransfers`.
|
|
15
|
+
*/
|
|
16
|
+
export declare class PaxosTransfersService {
|
|
17
|
+
private readonly client;
|
|
18
|
+
/**
|
|
19
|
+
* Create Paxos Transfer
|
|
20
|
+
*
|
|
21
|
+
* Requires scope: transfer:write_paxos_transfer
|
|
22
|
+
*/
|
|
23
|
+
createPaxosTransfer(request: CreatePaxosTransferRequest, opts?: RequestOptions): Promise<WithRaw<Transfer>>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
|
|
2
|
+
/**
|
|
3
|
+
* PaxosTransfersService — Move assets between two Entities belonging to the
|
|
4
|
+
* same Organization or to a different Organization on the Paxos platform.
|
|
5
|
+
*
|
|
6
|
+
* \> Transferring USD between Entities is prohibited in some jurisdictions.
|
|
7
|
+
* Contact Support if you run into any problems with this restriction.
|
|
8
|
+
*
|
|
9
|
+
* Ensure the destination Profile already exists before beginning the transfer.
|
|
10
|
+
* This may require contacting someone outside your Organization to get the
|
|
11
|
+
* destination Profile ID.
|
|
12
|
+
*
|
|
13
|
+
* Access via `client.paxosTransfers`.
|
|
14
|
+
*/
|
|
15
|
+
export class PaxosTransfersService {
|
|
16
|
+
client;
|
|
17
|
+
/** @internal */
|
|
18
|
+
constructor(client) {
|
|
19
|
+
this.client = client;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Create Paxos Transfer
|
|
23
|
+
*
|
|
24
|
+
* Requires scope: transfer:write_paxos_transfer
|
|
25
|
+
*/
|
|
26
|
+
async createPaxosTransfer(request, opts) {
|
|
27
|
+
const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };
|
|
28
|
+
return this.client.post("/transfer/paxos", body, opts, {
|
|
29
|
+
responseSchema: "Transfer",
|
|
30
|
+
requestSchema: "CreatePaxosTransferRequest",
|
|
31
|
+
replayProtected: true,
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=paxos-transfers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"paxos-transfers.js","sourceRoot":"","sources":["../../src/services/paxos-transfers.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAKpE;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,qBAAqB;IAEH;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAmC,EAAE,IAAqB;QAClF,MAAM,IAAI,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAoB,iBAAiB,EAAE,IAAI,EAAE,IAAI,EAAE;YACxE,cAAc,EAAE,UAAU;YAC1B,aAAa,EAAE,4BAA4B;YAC3C,eAAe,EAAE,IAAI;SACtB,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport type { HttpClient, RequestOptions, WithRaw } from \"../client.js\";\nimport type { CreatePaxosTransferRequest, Transfer } from \"../models.js\";\n\n/**\n * PaxosTransfersService — Move assets between two Entities belonging to the\n * same Organization or to a different Organization on the Paxos platform.\n *\n * \\> Transferring USD between Entities is prohibited in some jurisdictions.\n * Contact Support if you run into any problems with this restriction.\n *\n * Ensure the destination Profile already exists before beginning the transfer.\n * This may require contacting someone outside your Organization to get the\n * destination Profile ID.\n *\n * Access via `client.paxosTransfers`.\n */\nexport class PaxosTransfersService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * Create Paxos Transfer\n *\n * Requires scope: transfer:write_paxos_transfer\n */\n async createPaxosTransfer(request: CreatePaxosTransferRequest, opts?: RequestOptions): Promise<WithRaw<Transfer>> {\n const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };\n return this.client.post<WithRaw<Transfer>>(\"/transfer/paxos\", body, opts, {\n responseSchema: \"Transfer\",\n requestSchema: \"CreatePaxosTransferRequest\",\n replayProtected: true,\n });\n }\n}\n"]}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
|
|
2
|
+
import type { KnownPaymentStatus, KnownProduct, KnownSortOrder } from "../enums.js";
|
|
3
|
+
import type { Payment } from "../models.js";
|
|
4
|
+
export interface ListPaymentsParams {
|
|
5
|
+
/** No other parameters are allowed if ref_ids are provided */
|
|
6
|
+
ref_ids?: string[];
|
|
7
|
+
/** No other parameters are allowed if payment_ids are provided */
|
|
8
|
+
payment_ids?: string[];
|
|
9
|
+
/** Use together with product to list for a specific customer and product */
|
|
10
|
+
customer_id?: string;
|
|
11
|
+
/** Use together with product to list for a specific customer and product */
|
|
12
|
+
product?: KnownProduct | (string & {});
|
|
13
|
+
/** Optional, filter by payment status */
|
|
14
|
+
payment_status?: KnownPaymentStatus | (string & {});
|
|
15
|
+
/** Number of results to return. Defaults to 100 if no limit is provided. */
|
|
16
|
+
limit?: number;
|
|
17
|
+
/** Sort order for the results by created at, defaults to DESC if not provided. */
|
|
18
|
+
order?: KnownSortOrder | (string & {});
|
|
19
|
+
/** Resume from a cursor previously returned as a page's `nextCursor`. */
|
|
20
|
+
page_cursor?: string;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* PaymentsService — Payments represent actual transfers of rewards to the
|
|
24
|
+
* payout address associated with a given statement. Payments are made on-chain
|
|
25
|
+
* to a specified payout address. Payments tie 1:1 with a statement amount.
|
|
26
|
+
*
|
|
27
|
+
* Use the `ref_id` to link payments to statements.
|
|
28
|
+
*
|
|
29
|
+
* \> Some fields (e.g., `account_id`, `profile_id`) are populated for
|
|
30
|
+
* consistency but are not relevant to reward-specific flows.
|
|
31
|
+
*
|
|
32
|
+
* *These endpoints are only relevant for Global Dollar Network (GDN)
|
|
33
|
+
* partners.*
|
|
34
|
+
*
|
|
35
|
+
* Access via `client.payments`.
|
|
36
|
+
*/
|
|
37
|
+
export declare class PaymentsService {
|
|
38
|
+
private readonly client;
|
|
39
|
+
/**
|
|
40
|
+
* List Payments
|
|
41
|
+
*
|
|
42
|
+
* Requires scope: statements:read_payment
|
|
43
|
+
* @deprecated This API operation is deprecated.
|
|
44
|
+
*/
|
|
45
|
+
listPayments(params?: ListPaymentsParams, opts?: RequestOptions): PageIterator<WithRaw<Payment>>;
|
|
46
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
|
|
2
|
+
/**
|
|
3
|
+
* PaymentsService — Payments represent actual transfers of rewards to the
|
|
4
|
+
* payout address associated with a given statement. Payments are made on-chain
|
|
5
|
+
* to a specified payout address. Payments tie 1:1 with a statement amount.
|
|
6
|
+
*
|
|
7
|
+
* Use the `ref_id` to link payments to statements.
|
|
8
|
+
*
|
|
9
|
+
* \> Some fields (e.g., `account_id`, `profile_id`) are populated for
|
|
10
|
+
* consistency but are not relevant to reward-specific flows.
|
|
11
|
+
*
|
|
12
|
+
* *These endpoints are only relevant for Global Dollar Network (GDN)
|
|
13
|
+
* partners.*
|
|
14
|
+
*
|
|
15
|
+
* Access via `client.payments`.
|
|
16
|
+
*/
|
|
17
|
+
export class PaymentsService {
|
|
18
|
+
client;
|
|
19
|
+
/** @internal */
|
|
20
|
+
constructor(client) {
|
|
21
|
+
this.client = client;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* List Payments
|
|
25
|
+
*
|
|
26
|
+
* Requires scope: statements:read_payment
|
|
27
|
+
* @deprecated This API operation is deprecated.
|
|
28
|
+
*/
|
|
29
|
+
listPayments(params, opts) {
|
|
30
|
+
return this.client.paginate("/statements/payments", "payments", params, opts, {
|
|
31
|
+
responseSchema: "ListPaymentsResponse",
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=payments.js.map
|