@hirosystems/token-metadata-api-client 1.0.0

package/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+3.0.41

package/.swagger-codegen-ignore

@@ -0,0 +1,24 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+package.json

package/README.md

@@ -0,0 +1,45 @@
+## @hirosystems/token-metadata-api-client@1.0.0
+
+This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+
+Environment
+* Node.js
+* Webpack
+* Browserify
+
+Language level
+* ES5 - you must have a Promises/A+ library installed
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
+
+### Building
+
+To build an compile the typescript sources to javascript use:
+```
+npm install
+npm run build
+```
+
+### Publishing
+
+First build the package then run ```npm publish```
+
+### Consuming
+
+navigate to the folder of your consuming project and run one of the following commands.
+
+_published:_
+
+```
+npm install @hirosystems/token-metadata-api-client@1.0.0 --save
+```
+
+_unPublished (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE --save

package/api.ts

@@ -0,0 +1,842 @@
+/// <reference path="./custom.d.ts" />
+// tslint:disable
+/**
+ * Token Metadata API
+ * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
+ *
+ * OpenAPI spec version: v0.1.0
+ * 
+ *
+ * NOTE: This file is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the file manually.
+ */
+
+import * as url from "url";
+import * as isomorphicFetch from "isomorphic-fetch";
+import { Configuration } from "./configuration";
+
+const BASE_PATH = "https://api.hiro.so/".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface FetchAPI
+ */
+export interface FetchAPI {
+    (url: string, init?: any): Promise<Response>;
+}
+
+/**
+ *
+ * @export
+ * @interface FetchArgs
+ */
+export interface FetchArgs {
+    url: string;
+    options: any;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected fetch: FetchAPI = isomorphicFetch) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    name: "RequiredError"
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}
+
+/**
+ * 
+ * @export
+ * @interface ApiJobCount
+ */
+export interface ApiJobCount {
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiJobCount
+     */
+    pending?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiJobCount
+     */
+    queued?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiJobCount
+     */
+    done?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiJobCount
+     */
+    failed?: number;
+}
+/**
+ * 
+ * @export
+ * @interface ApiStatusResponse
+ */
+export interface ApiStatusResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiStatusResponse
+     */
+    serverVersion: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiStatusResponse
+     */
+    status: string;
+    /**
+     * 
+     * @type {ApiTokenCount}
+     * @memberof ApiStatusResponse
+     */
+    tokens?: ApiTokenCount;
+    /**
+     * 
+     * @type {ApiTokenContractCount}
+     * @memberof ApiStatusResponse
+     */
+    tokenContracts?: ApiTokenContractCount;
+    /**
+     * 
+     * @type {ApiJobCount}
+     * @memberof ApiStatusResponse
+     */
+    jobQueue?: ApiJobCount;
+}
+/**
+ * 
+ * @export
+ * @interface ApiTokenContractCount
+ */
+export interface ApiTokenContractCount {
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiTokenContractCount
+     */
+    sip009?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiTokenContractCount
+     */
+    sip010?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiTokenContractCount
+     */
+    sip013?: number;
+}
+/**
+ * 
+ * @export
+ * @interface ApiTokenCount
+ */
+export interface ApiTokenCount {
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiTokenCount
+     */
+    ft?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiTokenCount
+     */
+    nft?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ApiTokenCount
+     */
+    sft?: number;
+}
+/**
+ * 
+ * @export
+ * @interface FtMetadataResponse
+ */
+export interface FtMetadataResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    symbol?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof FtMetadataResponse
+     */
+    decimals?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    totalSupply?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    tokenUri?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    imageUri?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    imageCanonicalUri?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    txId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    senderAddress: string;
+    /**
+     * 
+     * @type {Metadata}
+     * @memberof FtMetadataResponse
+     */
+    metadata?: Metadata;
+}
+/**
+ * 
+ * @export
+ * @interface Metadata
+ */
+export interface Metadata {
+    /**
+     * 
+     * @type {number}
+     * @memberof Metadata
+     */
+    sip: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Metadata
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Metadata
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Metadata
+     */
+    image?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Metadata
+     */
+    cachedImage?: string;
+    /**
+     * 
+     * @type {Array<MetadataAttribute>}
+     * @memberof Metadata
+     */
+    attributes?: Array<MetadataAttribute>;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof Metadata
+     */
+    properties?: { [key: string]: any; };
+    /**
+     * 
+     * @type {MetadataLocalization}
+     * @memberof Metadata
+     */
+    localization?: MetadataLocalization;
+}
+/**
+ * 
+ * @export
+ * @interface MetadataAttribute
+ */
+export interface MetadataAttribute {
+    /**
+     * 
+     * @type {string}
+     * @memberof MetadataAttribute
+     */
+    traitType: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetadataAttribute
+     */
+    displayType?: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof MetadataAttribute
+     */
+    value: any;
+}
+/**
+ * 
+ * @export
+ * @interface MetadataLocalization
+ */
+export interface MetadataLocalization {
+    /**
+     * 
+     * @type {string}
+     * @memberof MetadataLocalization
+     */
+    uri: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MetadataLocalization
+     */
+    _default: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof MetadataLocalization
+     */
+    locales: Array<string>;
+}
+/**
+ * 
+ * @export
+ * @interface NftMetadataResponse
+ */
+export interface NftMetadataResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof NftMetadataResponse
+     */
+    tokenUri?: string;
+    /**
+     * 
+     * @type {Metadata}
+     * @memberof NftMetadataResponse
+     */
+    metadata?: Metadata;
+}
+/**
+ * 
+ * @export
+ * @interface SftMetadataResponse
+ */
+export interface SftMetadataResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof SftMetadataResponse
+     */
+    tokenUri?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SftMetadataResponse
+     */
+    decimals?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SftMetadataResponse
+     */
+    totalSupply?: string;
+    /**
+     * 
+     * @type {Metadata}
+     * @memberof SftMetadataResponse
+     */
+    metadata?: Metadata;
+}
+/**
+ * 
+ * @export
+ * @interface TokenErrorResponse
+ */
+export interface TokenErrorResponse {
+}
+/**
+ * 
+ * @export
+ * @interface TokenNotFoundResponse
+ */
+export interface TokenNotFoundResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof TokenNotFoundResponse
+     */
+    error: TokenNotFoundResponse.ErrorEnum;
+}
+
+/**
+ * @export
+ * @namespace TokenNotFoundResponse
+ */
+export namespace TokenNotFoundResponse {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum ErrorEnum {
+        TokenNotFound = <any> 'Token not found'
+    }
+}
+/**
+ * StatusApi - fetch parameter creator
+ * @export
+ */
+export const StatusApiFetchParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Displays the status of the API and its current workload
+         * @summary API Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getApiStatus(options: any = {}): FetchArgs {
+            const localVarPath = `/metadata/v1/`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * StatusApi - functional programming interface
+ * @export
+ */
+export const StatusApiFp = function(configuration?: Configuration) {
+    return {
+        /**
+         * Displays the status of the API and its current workload
+         * @summary API Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getApiStatus(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ApiStatusResponse> {
+            const localVarFetchArgs = StatusApiFetchParamCreator(configuration).getApiStatus(options);
+            return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
+    }
+};
+
+/**
+ * StatusApi - factory interface
+ * @export
+ */
+export const StatusApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
+    return {
+        /**
+         * Displays the status of the API and its current workload
+         * @summary API Status
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getApiStatus(options?: any) {
+            return StatusApiFp(configuration).getApiStatus(options)(fetch, basePath);
+        },
+    };
+};
+
+/**
+ * StatusApi - object-oriented interface
+ * @export
+ * @class StatusApi
+ * @extends {BaseAPI}
+ */
+export class StatusApi extends BaseAPI {
+    /**
+     * Displays the status of the API and its current workload
+     * @summary API Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StatusApi
+     */
+    public getApiStatus(options?: any) {
+        return StatusApiFp(this.configuration).getApiStatus(options)(this.fetch, this.basePath);
+    }
+
+}
+/**
+ * TokensApi - fetch parameter creator
+ * @export
+ */
+export const TokensApiFetchParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves metadata for a SIP-010 Fungible Token
+         * @summary Fungible Token Metadata
+         * @param {string} principal Principal for the contract which owns the SIP-010 token
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFtMetadata(principal: string, locale?: string, options: any = {}): FetchArgs {
+            // verify required parameter 'principal' is not null or undefined
+            if (principal === null || principal === undefined) {
+                throw new RequiredError('principal','Required parameter principal was null or undefined when calling getFtMetadata.');
+            }
+            const localVarPath = `/metadata/v1/ft/{principal}`
+                .replace(`{${"principal"}}`, encodeURIComponent(String(principal)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (locale !== undefined) {
+                localVarQueryParameter['locale'] = locale;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves metadata for a SIP-009 Non-Fungible Token
+         * @summary Non-Fungible Token Metadata
+         * @param {string} principal SIP-009 compliant smart contract principal
+         * @param {number} tokenId Token ID to retrieve
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNftMetadata(principal: string, tokenId: number, locale?: string, options: any = {}): FetchArgs {
+            // verify required parameter 'principal' is not null or undefined
+            if (principal === null || principal === undefined) {
+                throw new RequiredError('principal','Required parameter principal was null or undefined when calling getNftMetadata.');
+            }
+            // verify required parameter 'tokenId' is not null or undefined
+            if (tokenId === null || tokenId === undefined) {
+                throw new RequiredError('tokenId','Required parameter tokenId was null or undefined when calling getNftMetadata.');
+            }
+            const localVarPath = `/metadata/v1/nft/{principal}/{token_id}`
+                .replace(`{${"principal"}}`, encodeURIComponent(String(principal)))
+                .replace(`{${"token_id"}}`, encodeURIComponent(String(tokenId)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (locale !== undefined) {
+                localVarQueryParameter['locale'] = locale;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves metadata for a SIP-013 Semi-Fungible Token
+         * @summary Semi-Fungible Token Metadata
+         * @param {string} principal SIP-013 compliant smart contract principal
+         * @param {number} tokenId Token ID to retrieve
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSftMetadata(principal: string, tokenId: number, locale?: string, options: any = {}): FetchArgs {
+            // verify required parameter 'principal' is not null or undefined
+            if (principal === null || principal === undefined) {
+                throw new RequiredError('principal','Required parameter principal was null or undefined when calling getSftMetadata.');
+            }
+            // verify required parameter 'tokenId' is not null or undefined
+            if (tokenId === null || tokenId === undefined) {
+                throw new RequiredError('tokenId','Required parameter tokenId was null or undefined when calling getSftMetadata.');
+            }
+            const localVarPath = `/metadata/v1/sft/{principal}/{token_id}`
+                .replace(`{${"principal"}}`, encodeURIComponent(String(principal)))
+                .replace(`{${"token_id"}}`, encodeURIComponent(String(tokenId)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (locale !== undefined) {
+                localVarQueryParameter['locale'] = locale;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * TokensApi - functional programming interface
+ * @export
+ */
+export const TokensApiFp = function(configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves metadata for a SIP-010 Fungible Token
+         * @summary Fungible Token Metadata
+         * @param {string} principal Principal for the contract which owns the SIP-010 token
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFtMetadata(principal: string, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FtMetadataResponse> {
+            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getFtMetadata(principal, locale, options);
+            return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
+        /**
+         * Retrieves metadata for a SIP-009 Non-Fungible Token
+         * @summary Non-Fungible Token Metadata
+         * @param {string} principal SIP-009 compliant smart contract principal
+         * @param {number} tokenId Token ID to retrieve
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNftMetadata(principal: string, tokenId: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<NftMetadataResponse> {
+            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getNftMetadata(principal, tokenId, locale, options);
+            return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
+        /**
+         * Retrieves metadata for a SIP-013 Semi-Fungible Token
+         * @summary Semi-Fungible Token Metadata
+         * @param {string} principal SIP-013 compliant smart contract principal
+         * @param {number} tokenId Token ID to retrieve
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSftMetadata(principal: string, tokenId: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<SftMetadataResponse> {
+            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getSftMetadata(principal, tokenId, locale, options);
+            return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
+    }
+};
+
+/**
+ * TokensApi - factory interface
+ * @export
+ */
+export const TokensApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
+    return {
+        /**
+         * Retrieves metadata for a SIP-010 Fungible Token
+         * @summary Fungible Token Metadata
+         * @param {string} principal Principal for the contract which owns the SIP-010 token
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFtMetadata(principal: string, locale?: string, options?: any) {
+            return TokensApiFp(configuration).getFtMetadata(principal, locale, options)(fetch, basePath);
+        },
+        /**
+         * Retrieves metadata for a SIP-009 Non-Fungible Token
+         * @summary Non-Fungible Token Metadata
+         * @param {string} principal SIP-009 compliant smart contract principal
+         * @param {number} tokenId Token ID to retrieve
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNftMetadata(principal: string, tokenId: number, locale?: string, options?: any) {
+            return TokensApiFp(configuration).getNftMetadata(principal, tokenId, locale, options)(fetch, basePath);
+        },
+        /**
+         * Retrieves metadata for a SIP-013 Semi-Fungible Token
+         * @summary Semi-Fungible Token Metadata
+         * @param {string} principal SIP-013 compliant smart contract principal
+         * @param {number} tokenId Token ID to retrieve
+         * @param {string} [locale] Metadata localization to retrieve
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSftMetadata(principal: string, tokenId: number, locale?: string, options?: any) {
+            return TokensApiFp(configuration).getSftMetadata(principal, tokenId, locale, options)(fetch, basePath);
+        },
+    };
+};
+
+/**
+ * TokensApi - object-oriented interface
+ * @export
+ * @class TokensApi
+ * @extends {BaseAPI}
+ */
+export class TokensApi extends BaseAPI {
+    /**
+     * Retrieves metadata for a SIP-010 Fungible Token
+     * @summary Fungible Token Metadata
+     * @param {string} principal Principal for the contract which owns the SIP-010 token
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    public getFtMetadata(principal: string, locale?: string, options?: any) {
+        return TokensApiFp(this.configuration).getFtMetadata(principal, locale, options)(this.fetch, this.basePath);
+    }
+
+    /**
+     * Retrieves metadata for a SIP-009 Non-Fungible Token
+     * @summary Non-Fungible Token Metadata
+     * @param {string} principal SIP-009 compliant smart contract principal
+     * @param {number} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    public getNftMetadata(principal: string, tokenId: number, locale?: string, options?: any) {
+        return TokensApiFp(this.configuration).getNftMetadata(principal, tokenId, locale, options)(this.fetch, this.basePath);
+    }
+
+    /**
+     * Retrieves metadata for a SIP-013 Semi-Fungible Token
+     * @summary Semi-Fungible Token Metadata
+     * @param {string} principal SIP-013 compliant smart contract principal
+     * @param {number} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    public getSftMetadata(principal: string, tokenId: number, locale?: string, options?: any) {
+        return TokensApiFp(this.configuration).getSftMetadata(principal, tokenId, locale, options)(this.fetch, this.basePath);
+    }
+
+}

package/api_test.spec.ts

@@ -0,0 +1,53 @@
+/**
+ * Token Metadata API
+ * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
+ *
+ * OpenAPI spec version: v0.1.0
+ * 
+ *
+ * NOTE: This file is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the file manually.
+ */
+
+import * as api from "./api"
+import { Configuration } from "./configuration"
+
+const config: Configuration = {}
+
+describe("StatusApi", () => {
+  let instance: api.StatusApi
+  beforeEach(function() {
+    instance = new api.StatusApi(config)
+  });
+
+  test("getApiStatus", () => {
+    return expect(instance.getApiStatus({})).resolves.toBe(null)
+  })
+})
+
+describe("TokensApi", () => {
+  let instance: api.TokensApi
+  beforeEach(function() {
+    instance = new api.TokensApi(config)
+  });
+
+  test("getFtMetadata", () => {
+    const principal: string = "principal_example"
+    const locale: string = "locale_example"
+    return expect(instance.getFtMetadata(principal, locale, {})).resolves.toBe(null)
+  })
+  test("getNftMetadata", () => {
+    const principal: string = "principal_example"
+    const tokenId: number = 56
+    const locale: string = "locale_example"
+    return expect(instance.getNftMetadata(principal, tokenId, locale, {})).resolves.toBe(null)
+  })
+  test("getSftMetadata", () => {
+    const principal: string = "principal_example"
+    const tokenId: number = 56
+    const locale: string = "locale_example"
+    return expect(instance.getSftMetadata(principal, tokenId, locale, {})).resolves.toBe(null)
+  })
+})
+

package/configuration.ts

@@ -0,0 +1,65 @@
+// tslint:disable
+/**
+ * Token Metadata API
+ * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
+ *
+ * OpenAPI spec version: v0.1.0
+ * 
+ *
+ * NOTE: This file is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the file manually.
+ */
+
+export interface ConfigurationParameters {
+    apiKey?: string | ((name: string) => string);
+    username?: string;
+    password?: string;
+    accessToken?: string | ((name: string, scopes?: string[]) => string);
+    basePath?: string;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | ((name: string) => string);
+    /**
+     * parameter for basic security
+     * 
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     * 
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | ((name: string, scopes?: string[]) => string);
+    /**
+     * override base path
+     * 
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+    }
+}

package/custom.d.ts

@@ -0,0 +1,2 @@
+declare module 'isomorphic-fetch';
+declare module 'url';

package/git_push.sh

@@ -0,0 +1,51 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository. 
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,15 @@
+// tslint:disable
+/**
+ * Token Metadata API
+ * Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
+ *
+ * OpenAPI spec version: v0.1.0
+ * 
+ *
+ * NOTE: This file is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the file manually.
+ */
+
+export * from "./api";
+export * from "./configuration";

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@hirosystems/token-metadata-api-client",
+  "version": "1.0.0",
+  "description": "Client for @hirosystems/token-metadata-api",
+  "author": "Hiro Systems PBC <engineering@hiro.so> (https://hiro.so)",
+  "keywords": [
+    "fetch",
+    "typescript",
+    "swagger-client",
+    "@hirosystems/token-metadata-api-client"
+  ],
+  "license": "GPL-3.0",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "scripts" : {
+    "build": "tsc --outDir dist/",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "isomorphic-fetch": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.2.1",
+    "@types/node": "^13.13.0",
+    "@types/babel__core": "7.1.18",
+    "@types/babel__traverse": "7.14.2",
+    "jest": "^25.4.0",
+    "ts-jest": "^25.4.0",
+    "typescript": "^3.8.3"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+  }}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "es5",
+    "module": "commonjs",
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "lib": [
+      "es6",
+      "dom"
+    ]
+  },
+  "exclude": [
+    "dist",
+    "node_modules",
+    "**/*.spec.ts"
+  ]
+}