@tokens-studio/sdk

An SDK for tokens interaction throught Tokens Studio

Remarks

The follow namespaces are raw Graphql interactions (queries, mutations ,subscriptions)

Please note they contain the full shapes of all returned objects. Any additional complex operations are exported under sibling namespaces which define more complicated interactions with additional support for validations, etc

Your default interaction model would be to import the required interactions

Example

The following is in typescript and shows how to use API key authentication to retrieve the groups in an organization

import {Configuration,Queries, Graphql ,GroupsQuery } from '@tokens-studio/sdk';

const API_KEY = process.env.API_KEY;
Configuration.setAPIKey(TEST_API_KEY);

const input: GroupsQueryVariables = {organization:'urn:ts:....'};

const groups = await Graphql.exec<GroupsQuery>({
query:Queries.groups,
variables:input
});

console.log(groups.data);

See Configuration for more examples of authentication using other options

Index

Namespaces

Enumerations

Interfaces

Type Aliases

APIKey APIKeyIdentity APIKeyInput APIKeyWithoutValue AcceptInvitationMutation AcceptInvitationMutationVariables AddMemberToGroupMutation AddMemberToGroupMutationVariables AdminOrganizationQuery AdminOrganizationQueryVariables AdminOrganizationUpdateInput AdminOrganizationsQuery AdminOrganizationsQueryVariables AdminUpdateOrganizationMutation AdminUpdateOrganizationMutationVariables ApiKeyFilterInput ApiKeysQuery ApiKeysQueryVariables AttachPolicyToGroupMutation AttachPolicyToGroupMutationVariables Border BorderInput BoxShadow BoxShadowInput BulkCreateTokenMutation BulkCreateTokenMutationVariables Composition CompositionInput ConvertToStaticSetMutation ConvertToStaticSetMutationVariables CreateAPIKeyMutation CreateAPIKeyMutationVariables CreateGeneratorMutation CreateGeneratorMutationVariables CreateGroupMutation CreateGroupMutationVariables CreateOrganizationMutation CreateOrganizationMutationVariables CreatePolicyMutation CreatePolicyMutationVariables CreateProjectMutation CreateProjectMutationVariables CreateReleaseMutation CreateReleaseMutationVariables CreateResolverMutation CreateResolverMutationVariables CreateSDConfigMutation CreateSDConfigMutationVariables CreateThemeGroupMutation CreateThemeGroupMutationVariables CreateTokenMutation CreateTokenMutationVariables CreateTokenSetMutation CreateTokenSetMutationVariables DeclineInvitationMutation DeclineInvitationMutationVariables DeleteAPIKeyMutation DeleteAPIKeyMutationVariables DeleteGeneratorMutation DeleteGeneratorMutationVariables DeleteGroupMutation DeleteGroupMutationVariables DeleteInvitationMutation DeleteInvitationMutationVariables DeleteOrganizationMutation DeleteOrganizationMutationVariables DeletePolicyMutation DeletePolicyMutationVariables DeleteProjectMutation DeleteProjectMutationVariables DeleteResolverMutation DeleteResolverMutationVariables DeleteSDConfigMutation DeleteSDConfigMutationVariables DeleteThemeGroupMutation DeleteThemeGroupMutationVariables DeleteTokenMutation DeleteTokenMutationVariables DeleteTokenSetMutation DeleteTokenSetMutationVariables DeleteTokensMutation DeleteTokensMutationVariables DetachPolicyFromGroupMutation DetachPolicyFromGroupMutationVariables Entity FileInput Generator GeneratorFilterInput GeneratorInput GeneratorQuery GeneratorQueryVariables GeneratorsQuery GeneratorsQueryVariables Group GroupFilterInput GroupInput GroupStringFilterInput GroupUpdateInput GroupUrnFilterInput GroupsQuery GroupsQueryVariables Identity Invitation InviteToOrganizationMutation InviteToOrganizationMutationVariables Metadata OnCreateGroupSubscription OnCreateGroupSubscriptionVariables OnCreateTokenSetSubscription OnCreateTokenSetSubscriptionVariables OnCreateTokenSubscription OnCreateTokenSubscriptionVariables OnDeleteTokenSetSubscription OnDeleteTokenSetSubscriptionVariables OnDeleteTokenSubscription OnDeleteTokenSubscriptionVariables OnUpdateTokenSetSubscription OnUpdateTokenSetSubscriptionVariables OnUpdateTokenSubscription OnUpdateTokenSubscriptionVariables Organization OrganizationFilterInput OrganizationInfo OrganizationInput OrganizationUpdateInput OrganizationsQuery OrganizationsQueryVariables PoliciesQuery PoliciesQueryVariables Policy PolicyDoc PolicyDocInput PolicyInput PolicyInputUpdate PolicyStatement PolicyStatementInput Project ProjectFilterInput ProjectInput ProjectQuery ProjectQueryVariables ProjectSummary ProjectUpdateInput ProjectsQuery ProjectsQueryVariables RawToken RawTokenValue Raw_Token_border Raw_Token_boxShadow Raw_Token_composition Raw_Token_scalar Raw_Token_typography RegenerateApiKeyMutation RegenerateApiKeyMutationVariables Release ReleaseCountQuery ReleaseCountQueryVariables ReleaseDownload ReleaseFile ReleaseFilterInput ReleaseInput ReleasesQuery ReleasesQueryVariables RemoveFromOrganizationMutation RemoveFromOrganizationMutationVariables RemoveMemberFromGroupMutation RemoveMemberFromGroupMutationVariables ResendInvitationMutation ResendInvitationMutationVariables ResolveQuery ResolveQueryVariables ResolvedToken ResolvedTokenValue Resolver ResolverFilterInput ResolverInput ResolverOption ResolverOptionsInput ResolverQuery ResolverQueryVariables ResolverUpdateInput ResolversQuery ResolversQueryVariables SDConfig SDConfigInput Self SelfQuery StringFilterInput SummarizedValue ThemeGroup ThemeGroupInput ThemeOption ThemeOptionInput ThemeOptionQuery ThemeOptionQueryVariables TokenCountQuery TokenCountQueryVariables TokenFilterInput TokenInput TokenQuery TokenQueryVariables TokenSet TokenSetInput TokenSetOrderUpdateInput TokenSetQuery TokenSetQueryVariables TokenSetUpdateInput TokenSetsFilterInput TokenSetsQuery TokenSetsQueryVariables TokenTypeFilterInput TokenUpdateInput Token_border Token_boxShadow Token_composition Token_scalar Token_typography TokensQuery TokensQueryVariables Typography TypographyInput UpdateGeneratorMutation UpdateGeneratorMutationVariables UpdateGroupMutation UpdateGroupMutationVariables UpdateOrganizationMutation UpdateOrganizationMutationVariables UpdatePolicyMutation UpdatePolicyMutationVariables UpdateProjectMutation UpdateProjectMutationVariables UpdateResolverMutation UpdateResolverMutationVariables UpdateSDConfigMutation UpdateSDConfigMutationVariables UpdateSelfInput UpdateSelfMutation UpdateSelfMutationVariables UpdateThemeGroupMutation UpdateThemeGroupMutationVariables UpdateThemeOptionMutation UpdateThemeOptionMutationVariables UpdateTokenMutation UpdateTokenMutationVariables UpdateTokenSetMutation UpdateTokenSetMutationVariables UpdateTokenSetOrderMutation UpdateTokenSetOrderMutationVariables User UserInvitationsQuery UserInvitationsQueryVariables VisibilityInput

Functions

Generated using TypeDoc