cantonjs-splice-validator 0.3.0

package/dist/generated/scanProxy.types.d.ts

@@ -0,0 +1,836 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/v0/scan-proxy/dso-party-id": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getDsoPartyId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/dso": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getDsoInfo"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/featured-apps/{provider_party_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["lookupFeaturedAppRight"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/open-and-issuing-mining-rounds": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getOpenAndIssuingMiningRounds"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/amulet-rules": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getAmuletRules"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/ans-entries/by-party/{party}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["lookupAnsEntryByParty"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/ans-entries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["listAnsEntries"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/ans-entries/by-name/{name}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["lookupAnsEntryByName"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/ans-rules": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["getAnsRules"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/transfer-preapprovals/by-party/{party}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["lookupTransferPreapprovalByParty"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/transfer-command-counter/{party}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["lookupTransferCommandCounterByParty"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/transfer-command/status": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Retrieve the status of all transfer commands of the given sender for the specified nonce. */
+        get: operations["lookupTransferCommandStatus"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/holdings/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Returns the summary of active amulet contracts for a given migration id and record time, for the given parties.
+         *     This is an aggregate of `/v0/holdings/state` by owner party ID with better performance than client-side computation.
+         */
+        post: operations["getHoldingsSummaryAt"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v0/scan-proxy/unclaimed-development-fund-coupons": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description List all unclaimed development fund coupons. */
+        get: operations["listUnclaimedDevelopmentFundCoupons"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        GetOpenAndIssuingMiningRoundsProxyResponse: {
+            open_mining_rounds: components["schemas"]["ContractWithState"][];
+            issuing_mining_rounds: components["schemas"]["ContractWithState"][];
+        };
+        GetAmuletRulesProxyResponse: {
+            amulet_rules: components["schemas"]["ContractWithState"];
+        };
+        GetDsoPartyIdResponse: {
+            dso_party_id: string;
+        };
+        GetDsoInfoResponse: {
+            [key: string]: unknown;
+        };
+        ContractId: string;
+        Contract: {
+            contract_id?: components["schemas"]["ContractId"];
+            template_id?: string;
+            package_name?: string;
+            payload?: {
+                [key: string]: unknown;
+            };
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description If defined, a contract of Daml template `Splice.Amulet.FeaturedAppRight`. */
+        LookupFeaturedAppRightResponse: {
+            featured_app_right?: components["schemas"]["Contract"];
+        };
+        ContractWithState: {
+            contract?: components["schemas"]["Contract"];
+            state?: string;
+            domain_id?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        AnsEntry: {
+            /**
+             * @description If present, Daml contract ID of template `Splice.Ans:AnsEntry`.
+             *     If absent, this is a DSO-provided entry for either the DSO or an SV.
+             */
+            contract_id?: string;
+            /** @description Owner party ID of this ANS entry. */
+            user: string;
+            /** @description The ANS entry name. */
+            name: string;
+            /** @description Either empty, or an http/https URL supplied by the `user`. */
+            url: string;
+            /** @description Arbitrary description text supplied by `user`; may be empty. */
+            description: string;
+            /**
+             * Format: date-time
+             * @description Time after which this ANS entry expires; if renewed, it will have a
+             *     new `contract_id` and `expires_at`.
+             *     If `null` or absent, does not expire; this is the case only for
+             *     special entries provided by the DSO.
+             */
+            expires_at?: string;
+        };
+        LookupEntryByPartyResponse: {
+            entry: components["schemas"]["AnsEntry"];
+        };
+        ErrorResponse: {
+            error?: string;
+            message?: string;
+            details?: {
+                [key: string]: unknown;
+            };
+        } & {
+            [key: string]: unknown;
+        };
+        ListEntriesResponse: {
+            entries: components["schemas"]["AnsEntry"][];
+        };
+        LookupEntryByNameResponse: {
+            entry: components["schemas"]["AnsEntry"];
+        };
+        GetAnsRulesRequest: {
+            cached_ans_rules_contract_id?: components["schemas"]["ContractId"];
+            cached_ans_rules_domain_id?: string;
+        };
+        MaybeCachedContractWithState: {
+            contract_id?: components["schemas"]["ContractId"];
+            contract?: components["schemas"]["ContractWithState"];
+            cached?: boolean;
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description A contract state update of Daml template `Splice.Ans.AnsRules`. */
+        GetAnsRulesResponse: {
+            ans_rules_update: components["schemas"]["MaybeCachedContractWithState"];
+        };
+        /** @description A Daml contract of template `Splice.AmuletRules:TransferPreapproval`. */
+        LookupTransferPreapprovalByPartyResponse: {
+            transfer_preapproval: components["schemas"]["ContractWithState"];
+        };
+        /** @description A Daml contract of template `Splice.ExternalPartyAmuletRules:TransferCommandCounter`. */
+        LookupTransferCommandCounterByPartyResponse: {
+            transfer_command_counter: components["schemas"]["ContractWithState"];
+        };
+        BaseLookupTransferCommandStatusResponse: {
+            /**
+             * @description The status of the transfer command.
+             *     created:
+             *       The transfer command has been created and is waiting for automation to complete it.
+             *     sent:
+             *       The transfer command has been completed and the transfer to the receiver has finished.
+             *     failed:
+             *       The transfer command has failed permanently and nothing has been transferred. Refer to
+             *       failure_reason for details. A new transfer command can be created.
+             */
+            status: string;
+        };
+        TransferCommandCreatedResponse: components["schemas"]["BaseLookupTransferCommandStatusResponse"] & {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            status: "created";
+        };
+        TransferCommandSentResponse: components["schemas"]["BaseLookupTransferCommandStatusResponse"] & {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            status: "sent";
+        };
+        TransferCommandFailedResponse: components["schemas"]["BaseLookupTransferCommandStatusResponse"] & {
+            /**
+             * @description The reason for the failure of the TransferCommand.
+             *     failed:
+             *       Completing the transfer failed, check the reason for details.
+             *     withdrawn:
+             *       The sender has withdrawn the TransferCommand before it could be completed.
+             *     expired:
+             *       The expiry time on the TransferCommand was reached before it could be completed.
+             * @enum {string}
+             */
+            failure_kind: "failed" | "expired" | "withdrawn";
+            /** @description Human readable description of the failure */
+            reason: string;
+        } & {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            status: "failed";
+        };
+        TransferCommandContractStatus: components["schemas"]["TransferCommandCreatedResponse"] | components["schemas"]["TransferCommandSentResponse"] | components["schemas"]["TransferCommandFailedResponse"];
+        /**
+         * @description A contract of Daml template `Splice.ExternalPartyAmuletRules:TransferCommand`,
+         *     and its status determined by the latest transactions.
+         */
+        TransferCommandContractWithStatus: {
+            contract: components["schemas"]["Contract"];
+            status: components["schemas"]["TransferCommandContractStatus"];
+        };
+        TransferCommandMap: {
+            [key: string]: components["schemas"]["TransferCommandContractWithStatus"];
+        };
+        LookupTransferCommandStatusResponse: {
+            transfer_commands_by_contract_id: components["schemas"]["TransferCommandMap"];
+        };
+        HoldingsSummaryRequest: {
+            /**
+             * Format: int64
+             * @description The migration id for which to return the summary.
+             */
+            migration_id: number;
+            /**
+             * Format: date-time
+             * @description The timestamp at which the contract set was active.
+             *     This needs to be an exact timestamp, i.e.,
+             *     needs to correspond to a timestamp reported by `/v0/state/acs/snapshot-timestamp` if `record_time_match` is set to `exact` (which is the default).
+             *     If `record_time_match` is set to `at_or_before`, this can be any timestamp, and the most recent snapshot at or before the given `record_time` will be returned.
+             */
+            record_time: string;
+            /**
+             * @description How to match the record_time. "exact" requires the record_time to match exactly.
+             *     "at_or_before" finds the most recent snapshot at or before the given record_time.
+             * @default exact
+             * @enum {string}
+             */
+            record_time_match: "exact" | "at_or_before";
+            /** @description The owners for which to compute the summary. */
+            owner_party_ids: string[];
+            /**
+             * Format: int64
+             * @description Compute holding fees as of this round. Defaults to the earliest open mining round.
+             */
+            as_of_round?: number;
+        };
+        /** @description Aggregate Amulet totals for a particular owner party ID. */
+        HoldingsSummary: {
+            /** @description Owner party ID of the amulet. Guaranteed to be unique among `summaries`. */
+            party_id: string;
+            /**
+             * @description Sum of unlocked amulet at time of reception, not counting holding
+             *     fees deducted since.
+             */
+            total_unlocked_coin: string;
+            /**
+             * @description Sum of locked amulet at time of original amulet reception, not
+             *     counting holding fees deducted since.
+             */
+            total_locked_coin: string;
+            /** @description `total_unlocked_coin` + `total_locked_coin`. */
+            total_coin_holdings: string;
+            /**
+             * @description Sum of holding fees as of `computed_as_of_round` that apply to
+             *     unlocked amulet.
+             */
+            accumulated_holding_fees_unlocked: string;
+            /**
+             * @description Sum of holding fees as of `computed_as_of_round` that apply to
+             *     locked amulet, including fees applied since the amulet's creation
+             *     round.
+             */
+            accumulated_holding_fees_locked: string;
+            /** @description Same as `accumulated_holding_fees_unlocked` + `accumulated_holding_fees_locked`. */
+            accumulated_holding_fees_total: string;
+            /** @description Same as `total_unlocked_coin` - `accumulated_holding_fees_unlocked`. */
+            total_available_coin: string;
+        };
+        HoldingsSummaryResponse: {
+            /**
+             * Format: date-time
+             * @description The same `record_time` as in the request.
+             */
+            record_time: string;
+            /**
+             * Format: int64
+             * @description The same `migration_id` as in the request.
+             */
+            migration_id: number;
+            /**
+             * Format: int64
+             * @description The same `as_of_round` as in the request, with the same default.
+             */
+            computed_as_of_round: number;
+            summaries: components["schemas"]["HoldingsSummary"][];
+        };
+        ListUnclaimedDevelopmentFundCouponsResponse: {
+            /** @description Contracts of the Daml template `Splice.Amulet:UnclaimedDevelopmentFundCoupon`. */
+            "unclaimed-development-fund-coupons": components["schemas"]["ContractWithState"][];
+        };
+    };
+    responses: {
+        /** @description bad request */
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description not found */
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description internal server error */
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["ErrorResponse"];
+            };
+        };
+    };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getDsoPartyId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetDsoPartyIdResponse"];
+                };
+            };
+        };
+    };
+    getDsoInfo: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetDsoInfoResponse"];
+                };
+            };
+        };
+    };
+    lookupFeaturedAppRight: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                provider_party_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupFeaturedAppRightResponse"];
+                };
+            };
+        };
+    };
+    getOpenAndIssuingMiningRounds: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetOpenAndIssuingMiningRoundsProxyResponse"];
+                };
+            };
+        };
+    };
+    getAmuletRules: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetAmuletRulesProxyResponse"];
+                };
+            };
+        };
+    };
+    lookupAnsEntryByParty: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                party: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupEntryByPartyResponse"];
+                };
+            };
+            404: components["responses"]["404"];
+        };
+    };
+    listAnsEntries: {
+        parameters: {
+            query: {
+                name_prefix?: string;
+                page_size: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListEntriesResponse"];
+                };
+            };
+        };
+    };
+    lookupAnsEntryByName: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                name: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupEntryByNameResponse"];
+                };
+            };
+            404: components["responses"]["404"];
+        };
+    };
+    getAnsRules: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["GetAnsRulesRequest"];
+            };
+        };
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetAnsRulesResponse"];
+                };
+            };
+        };
+    };
+    lookupTransferPreapprovalByParty: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                party: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupTransferPreapprovalByPartyResponse"];
+                };
+            };
+            404: components["responses"]["404"];
+        };
+    };
+    lookupTransferCommandCounterByParty: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                party: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupTransferCommandCounterByPartyResponse"];
+                };
+            };
+            /** @description No TransferCommandCounter exists for this party. This means the nonce that should be used is 0. */
+            404: components["responses"]["404"];
+        };
+    };
+    lookupTransferCommandStatus: {
+        parameters: {
+            query: {
+                sender: string;
+                nonce: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LookupTransferCommandStatusResponse"];
+                };
+            };
+            /** @description No TransferCommand exists with this contract id within the last 24h */
+            404: components["responses"]["404"];
+        };
+    };
+    getHoldingsSummaryAt: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["HoldingsSummaryRequest"];
+            };
+        };
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HoldingsSummaryResponse"];
+                };
+            };
+            400: components["responses"]["400"];
+            404: components["responses"]["404"];
+            500: components["responses"]["500"];
+        };
+    };
+    listUnclaimedDevelopmentFundCoupons: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ok */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListUnclaimedDevelopmentFundCouponsResponse"];
+                };
+            };
+        };
+    };
+}