@dynamic-labs/sdk-api 0.0.195 → 0.0.196

package/src/models/Gate.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GateRule } from './GateRule';
+/**
+ *
+ * @export
+ * @interface Gate
+ */
+export interface Gate {
+    /**
+     *
+     * @type {string}
+     * @memberof Gate
+     */
+    id: string;
+    /**
+     * Human-readable name of the gate. This should be something helpful to organize gates.
+     * @type {string}
+     * @memberof Gate
+     */
+    name: string;
+    /**
+     * String for the resulting scope of the gate. If the rules of the gate apply to the user being verified, then this scope will be surfaced in the JWT
+     * @type {string}
+     * @memberof Gate
+     */
+    scope: string;
+    /**
+     * If the gate is enabled, then this timestamp will be present.
+     * @type {Date}
+     * @memberof Gate
+     */
+    enabledAt?: Date | null;
+    /**
+     * The rules which will be used to evaluate users being verified. If multiple rules are present in a single gate, then all the rules need to apply for the user to gain the scope defined by the gate.
+     * @type {Array<GateRule>}
+     * @memberof Gate
+     */
+    rules: Array<GateRule>;
+}
+export declare function GateFromJSON(json: any): Gate;
+export declare function GateFromJSONTyped(json: any, ignoreDiscriminator: boolean): Gate;
+export declare function GateToJSON(value?: Gate | null): any;

package/src/models/Gate.js

@@ -0,0 +1,36 @@
+import { exists } from '../runtime.js';
+import { GateRuleFromJSON, GateRuleToJSON } from './GateRule.js';
+
+/* tslint:disable */
+function GateFromJSON(json) {
+    return GateFromJSONTyped(json);
+}
+function GateFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'scope': json['scope'],
+        'enabledAt': !exists(json, 'enabledAt') ? undefined : (json['enabledAt'] === null ? null : new Date(json['enabledAt'])),
+        'rules': (json['rules'].map(GateRuleFromJSON)),
+    };
+}
+function GateToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'scope': value.scope,
+        'enabledAt': value.enabledAt === undefined ? undefined : (value.enabledAt === null ? null : value.enabledAt.toISOString()),
+        'rules': (value.rules.map(GateRuleToJSON)),
+    };
+}
+
+export { GateFromJSON, GateFromJSONTyped, GateToJSON };

package/src/models/GateCreateRequest.cjs

@@ -0,0 +1,37 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var GateRule = require('./GateRule.cjs');
+
+/* tslint:disable */
+function GateCreateRequestFromJSON(json) {
+    return GateCreateRequestFromJSONTyped(json);
+}
+function GateCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'scope': json['scope'],
+        'rules': (json['rules'].map(GateRule.GateRuleFromJSON)),
+    };
+}
+function GateCreateRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'scope': value.scope,
+        'rules': (value.rules.map(GateRule.GateRuleToJSON)),
+    };
+}
+
+exports.GateCreateRequestFromJSON = GateCreateRequestFromJSON;
+exports.GateCreateRequestFromJSONTyped = GateCreateRequestFromJSONTyped;
+exports.GateCreateRequestToJSON = GateCreateRequestToJSON;

package/src/models/GateCreateRequest.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GateRule } from './GateRule';
+/**
+ * Request body to create a new gate. The gate will be not enabled by default.
+ * @export
+ * @interface GateCreateRequest
+ */
+export interface GateCreateRequest {
+    /**
+     * Human-readable name of the gate. This should be something helpful to organize gates.
+     * @type {string}
+     * @memberof GateCreateRequest
+     */
+    name: string;
+    /**
+     * String for the resulting scope of the gate. If the rules of the gate apply to the user being verified, then this scope will be surfaced in the JWT
+     * @type {string}
+     * @memberof GateCreateRequest
+     */
+    scope: string;
+    /**
+     * The rules which will be used to evaluate users being verified. If multiple rules are present in a single gate, then all the rules need to apply for the user to gain the scope defined by the gate.
+     * @type {Array<GateRule>}
+     * @memberof GateCreateRequest
+     */
+    rules: Array<GateRule>;
+}
+export declare function GateCreateRequestFromJSON(json: any): GateCreateRequest;
+export declare function GateCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GateCreateRequest;
+export declare function GateCreateRequestToJSON(value?: GateCreateRequest | null): any;

package/src/models/GateCreateRequest.js

@@ -0,0 +1,31 @@
+import { GateRuleFromJSON, GateRuleToJSON } from './GateRule.js';
+
+/* tslint:disable */
+function GateCreateRequestFromJSON(json) {
+    return GateCreateRequestFromJSONTyped(json);
+}
+function GateCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'scope': json['scope'],
+        'rules': (json['rules'].map(GateRuleFromJSON)),
+    };
+}
+function GateCreateRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'scope': value.scope,
+        'rules': (value.rules.map(GateRuleToJSON)),
+    };
+}
+
+export { GateCreateRequestFromJSON, GateCreateRequestFromJSONTyped, GateCreateRequestToJSON };

package/src/models/GateRule.cjs

@@ -0,0 +1,39 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+var GateRuleFilter = require('./GateRuleFilter.cjs');
+var GateRuleType = require('./GateRuleType.cjs');
+
+/* tslint:disable */
+function GateRuleFromJSON(json) {
+    return GateRuleFromJSONTyped(json);
+}
+function GateRuleFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'type': GateRuleType.GateRuleTypeFromJSON(json['type']),
+        'contractAddress': json['contractAddress'],
+        'filter': !runtime.exists(json, 'filter') ? undefined : GateRuleFilter.GateRuleFilterFromJSON(json['filter']),
+    };
+}
+function GateRuleToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': GateRuleType.GateRuleTypeToJSON(value.type),
+        'contractAddress': value.contractAddress,
+        'filter': GateRuleFilter.GateRuleFilterToJSON(value.filter),
+    };
+}
+
+exports.GateRuleFromJSON = GateRuleFromJSON;
+exports.GateRuleFromJSONTyped = GateRuleFromJSONTyped;
+exports.GateRuleToJSON = GateRuleToJSON;

package/src/models/GateRule.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GateRuleFilter } from './GateRuleFilter';
+import { GateRuleType } from './GateRuleType';
+/**
+ * Definition for a single rule in a Gate. This will check for the presence of a token or NFT, given the contract address, in the wallet of a user being evaluated. For multi-wallet users, we will check all wallets. If a filter is defined, then we will also check that the filter checks apply to the user
+ * @export
+ * @interface GateRule
+ */
+export interface GateRule {
+    /**
+     *
+     * @type {GateRuleType}
+     * @memberof GateRule
+     */
+    type: GateRuleType;
+    /**
+     * This contains the smart contract address of the token or NFT being used to evaluate users to be verified.
+     * @type {string}
+     * @memberof GateRule
+     */
+    contractAddress: string;
+    /**
+     *
+     * @type {GateRuleFilter}
+     * @memberof GateRule
+     */
+    filter?: GateRuleFilter;
+}
+export declare function GateRuleFromJSON(json: any): GateRule;
+export declare function GateRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GateRule;
+export declare function GateRuleToJSON(value?: GateRule | null): any;

package/src/models/GateRule.js

@@ -0,0 +1,33 @@
+import { exists } from '../runtime.js';
+import { GateRuleFilterFromJSON, GateRuleFilterToJSON } from './GateRuleFilter.js';
+import { GateRuleTypeFromJSON, GateRuleTypeToJSON } from './GateRuleType.js';
+
+/* tslint:disable */
+function GateRuleFromJSON(json) {
+    return GateRuleFromJSONTyped(json);
+}
+function GateRuleFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'type': GateRuleTypeFromJSON(json['type']),
+        'contractAddress': json['contractAddress'],
+        'filter': !exists(json, 'filter') ? undefined : GateRuleFilterFromJSON(json['filter']),
+    };
+}
+function GateRuleToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': GateRuleTypeToJSON(value.type),
+        'contractAddress': value.contractAddress,
+        'filter': GateRuleFilterToJSON(value.filter),
+    };
+}
+
+export { GateRuleFromJSON, GateRuleFromJSONTyped, GateRuleToJSON };

package/src/models/GateRuleFilter.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+
+/* tslint:disable */
+function GateRuleFilterFromJSON(json) {
+    return GateRuleFilterFromJSONTyped(json);
+}
+function GateRuleFilterFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'amount': !runtime.exists(json, 'amount') ? undefined : json['amount'],
+    };
+}
+function GateRuleFilterToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'amount': value.amount,
+    };
+}
+
+exports.GateRuleFilterFromJSON = GateRuleFilterFromJSON;
+exports.GateRuleFilterFromJSONTyped = GateRuleFilterFromJSONTyped;
+exports.GateRuleFilterToJSON = GateRuleFilterToJSON;

package/src/models/GateRuleFilter.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Defines the filter properties used for the gate
+ * @export
+ * @interface GateRuleFilter
+ */
+export interface GateRuleFilter {
+    /**
+     * Minimum token or NFT amount held by the user. If this `amount` field is provided, then Dynamic will also check that the user has this minimum amount held by the user of the NFT or Token
+     * @type {number}
+     * @memberof GateRuleFilter
+     */
+    amount?: number;
+}
+export declare function GateRuleFilterFromJSON(json: any): GateRuleFilter;
+export declare function GateRuleFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): GateRuleFilter;
+export declare function GateRuleFilterToJSON(value?: GateRuleFilter | null): any;

package/src/models/GateRuleFilter.js

@@ -0,0 +1,27 @@
+import { exists } from '../runtime.js';
+
+/* tslint:disable */
+function GateRuleFilterFromJSON(json) {
+    return GateRuleFilterFromJSONTyped(json);
+}
+function GateRuleFilterFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'amount': !exists(json, 'amount') ? undefined : json['amount'],
+    };
+}
+function GateRuleFilterToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'amount': value.amount,
+    };
+}
+
+export { GateRuleFilterFromJSON, GateRuleFilterFromJSONTyped, GateRuleFilterToJSON };

package/src/models/GateRuleType.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+exports.GateRuleType = void 0;
+(function (GateRuleType) {
+    GateRuleType["Nft"] = "nft";
+    GateRuleType["Token"] = "token";
+})(exports.GateRuleType || (exports.GateRuleType = {}));
+function GateRuleTypeFromJSON(json) {
+    return GateRuleTypeFromJSONTyped(json);
+}
+function GateRuleTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function GateRuleTypeToJSON(value) {
+    return value;
+}
+
+exports.GateRuleTypeFromJSON = GateRuleTypeFromJSON;
+exports.GateRuleTypeFromJSONTyped = GateRuleTypeFromJSONTyped;
+exports.GateRuleTypeToJSON = GateRuleTypeToJSON;

package/src/models/GateRuleType.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum GateRuleType {
+    Nft = "nft",
+    Token = "token"
+}
+export declare function GateRuleTypeFromJSON(json: any): GateRuleType;
+export declare function GateRuleTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GateRuleType;
+export declare function GateRuleTypeToJSON(value?: GateRuleType | null): any;

package/src/models/GateRuleType.js

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+var GateRuleType;
+(function (GateRuleType) {
+    GateRuleType["Nft"] = "nft";
+    GateRuleType["Token"] = "token";
+})(GateRuleType || (GateRuleType = {}));
+function GateRuleTypeFromJSON(json) {
+    return GateRuleTypeFromJSONTyped(json);
+}
+function GateRuleTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function GateRuleTypeToJSON(value) {
+    return value;
+}
+
+export { GateRuleType, GateRuleTypeFromJSON, GateRuleTypeFromJSONTyped, GateRuleTypeToJSON };

package/src/models/GateUpdateRequest.cjs

@@ -0,0 +1,38 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+var GateRule = require('./GateRule.cjs');
+
+/* tslint:disable */
+function GateUpdateRequestFromJSON(json) {
+    return GateUpdateRequestFromJSONTyped(json);
+}
+function GateUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !runtime.exists(json, 'name') ? undefined : json['name'],
+        'scope': !runtime.exists(json, 'scope') ? undefined : json['scope'],
+        'rules': !runtime.exists(json, 'rules') ? undefined : (json['rules'].map(GateRule.GateRuleFromJSON)),
+    };
+}
+function GateUpdateRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'scope': value.scope,
+        'rules': value.rules === undefined ? undefined : (value.rules.map(GateRule.GateRuleToJSON)),
+    };
+}
+
+exports.GateUpdateRequestFromJSON = GateUpdateRequestFromJSON;
+exports.GateUpdateRequestFromJSONTyped = GateUpdateRequestFromJSONTyped;
+exports.GateUpdateRequestToJSON = GateUpdateRequestToJSON;

package/src/models/GateUpdateRequest.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { GateRule } from './GateRule';
+/**
+ * Request body to update an existing gate. This will not affect whether a gate is enabled or not.
+ * @export
+ * @interface GateUpdateRequest
+ */
+export interface GateUpdateRequest {
+    /**
+     * Human-readable name of the gate. This should be something helpful to organize gates.
+     * @type {string}
+     * @memberof GateUpdateRequest
+     */
+    name?: string;
+    /**
+     * String for the resulting scope of the gate. If the rules of the gate apply to the user being verified, then this scope will be surfaced in the JWT
+     * @type {string}
+     * @memberof GateUpdateRequest
+     */
+    scope?: string;
+    /**
+     * The rules which will be used to evaluate users being verified. If multiple rules are present in a single gate, then all the rules need to apply for the user to gain the scope defined by the gate.
+     * @type {Array<GateRule>}
+     * @memberof GateUpdateRequest
+     */
+    rules?: Array<GateRule>;
+}
+export declare function GateUpdateRequestFromJSON(json: any): GateUpdateRequest;
+export declare function GateUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GateUpdateRequest;
+export declare function GateUpdateRequestToJSON(value?: GateUpdateRequest | null): any;

package/src/models/GateUpdateRequest.js

@@ -0,0 +1,32 @@
+import { exists } from '../runtime.js';
+import { GateRuleFromJSON, GateRuleToJSON } from './GateRule.js';
+
+/* tslint:disable */
+function GateUpdateRequestFromJSON(json) {
+    return GateUpdateRequestFromJSONTyped(json);
+}
+function GateUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'scope': !exists(json, 'scope') ? undefined : json['scope'],
+        'rules': !exists(json, 'rules') ? undefined : (json['rules'].map(GateRuleFromJSON)),
+    };
+}
+function GateUpdateRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'scope': value.scope,
+        'rules': value.rules === undefined ? undefined : (value.rules.map(GateRuleToJSON)),
+    };
+}
+
+export { GateUpdateRequestFromJSON, GateUpdateRequestFromJSONTyped, GateUpdateRequestToJSON };

package/src/models/GatesResponse.cjs

@@ -0,0 +1,34 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+var Gate = require('./Gate.cjs');
+
+/* tslint:disable */
+function GatesResponseFromJSON(json) {
+    return GatesResponseFromJSONTyped(json);
+}
+function GatesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'providers': !runtime.exists(json, 'providers') ? undefined : (json['providers'].map(Gate.GateFromJSON)),
+    };
+}
+function GatesResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'providers': value.providers === undefined ? undefined : (value.providers.map(Gate.GateToJSON)),
+    };
+}
+
+exports.GatesResponseFromJSON = GatesResponseFromJSON;
+exports.GatesResponseFromJSONTyped = GatesResponseFromJSONTyped;
+exports.GatesResponseToJSON = GatesResponseToJSON;

package/src/models/GatesResponse.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Gate } from './Gate';
+/**
+ *
+ * @export
+ * @interface GatesResponse
+ */
+export interface GatesResponse {
+    /**
+     *
+     * @type {Array<Gate>}
+     * @memberof GatesResponse
+     */
+    providers?: Array<Gate>;
+}
+export declare function GatesResponseFromJSON(json: any): GatesResponse;
+export declare function GatesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GatesResponse;
+export declare function GatesResponseToJSON(value?: GatesResponse | null): any;