Socket
Socket
Sign inDemoInstall

@shapediver/api.platform-api-dto-v1

Package Overview
Dependencies
Maintainers
5
Versions
74
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@shapediver/api.platform-api-dto-v1 - npm Package Compare versions

Comparing version 2.12.9 to 2.12.11

128

dist/commons/SdPlatformApiTokenScopes.d.ts
/**
* Scopes for limiting Platform API tokens
* Scopes which can be used for limiting API tokens {@link SdPlatformResponseApiToken}.
*/
export declare enum SdPlatformApiTokenScopes {
/**
* Models readonly.
*/
ModelsRead = "models-read",
/**
* Models read-write.
*/
ModelsWrite = "models-write",
/**
* Models full.
*/
ModelsFull = "models-full",
/**
* Bookmarks full.
*/
BookmarksFull = "bookmarks-full",
/**
* Images readonly.
*/
ImagesRead = "images-read",
/**
* Images read-write.
*/
ImagesWrite = "images-write",
/**
* Images full.
*/
ImagesFull = "images-full",
/**
* Geometry backend tokens.
*/
Tokens = "tokens",
/**
* Tags readonly.
*/
TagsRead = "tags-read",
/**
* Tags read-write.
*/
TagsWrite = "tags-write",
/**
* Users readonly.
*/
UsersRead = "users-read",
/**
* Users read-write.
*/
UsersWrite = "users-write",
/**
* Users full.
*/
UsersFull = "users-full",
/**
* User model sessions read.
*/
UserModelSessionsRead = "user-model-sessions-read",
/**
* Organization model sessions read.
*/
OrganizationModelSessionsRead = "organization-model-sessions-read",
/**
* Model sharing readonly.
*/
ModelSharingRead = "model-sharing-read",
/**
* Model sharing read-write.
*/
ModelSharingWrite = "model-sharing-write",
/**
* Model sharing full.
*/
ModelSharingFull = "model-sharing-full",
/**
* Saved states readonly.
*/
SavedStatesRead = "saved-states-read",
/**
* Saved states read-write.
*/
SavedStatesWrite = "saved-states-write",
/**
* Saved states full.
*/
SavedStatesFull = "saved-states-full",
/**
* Saved state sharing readonly.
*/
SavedStateSharingRead = "saved-state-sharing-read",
/**
* Saved state sharing read-write.
*/
SavedStateSharingWrite = "saved-state-sharing-write",
/**
* Saved state sharing full.
*/
SavedStateSharingFull = "saved-state-sharing-full",
/**
* Actions full.
*/
ActionsFull = "actions-full",
/**
* Api clients full.
*/
ApiClientsFull = "apiclients-full",
/**
* Geometry backend systems full
*/
BackendSystemsFull = "backendsystems-full",
/**
* Domains read.
*/
DomainsRead = "domains-read",
/**
* Domains full.
*/
DomainsFull = "domains-full",
/**
* Http logs full.
*/
HttpLogsFull = "httplogs-full",
/**
* Policies full.
*/
PoliciesFull = "policies-full",
/**
* Organizations readonly.
*/
OrganizationsRead = "organizations-read",
/**
* Organizations read-write.
*/
OrganizationsWrite = "organizations-write",
/**
* Organizations full.
*/
OrganizationsFull = "organizations-full",
/**
* Notifications readonly.
*/
NotificationsRead = "notifications-read",
/**
* Notifications read-write.
*/
NotificationsWrite = "notifications-write",
/**
* Notifications full.
*/
NotificationsFull = "notifications-full",
/**
* Documents readonly.
*/
DocumentsRead = "documents-read",
/**
* Documents read-write.
*/
DocumentsWrite = "documents-write",
/**
* Documents full.
*/
DocumentsFull = "documents-full",
/**
*
*/
OpenidProviderFull = "openid-provider-full",
/**
* All.
*/
All = "*"
}
//# sourceMappingURL=SdPlatformApiTokenScopes.d.ts.map

@@ -5,49 +5,175 @@ "use strict";

/**
* Scopes for limiting Platform API tokens
* Scopes which can be used for limiting API tokens {@link SdPlatformResponseApiToken}.
*/
var SdPlatformApiTokenScopes;
(function (SdPlatformApiTokenScopes) {
/**
* Models readonly.
*/
SdPlatformApiTokenScopes["ModelsRead"] = "models-read";
/**
* Models read-write.
*/
SdPlatformApiTokenScopes["ModelsWrite"] = "models-write";
/**
* Models full.
*/
SdPlatformApiTokenScopes["ModelsFull"] = "models-full";
/**
* Bookmarks full.
*/
SdPlatformApiTokenScopes["BookmarksFull"] = "bookmarks-full";
/**
* Images readonly.
*/
SdPlatformApiTokenScopes["ImagesRead"] = "images-read";
/**
* Images read-write.
*/
SdPlatformApiTokenScopes["ImagesWrite"] = "images-write";
/**
* Images full.
*/
SdPlatformApiTokenScopes["ImagesFull"] = "images-full";
/**
* Geometry backend tokens.
*/
SdPlatformApiTokenScopes["Tokens"] = "tokens";
/**
* Tags readonly.
*/
SdPlatformApiTokenScopes["TagsRead"] = "tags-read";
/**
* Tags read-write.
*/
SdPlatformApiTokenScopes["TagsWrite"] = "tags-write";
/**
* Users readonly.
*/
SdPlatformApiTokenScopes["UsersRead"] = "users-read";
/**
* Users read-write.
*/
SdPlatformApiTokenScopes["UsersWrite"] = "users-write";
/**
* Users full.
*/
SdPlatformApiTokenScopes["UsersFull"] = "users-full";
/**
* User model sessions read.
*/
SdPlatformApiTokenScopes["UserModelSessionsRead"] = "user-model-sessions-read";
/**
* Organization model sessions read.
*/
SdPlatformApiTokenScopes["OrganizationModelSessionsRead"] = "organization-model-sessions-read";
/**
* Model sharing readonly.
*/
SdPlatformApiTokenScopes["ModelSharingRead"] = "model-sharing-read";
/**
* Model sharing read-write.
*/
SdPlatformApiTokenScopes["ModelSharingWrite"] = "model-sharing-write";
/**
* Model sharing full.
*/
SdPlatformApiTokenScopes["ModelSharingFull"] = "model-sharing-full";
/**
* Saved states readonly.
*/
SdPlatformApiTokenScopes["SavedStatesRead"] = "saved-states-read";
/**
* Saved states read-write.
*/
SdPlatformApiTokenScopes["SavedStatesWrite"] = "saved-states-write";
/**
* Saved states full.
*/
SdPlatformApiTokenScopes["SavedStatesFull"] = "saved-states-full";
/**
* Saved state sharing readonly.
*/
SdPlatformApiTokenScopes["SavedStateSharingRead"] = "saved-state-sharing-read";
/**
* Saved state sharing read-write.
*/
SdPlatformApiTokenScopes["SavedStateSharingWrite"] = "saved-state-sharing-write";
/**
* Saved state sharing full.
*/
SdPlatformApiTokenScopes["SavedStateSharingFull"] = "saved-state-sharing-full";
/**
* Actions full.
*/
SdPlatformApiTokenScopes["ActionsFull"] = "actions-full";
/**
* Api clients full.
*/
SdPlatformApiTokenScopes["ApiClientsFull"] = "apiclients-full";
/**
* Geometry backend systems full
*/
SdPlatformApiTokenScopes["BackendSystemsFull"] = "backendsystems-full";
/**
* Domains read.
*/
SdPlatformApiTokenScopes["DomainsRead"] = "domains-read";
/**
* Domains full.
*/
SdPlatformApiTokenScopes["DomainsFull"] = "domains-full";
/**
* Http logs full.
*/
SdPlatformApiTokenScopes["HttpLogsFull"] = "httplogs-full";
/**
* Policies full.
*/
SdPlatformApiTokenScopes["PoliciesFull"] = "policies-full";
/**
* Organizations readonly.
*/
SdPlatformApiTokenScopes["OrganizationsRead"] = "organizations-read";
/**
* Organizations read-write.
*/
SdPlatformApiTokenScopes["OrganizationsWrite"] = "organizations-write";
/**
* Organizations full.
*/
SdPlatformApiTokenScopes["OrganizationsFull"] = "organizations-full";
/**
* Notifications readonly.
*/
SdPlatformApiTokenScopes["NotificationsRead"] = "notifications-read";
/**
* Notifications read-write.
*/
SdPlatformApiTokenScopes["NotificationsWrite"] = "notifications-write";
/**
* Notifications full.
*/
SdPlatformApiTokenScopes["NotificationsFull"] = "notifications-full";
/**
* Documents readonly.
*/
SdPlatformApiTokenScopes["DocumentsRead"] = "documents-read";
/**
* Documents read-write.
*/
SdPlatformApiTokenScopes["DocumentsWrite"] = "documents-write";
/**
* Documents full.
*/
SdPlatformApiTokenScopes["DocumentsFull"] = "documents-full";
/**
*
*/
SdPlatformApiTokenScopes["OpenidProviderFull"] = "openid-provider-full";
/**
* All.
*/
SdPlatformApiTokenScopes["All"] = "*";
})(SdPlatformApiTokenScopes = exports.SdPlatformApiTokenScopes || (exports.SdPlatformApiTokenScopes = {}));
//# sourceMappingURL=SdPlatformApiTokenScopes.js.map
import { Customer, Plan, Subscription, Addon, HostedPage, PortalSession } from "chargebee-typescript/lib/resources";
/**
* The Chargebee customer.
* @see [Chargebee Customer](https://apidocs.chargebee.com/docs/api/customers?prod_cat_ver=2#customer_attributes}
*/
export declare type SdPlatformChargebeeCustomer = Customer;
/**
* The Chargebee subscription.
* @see [Chargebee Subscription](https://apidocs.chargebee.com/docs/api/subscriptions?prod_cat_ver=2#subscription_attributes)
*/
export declare type SdPlatformChargebeeSubscription = Subscription;
/**
* The Chargebee addon.
* @see [Chargebee Addon](https://apidocs.chargebee.com/docs/api/attached_items?prod_cat_ver=2)
*/
export declare type SdPlatformChargebeeAddon = Addon;
/**
* The Chargbee plan.
* @see [Chargebee Plan](https://apidocs.chargebee.com/docs/api/items?prod_cat_ver=2#item_attributes)
*/
export declare type SdPlatformChargebeePlan = Plan;
/**
* The Chargebee hosted page.
* @see [Hosted Page](https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#hosted_page_attributes)
*/
export declare type SdPlatformChargebeeHostedPage = HostedPage;
/**
* The Chargebee portal session.
* @see [Portal Session](https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2#portal_session_attributes)
*/
export declare type SdPlatformChargebeePortalSession = PortalSession;
//# sourceMappingURL=SdPlatformChargebee.d.ts.map

@@ -0,5 +1,14 @@

/**
* Model file type.
*/
export declare enum SdPlatformModelFileType {
/**
* Grasshopper binary file.
*/
GH = "gh",
/**
* Grasshopper XML file.
*/
GHX = "ghx"
}
//# sourceMappingURL=SdPlatformModelCommons.d.ts.map
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SdPlatformModelFileType = void 0;
/**
* Model file type.
*/
var SdPlatformModelFileType;
(function (SdPlatformModelFileType) {
/**
* Grasshopper binary file.
*/
SdPlatformModelFileType["GH"] = "gh";
/**
* Grasshopper XML file.
*/
SdPlatformModelFileType["GHX"] = "ghx";
})(SdPlatformModelFileType = exports.SdPlatformModelFileType || (exports.SdPlatformModelFileType = {}));
//# sourceMappingURL=SdPlatformModelCommons.js.map

@@ -5,7 +5,19 @@ /**

export declare enum SdPlatformModelTokenScopes {
/**
* Group scope "group.view" (viewing permissions for model).
*/
GroupView = "group.view",
/**
* Group scope "group.export" (export permissions for model).
*/
GroupExport = "group.export",
/**
* Group scope "group.owner" (authoring permissions for model).
*/
GroupOwner = "group.owner",
/**
* Group scope "group.analytics" (analytics permissions for model).
*/
GroupAnalytics = "group.analytics"
}
//# sourceMappingURL=SdPlatformModelTokenScopes.d.ts.map

@@ -9,7 +9,19 @@ "use strict";

(function (SdPlatformModelTokenScopes) {
/**
* Group scope "group.view" (viewing permissions for model).
*/
SdPlatformModelTokenScopes["GroupView"] = "group.view";
/**
* Group scope "group.export" (export permissions for model).
*/
SdPlatformModelTokenScopes["GroupExport"] = "group.export";
/**
* Group scope "group.owner" (authoring permissions for model).
*/
SdPlatformModelTokenScopes["GroupOwner"] = "group.owner";
/**
* Group scope "group.analytics" (analytics permissions for model).
*/
SdPlatformModelTokenScopes["GroupAnalytics"] = "group.analytics";
})(SdPlatformModelTokenScopes = exports.SdPlatformModelTokenScopes || (exports.SdPlatformModelTokenScopes = {}));
//# sourceMappingURL=SdPlatformModelTokenScopes.js.map

10

dist/commons/SdPlatformNotificationCommons.d.ts

@@ -63,3 +63,3 @@ /**

/**
* (for planned maintenance / downtime)
* Planned maintenance or downtime.
*/

@@ -72,6 +72,10 @@ Maintenance = "maintenance",

/**
* (for updates about other components, e.g. SDKs)
* Updates about components like SDKs etc.
*/
GenericUpdate = "generic-update"
GenericUpdate = "generic-update",
/**
* Used whenever a user's or organization's default backend system gets changed by the platform backend.
*/
BackendSystemChanged = "backend-system-changed"
}
//# sourceMappingURL=SdPlatformNotificationCommons.d.ts.map

@@ -73,3 +73,3 @@ "use strict";

/**
* (for planned maintenance / downtime)
* Planned maintenance or downtime.
*/

@@ -82,6 +82,10 @@ SdPlatformNotificationType["Maintenance"] = "maintenance";

/**
* (for updates about other components, e.g. SDKs)
* Updates about components like SDKs etc.
*/
SdPlatformNotificationType["GenericUpdate"] = "generic-update";
/**
* Used whenever a user's or organization's default backend system gets changed by the platform backend.
*/
SdPlatformNotificationType["BackendSystemChanged"] = "backend-system-changed";
})(SdPlatformNotificationType = exports.SdPlatformNotificationType || (exports.SdPlatformNotificationType = {}));
//# sourceMappingURL=SdPlatformNotificationCommons.js.map

@@ -211,3 +211,4 @@ /**

queryByEmailExact = "query_by_email_exact",
embedOrganization = "embed_organization"
embedOrganization = "embed_organization",
getRestModelOrganization = "get_rest_model_organization"
}

@@ -280,16 +281,58 @@ /**

};
/**
* The model type permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusModelType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsModel, SdPlatformPolicyPermissionStatus>;
/**
* The organization type permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusOrganizationType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsOrganization, SdPlatformPolicyPermissionStatus>;
/**
* The user type permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusUserType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsUser, SdPlatformPolicyPermissionStatus>;
/**
* The saved state permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusSavedStateType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsSavedState, SdPlatformPolicyPermissionStatus>;
/**
* The utility type permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusUtiliyType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsUtility, SdPlatformPolicyPermissionStatus>;
/**
* The platform type permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusPlatformType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsPlatform, SdPlatformPolicyPermissionStatus>;
/**
* The asset type permissions status.
*/
export declare type SdPlatformPolicyPermissionsStatusAssetType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsAsset, SdPlatformPolicyPermissionStatus>;
export declare type SdPlatformPolicyPermissionsStatusType = SdPlatformPolicyPermissionsStatusModelType | SdPlatformPolicyPermissionsStatusOrganizationType | SdPlatformPolicyPermissionsStatusUserType | SdPlatformPolicyPermissionsStatusSavedStateType | SdPlatformPolicyPermissionsStatusUtiliyType | SdPlatformPolicyPermissionsStatusPlatformType | SdPlatformPolicyPermissionsStatusAssetType;
/**
* The model type permissions.
*/
export declare type SdPlatformPolicyPermissionsModelType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsModel, boolean>;
/**
* The organization type permissions.
*/
export declare type SdPlatformPolicyPermissionsOrganizationType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsOrganization, boolean>;
/**
* The user type permissions.
*/
export declare type SdPlatformPolicyPermissionsUserType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsUser, boolean>;
/**
* The saved state type permissions.
*/
export declare type SdPlatformPolicyPermissionsSavedStateType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsSavedState, boolean>;
/**
* The utility type permissions.
*/
export declare type SdPlatformPolicyPermissionsUtiliyType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsUtility, boolean>;
/**
* The platform type permissions.
*/
export declare type SdPlatformPolicyPermissionsPlatformType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsPlatform, boolean>;
/**
* The asset type permissions.
*/
export declare type SdPlatformPolicyPermissionsAssetType = SdPlatformPolicyPermissionsGeneric<SdPlatformPolicyPermissionsAsset, boolean>;

@@ -296,0 +339,0 @@ export declare type SdPlatformPolicyPermissionsType = SdPlatformPolicyPermissionsModelType | SdPlatformPolicyPermissionsOrganizationType | SdPlatformPolicyPermissionsUserType | SdPlatformPolicyPermissionsSavedStateType | SdPlatformPolicyPermissionsUtiliyType | SdPlatformPolicyPermissionsPlatformType | SdPlatformPolicyPermissionsAssetType;

@@ -226,2 +226,3 @@ "use strict";

SdPlatformPolicyPermissionsUser["embedOrganization"] = "embed_organization";
SdPlatformPolicyPermissionsUser["getRestModelOrganization"] = "get_rest_model_organization";
})(SdPlatformPolicyPermissionsUser = exports.SdPlatformPolicyPermissionsUser || (exports.SdPlatformPolicyPermissionsUser = {}));

@@ -228,0 +229,0 @@ /**

@@ -5,4 +5,7 @@ /**

export interface SdPlatformUsedCredits {
/**
* Credits used so far in the current month.
*/
readonly used_credits_current_month: number;
}
//# sourceMappingURL=SdPlatformUsedCredits.d.ts.map

@@ -5,4 +5,13 @@ /**

export declare enum SdPlatformUserVisibility {
/**
* Private visibility.
*/
Private = "private",
/**
* Organization visibility.
*/
Organization = "organization",
/**
* Public visibility.
*/
Public = "public"

@@ -14,6 +23,17 @@ }

export declare enum SdPlatformModelVisibility {
/**
* Private visibility.
*/
Private = "private",
/**
* Organization visibility.
*/
Organization = "organization",
/**
* Public visibility.
*/
Public = "public",
/** "shared" can be used for querying models only */
/**
* "shared" can be used for querying models only
*/
Shared = "shared"

@@ -25,4 +45,13 @@ }

export declare enum SdPlatformOrganizationVisibility {
/**
* Private visibility.
*/
Private = "private",
/**
* Organization visibility.
*/
Organization = "organization",
/**
* Public visibility.
*/
Public = "public"

@@ -34,8 +63,19 @@ }

export declare enum SdPlatformSavedStateVisibility {
/**
* Private visibility.
*/
Private = "private",
/**
* Organization visibility.
*/
Organization = "organization",
/**
* Public visibility.
*/
Public = "public",
/** "shared" can be used for querying saved states only */
/**
* "shared" can be used for querying saved states only
*/
Shared = "shared"
}
//# sourceMappingURL=SdPlatformVisibility.d.ts.map

@@ -9,4 +9,13 @@ "use strict";

(function (SdPlatformUserVisibility) {
/**
* Private visibility.
*/
SdPlatformUserVisibility["Private"] = "private";
/**
* Organization visibility.
*/
SdPlatformUserVisibility["Organization"] = "organization";
/**
* Public visibility.
*/
SdPlatformUserVisibility["Public"] = "public";

@@ -19,6 +28,17 @@ })(SdPlatformUserVisibility = exports.SdPlatformUserVisibility || (exports.SdPlatformUserVisibility = {}));

(function (SdPlatformModelVisibility) {
/**
* Private visibility.
*/
SdPlatformModelVisibility["Private"] = "private";
/**
* Organization visibility.
*/
SdPlatformModelVisibility["Organization"] = "organization";
/**
* Public visibility.
*/
SdPlatformModelVisibility["Public"] = "public";
/** "shared" can be used for querying models only */
/**
* "shared" can be used for querying models only
*/
SdPlatformModelVisibility["Shared"] = "shared";

@@ -31,4 +51,13 @@ })(SdPlatformModelVisibility = exports.SdPlatformModelVisibility || (exports.SdPlatformModelVisibility = {}));

(function (SdPlatformOrganizationVisibility) {
/**
* Private visibility.
*/
SdPlatformOrganizationVisibility["Private"] = "private";
/**
* Organization visibility.
*/
SdPlatformOrganizationVisibility["Organization"] = "organization";
/**
* Public visibility.
*/
SdPlatformOrganizationVisibility["Public"] = "public";

@@ -41,8 +70,19 @@ })(SdPlatformOrganizationVisibility = exports.SdPlatformOrganizationVisibility || (exports.SdPlatformOrganizationVisibility = {}));

(function (SdPlatformSavedStateVisibility) {
/**
* Private visibility.
*/
SdPlatformSavedStateVisibility["Private"] = "private";
/**
* Organization visibility.
*/
SdPlatformSavedStateVisibility["Organization"] = "organization";
/**
* Public visibility.
*/
SdPlatformSavedStateVisibility["Public"] = "public";
/** "shared" can be used for querying saved states only */
/**
* "shared" can be used for querying saved states only
*/
SdPlatformSavedStateVisibility["Shared"] = "shared";
})(SdPlatformSavedStateVisibility = exports.SdPlatformSavedStateVisibility || (exports.SdPlatformSavedStateVisibility = {}));
//# sourceMappingURL=SdPlatformVisibility.js.map

@@ -13,9 +13,33 @@ /**

export interface SdPlatformAuthRequest {
/**
* The grant type.
*/
grant_type: SdPlatformAuthGrantType;
/**
* The client id.
*/
client_id?: string | null;
/**
* The client secret.
*/
client_secret?: string | null;
/**
* The refresh token.
*/
refresh_token?: string | null;
/**
* The username.
*/
username?: string | null;
/**
* The password.
*/
password?: string | null;
/**
* The code.
*/
code?: string | null;
/**
* The state.
*/
state?: string | null;

@@ -22,0 +46,0 @@ }

@@ -5,8 +5,13 @@ /**

interface SdPlatformPaginationParameters {
/** Maximum number of items to fetch */
/**
* Limit, or number of items to fetch.
*/
limit?: number | null;
/** If set to true the limit will be attained if possible (if there are enough items left) */
/**
* Strict limit. If set to true, the query will fetch the exact number of items unless there is no more items to query.
* If set to false, query will request 10 items, but might actually return less depending on the user's permissions.
*/
strict_limit?: boolean | null;
/**
* Offset is used to fetch next set of results.
* Offset, is used like page number. If offset from response is not null, it can be used to query results further in next request.
*/

@@ -16,3 +21,9 @@ offset?: string | null;

export declare enum SdPlatformSortingOrder {
/**
* Sort in ascending order.
*/
Asc = "asc",
/**
* Sort in descending order.
*/
Desc = "desc"

@@ -25,2 +36,5 @@ }

interface SdPlatformFilterParameters {
/**
* The query filters.
*/
filters?: {

@@ -34,2 +48,5 @@ [filter_expression: string]: SdPlatformFilterValue;

interface SdPlatformSorterParameters {
/**
* Sorting criteria for request.
*/
sorters?: {

@@ -43,2 +60,5 @@ [column: string]: SdPlatformSortingOrder;

interface SdPlatformEmbedParameters<TEmbeddableResource> {
/**
* Which fields to embed.
*/
embed?: Array<TEmbeddableResource>;

@@ -45,0 +65,0 @@ }

@@ -6,5 +6,11 @@ "use strict";

(function (SdPlatformSortingOrder) {
/**
* Sort in ascending order.
*/
SdPlatformSortingOrder["Asc"] = "asc";
/**
* Sort in descending order.
*/
SdPlatformSortingOrder["Desc"] = "desc";
})(SdPlatformSortingOrder = exports.SdPlatformSortingOrder || (exports.SdPlatformSortingOrder = {}));
//# sourceMappingURL=SdPlatformBaseRequestTypes.js.map
export interface SdPlatformRequestApiClientCreate {
/**
* Client application name
*/
client_name: string;
/**
* Client application secret (typically unused)
*/
client_secret?: string;
/**
* Should refresh tokens be used?
*/
refresh_token?: boolean;
/**
* Origins (domains) which the client application may connect from.
*/
allowed_origins?: Array<string>;
/**
* Lifetime of access tokens issued to this client application in seconds.
*/
access_token_lifetime?: number;
/**
* Lifetime of refresh tokens issued to this client application in seconds.
*/
refresh_token_lifetime?: number;
/**
* The refresh token limit (how often can refresh tokens be used?)
*/
refresh_token_limit?: number;
/**
* The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatureValues}
*/
required_feature: string;
}
export interface SdPlatformRequestApiClientPatch {
/**
* Client application name
*/
client_name?: string;
/**
* Client application secret (typically unused)
*/
client_secret?: string;
/**
* Should refresh tokens be used?
*/
refresh_token?: boolean;
/**
* Origins (domains) which the client application may connect from.
*/
allowed_origins?: Array<string>;
/**
* Lifetime of access tokens issued to this client application in seconds.
*/
access_token_lifetime?: number;
/**
* Lifetime of refresh tokens issued to this client application in seconds.
*/
refresh_token_lifetime?: number;
/**
* The refresh token limit (how often can refresh tokens be used?)
*/
refresh_token_limit?: number;
/**
* The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatureValues}
*/
required_feature: string;
}
//# sourceMappingURL=SdPlatformRequestApiClients.d.ts.map

@@ -44,4 +44,13 @@ import { SdPlatformModelFileType } from "../commons/SdPlatformModelCommons";

export interface SdPlatformRequestModelPatchAdmin extends SdPlatformRequestModelPatch {
/**
* Update the model owner without a transfer request.
*/
user_id?: string;
/**
* The id of a backend system that model should belong to.
*/
backend_system_id?: string;
/**
* Is this a featured model?
*/
featured?: boolean;

@@ -54,13 +63,43 @@ deleted_at?: null;

export interface SdPlatformRequestModelCreate {
/**
* Title of the model. Min 5 characters, max 50 characters. Either title or {@link SdPlatformRequestModelCreate.filename} needs to be specified.
*/
title?: string;
/**
* Filename of the model. Either {@link SdPlatformRequestModelCreate.title} or needs to be specified.
*/
filename?: string;
/**
* File type of the model.
*/
ftype?: SdPlatformModelFileType;
/**
* Description of the model.
*/
description?: string;
/**
* Tags of the model.
*/
tags?: Array<string>;
/**
* Accessdomains to allow embedding from.
*/
accessdomains?: Array<string>;
/**
* Set to true if the per-account access domains shall be used.
*/
use_global_accessdomains?: boolean;
/**
* Set to true to allow backend access.
*/
backendaccess?: boolean;
/**
* Nominal visibility of the model
*/
visibility?: SdPlatformModelVisibility;
/**
* Should token be required.
*/
require_token?: boolean;
}
//# sourceMappingURL=SdPlatformRequestModel.d.ts.map

@@ -6,8 +6,19 @@ import { SdPlatformModelTokenScopes } from "../commons/SdPlatformModelTokenScopes";

export interface SdPlatformRequestModelTokenCreate {
/**
* Id of the model for which to create a geometry backend access token.
*/
id?: string;
/**
* Ids of the models for which to create an authorization group and a geometry backend access token.
*/
ids?: Array<string>;
/**
* Token scopes to include.
*/
scope: Array<SdPlatformModelTokenScopes>;
/** The lifetime of a token in seconds, which is only set if lifetime is less then minimum lifetime for a client. */
/**
* The lifetime of a token in seconds, which is only set if lifetime is less then minimum lifetime for a client.
*/
lifetime?: number;
}
//# sourceMappingURL=SdPlatformRequestModelToken.d.ts.map

@@ -6,12 +6,33 @@ import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibility";

export interface SdPlatformRequestOrganizationCreate {
/**
* Name of the organization, minimum 5 characters.
*/
name: string;
/**
* avatar image base64 encoded, maximum 1MB
* Avatar image base64 encoded, maximum 1MB
*/
avatar?: string;
/**
* Visibility of the organization.
*/
visibility?: SdPlatformOrganizationVisibility;
/**
* Should sharing be allowed for organization members?
*/
allow_sharing?: boolean;
/**
* Should private link sharing be allowed for organization members?
*/
allow_link_sharing?: boolean;
/**
* Should organization members be allowed to expose their email address?
*/
allow_expose_email?: boolean;
/**
* Website of organization.
*/
website?: string;
/**
* Description of organization
*/
description?: string;

@@ -23,10 +44,37 @@ }

export interface SdPlatformRequestOrganizationPatchAdministrator {
/**
* Visibility of the organization.
*/
visibility?: SdPlatformOrganizationVisibility;
/**
* Should sharing be allowed for organization members?
*/
allow_sharing?: boolean;
/**
* Should private link sharing be allowed for organization members?
*/
allow_link_sharing?: boolean;
/**
* Should organization members be allowed to expose their email address?
*/
allow_expose_email?: boolean;
/**
* Website of organization.
*/
website?: string;
/**
* Description of organization
*/
description?: string;
/**
* List of host names (optionally including port) to set as allowed domains for embedding.
*/
accessdomains?: Array<string>;
/**
* Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the organization?
*/
force_require_token?: boolean;
/**
* Should credit consumption be limited once the monthly quota has been reached?
*/
limit_credit_consumption?: boolean;

@@ -42,2 +90,5 @@ /**

export interface SdPlatformRequestOrganizationPatchOwner extends SdPlatformRequestOrganizationPatchAdministrator {
/**
* Name of the organization.
*/
name?: string;

@@ -48,2 +99,5 @@ /**

avatar?: string;
/**
* URL-compatible short name of the organization, minimum 5 characters. Used for links to the organizations's profile on the ShapeDiver Platform.
*/
slug?: string;

@@ -55,3 +109,9 @@ }

export interface SdPlatformRequestOrganizationPatchAdmin extends SdPlatformRequestOrganizationPatchOwner {
/**
* Id of the geometry backend system of the organization.
*/
backend_system_id?: string;
/**
* Chargebee customer id of the organization.
*/
chargebee_customer_id?: string;

@@ -58,0 +118,0 @@ }

@@ -6,3 +6,9 @@ import { SdPlatformSavedStateVisibility } from "../commons/SdPlatformVisibility";

export interface SdPlatformRequestSavedStateSettings {
/**
* The version of settings.
*/
version: string;
/**
* The Viewer Settings.
*/
viewer_settings: any;

@@ -14,10 +20,31 @@ }

export interface SdPlatformRequestSavedStateCreate {
/**
* Name of the saved state.
*/
name: string;
/**
* Description of the saved state.
*/
description: string;
/**
* Id of the model of the saved state.
*/
model_id: string;
/**
* Id of the image of the saved state.
*/
image_id?: string;
/**
* The parameter values of the model for this saved state. Map from parameter id to parameter string value.
*/
parameters: {
[id: string]: string;
};
/**
* Nominal visibility of the saved state.
*/
visibility: SdPlatformSavedStateVisibility;
/**
* Settings of the saved state, used to store viewer settings like camera position etc.
*/
settings?: SdPlatformRequestSavedStateSettings;

@@ -29,11 +56,29 @@ }

export interface SdPlatformRequestSavedStatePatch {
/**
* Name of the saved state.
*/
name?: string;
/**
* Description of the saved state.
*/
description?: string;
/**
* Id of the image of the saved state.
*/
image_id?: string;
/**
* The parameter values of the model for this saved state. Map from parameter id to parameter string value.
*/
parameters?: {
[id: string]: string;
};
/**
* Nominal visibility of the saved state.
*/
visibility?: SdPlatformSavedStateVisibility;
/**
* Settings of the saved state, used to store viewer settings like camera position etc.
*/
settings?: SdPlatformRequestSavedStateSettings;
}
//# sourceMappingURL=SdPlatformRequestSavedState.d.ts.map

@@ -7,4 +7,13 @@ import { SdPlatformOrganizationMemberRole } from "../commons/SdPlatformOrganizationCommons";

export interface SdPlatformRequestUserPasswordResetConfirm {
/**
* The token.
*/
token: string;
/**
* The password.
*/
password?: string;
/**
* The password confirmation.
*/
password_confirmation?: string;

@@ -16,5 +25,17 @@ }

export interface SdPlatformRequestUserRegister {
/**
* The email.
*/
email: string;
/**
* The password.
*/
password: string;
/**
* The password confirmation.
*/
password_confirmation: string;
/**
* The captcha token.
*/
captcha_token: string;

@@ -26,2 +47,5 @@ }

export interface SdPlatformRequestUserPatch {
/**
* Username, minimum 5 characters.
*/
username?: string;

@@ -32,27 +56,105 @@ /**

avatar?: string;
/**
* Location of the user.
*/
location?: string;
/**
* Website of the user.
*/
website?: string;
/**
* Facebook id of the user.
*/
facebook_id?: string;
/**
* Instagram id of the user
*/
instagram_id?: string;
/**
* McNeel id of the user
*/
mcneel_id?: string;
/**
* LinkedIn id of the user.
*/
linkedin_id?: string;
/**
* Twitter id of the user.
*/
twitter_id?: string;
/**
* Bio of the user.
*/
bio?: string;
/**
* Accessdomains of the user.
*/
global_accessdomains?: Array<string>;
/**
* Is the user subscribed to the newsletter?
*/
newsletter_subscribed?: boolean;
/**
* First name of the user.
*/
first_name?: string;
/**
* Last name of the user
*/
last_name?: string;
/**
* Country of the user.
*/
country?: string;
/**
* Company name.
*/
company_name?: string;
/**
* Primary reason of the user to use ShapeDiver (registration field).
*/
using_reason?: string;
/**
* User knows ShapeDiver from (registration field).
*/
know_source?: string;
/**
* Grasshopper know-how of the user (registration field).
*/
grasshopper_knowhow?: string;
/**
* Industry of the user (registration field).
*/
industry?: string;
/**
* Should the email address be exposed on the public profile page? Might be influenced by {@link SdPlatformResponseOrganizationMember.expose_email}
*/
expose_email?: boolean;
/**
* The old password.
*/
old_password?: string;
/**
* The new password.
*/
new_password?: string;
/**
* The new password confirmation.
*/
new_password_confirmation?: string;
/**
* Visibility of the user (may be limited by the visibility of the user's organization).
*/
visibility?: SdPlatformUserVisibility;
/**
* Should sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_sharing}
*/
allow_sharing?: boolean;
/**
* Should private link sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_link_sharing }
*/
allow_link_sharing?: boolean;
/**
* URL-compatible short name of the user. Used for links to the user's profile on the [ShapeDiver Platform](https://shapediver.com/app/users/{slug}).
*/
slug?: string;

@@ -68,9 +170,27 @@ /**

backend_system_alias?: string;
/**
* Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the user? Might be influenced by {@link SdPlatformResponseOrganizationMember.force_require_token}
*/
force_require_token?: boolean;
/**
* Mailing settings of the user.
*/
mailing?: {
[id: string]: boolean;
};
/**
* Should credit consumption be limited once the monthly quota has been reached?
*/
limit_credit_consumption?: boolean;
/**
* Should model transfer requests be accepted without confirmation?
*/
transfers_accept_any?: boolean;
/**
* When accepting model transfer requests, should existing sharing relationships be removed?
*/
transfers_clear_sharing?: boolean;
/**
* When accepting model transfer requests, should policies requested by the providing user be shared back?
*/
transfers_accept_shareback?: boolean;

@@ -77,0 +197,0 @@ }

/**
* ShapeDiver Platform Authentication API response (OAuth 2.0)
* Response for
* password credentials grant request
* refresh token grant request
* [see](https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/)
*/

@@ -4,0 +7,0 @@ export interface SdPlatformAuthResponse {

@@ -5,4 +5,13 @@ /**

export interface SdPlatformGetResponse<T> {
/**
* This property is always true unless a exception is thrown.
*/
readonly success: boolean;
/**
* Version of the Platform Backend API.
*/
readonly version: string;
/**
* Data resulting from the get request.
*/
readonly data: T;

@@ -14,8 +23,29 @@ }

export interface SdPlatformQueryResponse<T> {
/**
* This property is always true unless a exception is thrown.
*/
readonly success: boolean;
/**
* Version of the Platform Backend API.
*/
readonly version: string;
/**
* Data resulting from the query request.
*/
readonly data: {
/**
* The resulting items.
*/
result: Array<T>;
/**
* Data for requesting the next page of items.
*/
pagination: {
/**
* Limit which was used for the query.
*/
limit: number;
/**
* Offset to use for requesting the next page, null in case there are no more items.
*/
next_offset: string;

@@ -29,6 +59,18 @@ };

export interface SdPlatformPostResponse<T> {
success: boolean;
/**
* This property is always true unless a exception is thrown.
*/
readonly success: boolean;
/**
* Version of the Platform Backend API.
*/
readonly version: string;
message: string;
data: T;
/**
* Error message (short):
*/
readonly message: string;
/**
* Data resulting from the post request.
*/
readonly data: T;
}

@@ -39,6 +81,18 @@ /**

export interface SdPlatformPatchResponse<T> {
success: boolean;
/**
* This property is always true unless a exception is thrown.
*/
readonly success: boolean;
/**
* Version of the Platform Backend API.
*/
readonly version: string;
patched_properties?: Array<string>;
data: T;
/**
* Properties which were patched.
*/
readonly patched_properties?: Array<string>;
/**
* Data resulting from the patch request.
*/
readonly data: T;
}

@@ -49,5 +103,11 @@ /**

export interface SdPlatformDeleteResponse {
/**
* This property is always true unless a exception is thrown.
*/
readonly success: boolean;
/**
* Version of the Platform Backend API.
*/
readonly version: string;
success: boolean;
}
//# sourceMappingURL=SdPlatformBaseResponseTypes.d.ts.map

@@ -9,26 +9,107 @@ import { SdPlatformChargebeeHostedPage, SdPlatformChargebeePortalSession } from "../commons/SdPlatformChargebee";

}
export declare enum SdPlatformResponseChargebeePeriodUnit {
/**
* Charge based on day(s).
*/
Day = "day",
/**
* Charge based on week(s).
*/
Week = "week",
/**
* Charge based on month(s).
*/
Month = "month",
/**
* Charge based on year(s).
*/
Year = "year"
}
/**
* The [Chargebee Plan](https://apidocs.chargebee.com/docs/api/plans?prod_cat_ver=1#plan_attributes)
*/
export interface SdPlatformResponseChargebeePlan {
/**
* A unique ID for your system to identify the plan.
*/
readonly id: string;
/**
* The display name used in web interface for identifying the plan.
*/
readonly name: string;
/**
* The price of the plan. The unit depends on the type of currency.
* {@link SdPlatformResponseChargebeeCurrencyCode}
*/
readonly price: number;
/**
* Description about the plan to show in the hosted pages & customer portal.
*/
readonly description: string;
/**
* The currency code (ISO 4217 format) of the plan
*/
readonly currency_code: SdPlatformResponseChargebeeCurrencyCode;
/**
* Display name used in invoice. If it is not configured then name is used in invoice.
*/
readonly invoice_name: string;
/**
* If true, allow checkout through plan specific hosted page URL for this plan.
*/
readonly enabled_in_hosted_pages: boolean;
/**
* Is free plan?
*/
readonly cf_free_plan?: boolean;
/**
* When has or will be active
*/
readonly cf_active_from?: string;
/**
* Until when is active.
*/
readonly cf_active_to?: string;
/**
* Defines billing frequency in association with billing period.
* {@link SdPlatformResponseChargebeePeriodUnit}
*/
readonly period: number;
/**
* Defines billing frequency in association with billing period.
*/
readonly period_unit: string;
/**
* The free time window for your customer to try your product+
*/
readonly trial_period?: number;
/**
* Time unit for the trial period.
*/
readonly trial_period_unit?: string;
/**
* The features.
* {@link SdPlatformResponseFeatures}
*/
readonly features?: SdPlatformResponseFeatures;
}
/**
* The configuration for chargebee.
*/
export interface SdPlatformResponseChargebeeConfig {
/**
* Gets the chargebee side.
*/
readonly site: string;
}
/**
* [Hosted Page](https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=1#hosted_page_attributes) response.
*/
export interface SdPlatformResponseChargebeeHostedPage extends SdPlatformChargebeeHostedPage {
}
/**
* [Portal session](https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=1#portal_session_attributes) response.
*/
export interface SdPlatformResponseChargebeePortalSession extends SdPlatformChargebeePortalSession {
}
//# sourceMappingURL=SdPlatformResponseChargebee.d.ts.map
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SdPlatformResponseChargebeeCurrencyCode = void 0;
exports.SdPlatformResponseChargebeePeriodUnit = exports.SdPlatformResponseChargebeeCurrencyCode = void 0;
var SdPlatformResponseChargebeeCurrencyCode;

@@ -11,2 +11,21 @@ (function (SdPlatformResponseChargebeeCurrencyCode) {

})(SdPlatformResponseChargebeeCurrencyCode = exports.SdPlatformResponseChargebeeCurrencyCode || (exports.SdPlatformResponseChargebeeCurrencyCode = {}));
var SdPlatformResponseChargebeePeriodUnit;
(function (SdPlatformResponseChargebeePeriodUnit) {
/**
* Charge based on day(s).
*/
SdPlatformResponseChargebeePeriodUnit["Day"] = "day";
/**
* Charge based on week(s).
*/
SdPlatformResponseChargebeePeriodUnit["Week"] = "week";
/**
* Charge based on month(s).
*/
SdPlatformResponseChargebeePeriodUnit["Month"] = "month";
/**
* Charge based on year(s).
*/
SdPlatformResponseChargebeePeriodUnit["Year"] = "year";
})(SdPlatformResponseChargebeePeriodUnit = exports.SdPlatformResponseChargebeePeriodUnit || (exports.SdPlatformResponseChargebeePeriodUnit = {}));
//# sourceMappingURL=SdPlatformResponseChargebee.js.map
/**
* Product features - boolean toggles
* Features of a user/organization.
*/

@@ -33,3 +33,3 @@ export interface SdPlatformResponseFeatureValues {

/**
* Product features - numeric limits
* Limits of the user/organization.
*/

@@ -50,3 +50,3 @@ export interface SdPlatformResponseFeaturesLimits {

/**
* Product features
* Features and limits granted to a user or organization.
*/

@@ -53,0 +53,0 @@ export interface SdPlatformResponseFeatures {

@@ -301,2 +301,5 @@ import { SdPlatformModelFileType } from "../commons/SdPlatformModelCommons";

}
/**
* The iframe data, used for embedding a model in iframe.
*/
export interface SdPlatformResponseIFrameData {

@@ -303,0 +306,0 @@ readonly token: string;

@@ -55,2 +55,4 @@ import { SdPlatformResponseModelBase } from "./SdPlatformResponseModel";

readonly href?: string;
/** email of notification, used for type organization-invitation */
readonly email?: string;
}

@@ -57,0 +59,0 @@ /**

@@ -13,8 +13,29 @@ import { SdPlatformChargebeeAddon, SdPlatformChargebeeCustomer, SdPlatformChargebeePlan, SdPlatformChargebeeSubscription } from "../commons/SdPlatformChargebee";

export interface SdPlatformResponseOrganizationPublic extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesOrganization, SdPlatformPolicyPermissionsOrganization> {
/**
* Unique id of the organization.
*/
readonly id: string;
/**
* Name of the organization.
*/
readonly name: string;
/**
* URL-compatible short name of the organization. Used for links to the organizations's profile on the ShapeDiver Platform.
*/
readonly slug: string;
/**
* URL to the organization's avatar.
*/
readonly avatar_url?: string;
/**
* Website of organization.
*/
readonly website?: string;
/**
* Description of organization.
*/
readonly description?: string;
/**
* Features which the organization has access to.
*/
readonly features?: SdPlatformResponseFeatures;

@@ -26,11 +47,41 @@ }

export interface SdPlatformResponseOrganizationMember extends SdPlatformResponseOrganizationPublic {
/**
* Accessdomains of the organization.
*/
readonly accessdomains?: Array<SdPlatformResponseDomain>;
/**
* Members of the organization.
*/
readonly members: Array<SdPlatformResponseUserOrganization>;
/**
* Visibility of the organization. This limits the visibility of organization members and their models.
*/
readonly visibility: SdPlatformOrganizationVisibility;
/**
* Should sharing be allowed for organization members?
*/
readonly allow_sharing: boolean;
/**
* Should private link sharing be allowed for organization members?
*/
readonly allow_link_sharing: boolean;
/**
* Should organization members be allowed to expose their email address?
*/
readonly allow_expose_email: boolean;
/**
* Geometry backend system of the organization.
*/
readonly backend_system?: SdPlatformResponseBackendSystem;
/**
* Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the organization?
*/
readonly force_require_token: boolean;
/**
* Should credit consumption be limited once the monthly quota has been reached?
*/
readonly limit_credit_consumption: boolean;
/**
* OpenID provider linked with the organization
*/
readonly openid_provider?: string;

@@ -42,3 +93,9 @@ }

export interface SdPlatformResponseOrganizationAdministrator extends SdPlatformResponseOrganizationMember {
/**
* Features which the organization has access to
*/
readonly created_at: number;
/**
* Features which the organization has access to.
*/
readonly updated_at: number;

@@ -50,2 +107,5 @@ }

export interface SdPlatformResponseOrganizationOwner extends SdPlatformResponseOrganizationAdministrator {
/**
* Status of the organization, one of "created" or "confirmed"
*/
readonly status?: string;

@@ -61,4 +121,13 @@ readonly chargebee_customer?: SdPlatformChargebeeCustomer;

export interface SdPlatformResponseOrganizationAdmin extends SdPlatformResponseOrganizationOwner {
/**
* Epoch timestamp of deletion.
*/
readonly deleted_at?: number;
/**
* Id of backend system {@link SdPlatformRequestBackendSystemToken}
*/
readonly backend_system_id?: string;
/**
* Chargebee customer id.
*/
readonly chargebee_customer_id?: string;

@@ -65,0 +134,0 @@ }

@@ -12,7 +12,25 @@ import { SdPlatformPolicyCommonAliasesSavedState, SdPlatformPolicyPermissionsSavedState } from "../commons/SdPlatformPolicyCommons";

export interface SdPlatformResponseSavedStateMinimal extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesSavedState, SdPlatformPolicyPermissionsSavedState> {
/**
* The saved state id.
*/
readonly id: string;
/**
* Name of the saved state.
*/
readonly name: string;
/**
* Id of the model of the saved state.
*/
readonly model_id: string;
/**
* Model of the saved state.
*/
readonly model?: SdPlatformResponseModelPublic;
/**
* Image of the saved state.
*/
readonly image?: SdPlatformResponseImagePublic;
/**
* Id of the image of the saved state.
*/
readonly image_id?: string;

@@ -24,3 +42,9 @@ }

export interface SdPlatformResponseSavedStateSettings {
/**
* The version of settings.
*/
readonly version?: string;
/**
* The Viewer Settings.
*/
readonly viewer_settings?: any;

@@ -32,10 +56,31 @@ }

export interface SdPlatformResponseSavedStatePublic extends SdPlatformResponseSavedStateMinimal {
/**
* Description of the saved state.
*/
readonly description: string;
/**
* Id of the owner of the saved state (may be different from the owner of the model).
*/
readonly owner_id: string;
/**
* Owner of the saved state.
*/
readonly owner?: SdPlatformResponseUserMinimal;
/**
* The parameter values of the model for this saved state. Map from parameter id to parameter string value.
*/
readonly parameters: {
[id: string]: string;
};
/**
* Organization of the owner of the saved state, if the owner is member of an organization.
*/
readonly organization?: SdPlatformResponseOrganizationPublic;
/**
* Epoch timestamp of creation.
*/
readonly created_at: number;
/**
* Epoch timestamp of update.
*/
readonly updated_at: number;

@@ -48,3 +93,9 @@ readonly settings: SdPlatformResponseSavedStateSettings;

export interface SdPlatformResponseSavedStateOwner extends SdPlatformResponseSavedStatePublic {
/**
* Visibility of the saved state. Might be limited by the visibility of the model, the owner, or an organization.
*/
readonly visibility: SdPlatformSavedStateVisibility;
/**
* Nominal visibility of the saved state as specified by the saved state owner.
*/
readonly visibility_nominal: SdPlatformSavedStateVisibility;

@@ -51,0 +102,0 @@ }

@@ -5,3 +5,9 @@ /**

export interface SdPlatformResponseTag {
/**
* Unique id of the tag
*/
readonly id: string;
/**
* Name of the tag.
*/
readonly name: string;

@@ -13,7 +19,19 @@ }

export interface SdPlatformResponseTagAdmin extends SdPlatformResponseTag {
/**
* Number of models the tag is attached to.
*/
readonly models_count?: number;
/**
* Epoch timestamp
*/
readonly created_at: number;
/**
* Epoch timestamp
*/
readonly updated_at: number;
/**
* Epoch timestamp
*/
readonly deleted_at?: number;
}
//# sourceMappingURL=SdPlatformResponseTag.d.ts.map

@@ -28,9 +28,33 @@ import { SdPlatformChargebeeAddon, SdPlatformChargebeeCustomer, SdPlatformChargebeeSubscription, SdPlatformChargebeePlan } from "../commons/SdPlatformChargebee";

export interface SdPlatformResponseUserMinimal extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesUser, SdPlatformPolicyPermissionsUser> {
/**
* Unique id of the user.
*/
readonly id: string;
/**
* First name of the user.
*/
readonly first_name?: string;
/**
* Last name of the user.
*/
readonly last_name?: string;
/**
* Username.
*/
readonly username?: string;
/**
* URL to the user's avatar.
*/
readonly avatar_url?: string;
/**
* URL-compatible short name of the user. Used for links to the user's profile on the [ShapeDiver Platform](https://shapediver.com/app/users/{slug}).
*/
readonly slug: string;
/**
* Visibility of the user (may be limited by the visibility of the user's organization).
*/
readonly visibility: SdPlatformUserVisibility;
/**
* Nominal visibility of the user (not limited by the visibility of the user's organization).
*/
readonly visibility_nominal: SdPlatformUserVisibility;

@@ -42,12 +66,45 @@ }

export interface SdPlatformResponseUserPublic extends SdPlatformResponseUserMinimal {
/**
* Email of the user.
*/
readonly email?: string;
/**
* Location of the user.
*/
readonly location?: string;
/**
* Website of the user.
*/
readonly website?: string;
/**
* Facebook id of the user.
*/
readonly facebook_id?: string;
/**
* Instagram id of the user.
*/
readonly instagram_id?: string;
/**
* McNeel id of the user.
*/
readonly mcneel_id?: string;
/**
* LinkedIn id of the user.
*/
readonly linkedin_id?: string;
/**
* Twitter id of the user.
*/
readonly twitter_id?: string;
/**
* Bio of the user.
*/
readonly bio?: string;
/**
* Start date of membership, formatted like "April 12th, 2022".
*/
readonly member_since?: string;
/**
* In case user is member of an organization: Organization of the user.
*/
readonly organization?: SdPlatformResponseOrganizationPublic;

@@ -65,33 +122,123 @@ }

export interface SdPlatformResponseUserSelf extends SdPlatformResponseUserOrganization {
/**
* Country of the user.
*/
readonly country?: string;
/**
* Company name.
*/
readonly company_name?: string;
/**
* Primary reason of the user to use ShapeDiver (registration field).
*/
readonly using_reason?: string;
/**
* User knows ShapeDiver from (registration field).
*/
readonly know_source?: string;
/**
* Grasshopper know-how of the user (registration field)
*/
readonly grasshopper_knowhow?: string;
/**
* Industry of the user (registration field)
*/
readonly industry?: string;
/**
* Accessdomains of the user.
*/
readonly global_accessdomains?: Array<SdPlatformResponseDomain>;
/**
* Should sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_sharing}
*/
readonly allow_sharing: boolean;
/**
* Should private link sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_link_sharing }
*/
readonly allow_link_sharing: boolean;
/**
* Epoch timestamp of creation.
*/
readonly created_at: number;
/**
* Epoch timestamp of update.
*/
readonly updated_at: number;
/**
* Epoch timestamp of confirmation.
*/
readonly confirmed_at?: number;
/**
* Is the user subscribed to the newsletter?
*/
readonly newsletter_subscribed?: boolean;
/**
* Should the email address be exposed on the public profile page? Might be influenced by {@link SdPlatformResponseOrganizationMember.expose_email}
*/
readonly expose_email: boolean;
/**
* Id of backend system.
*/
readonly backend_system_id?: number;
/**
* Geometry backend system of the user.
*/
readonly backend_system?: SdPlatformResponseBackendSystem;
/**
* Features which the user has access to.
*/
readonly features?: SdPlatformResponseFeatures;
/**
* The chargebee customer.
*/
readonly chargebee_customer?: SdPlatformChargebeeCustomer;
/**
* The chargebee subscription.
*/
readonly chargebee_subscription?: SdPlatformChargebeeSubscription;
/**
* The chargebee plan.
*/
readonly chargebee_plan?: SdPlatformChargebeePlan;
/**
* The chargebee addons.
*/
readonly chargebee_addons?: Array<SdPlatformChargebeeAddon>;
/**
* Summarized information about consumed credits
*/
readonly used_credits?: SdPlatformUsedCredits;
/**
* Administrative roles of the user (used for ShapeDiver admin access)
*/
readonly roles: Array<string>;
/**
* Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the user? Might be influenced by {@link SdPlatformResponseOrganizationMember.force_require_token}
*/
readonly force_require_token: boolean;
/**
* Mailing settings of the user.
*/
readonly mailing: {
[id: string]: boolean;
};
/**
* Should credit consumption be limited once the monthly quota has been reached?
*/
readonly limit_credit_consumption: boolean;
/**
* Should model transfer requests be accepted without confirmation?
*/
readonly transfers_accept_any: boolean;
/**
* When accepting model transfer requests, should existing sharing relationships be removed?
*/
readonly transfers_clear_sharing: boolean;
/**
* When accepting model transfer requests, should policies requested by the providing user be shared back?
*/
readonly transfers_accept_shareback: boolean;
/**
* Identities of the user.
*/
readonly identities: {

@@ -105,4 +252,13 @@ [id: string]: UserIdentities;

export interface SdPlatformResponseUserAdmin extends SdPlatformResponseUserSelf {
/**
* Has the user been activated?
*/
readonly active: boolean;
/**
* Epoch timestamp of deletion.
*/
readonly deleted_at?: number;
/**
* Chargebee customer id of the user.
*/
readonly chargebee_customer_id?: string;

@@ -120,5 +276,17 @@ }

readonly client_name?: string;
/**
* Epoch timestamp of creation.
*/
readonly created_at: number;
/**
* Epoch timestamp of update.
*/
readonly updated_at: number;
/**
* Epoch timestamp of expiration.
*/
readonly expire_at: number;
/**
* Location of the user when the refresh token was created.
*/
readonly location?: string;

@@ -125,0 +293,0 @@ /**

{
"name": "@shapediver/api.platform-api-dto-v1",
"version": "2.12.9",
"version": "2.12.11",
"description": "Data Transfer Object Definitions of the Platform API v1",

@@ -5,0 +5,0 @@ "keywords": [

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc