0.2.6 • Published 3 months ago

@keyro/kl-sdk-directory v0.2.6

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
3 months ago

Install

yarn add @keyro/kl-sdk-directory

Usage

import { getUser } from '@keyro/kl-sdk-directory'

async foo() {
  const user = await getUser('xxxx-xxxxxx-xxxxx-xxxxxxxx') // You get all fields by default
}

async bar() {
  const user = await getUser('xxxx-xxxxxx-xxxxx-xxxxxxxx', `id avatar`) // You ask only what you want through graphql syntax
}

Doc

Features

functiondescriptionreturns
addResource(resourcesIds, teamId, fields)Add resources to a teamTeam
createOrganization(organization, fields)Create an organizationOrganization
createTeam(team, organizationId, fields)Create a teamTeam
getAllResources(filters, fields)Fetch all resources matching a given filter[Resource]
getOrganization(id, fields)Fetch an organization with idOrganization
getPublicOrganization(id, fields)Fetch the public data of an organization with idOrganization
getTeam(id, fields)Fetch an team with idTeam
getUser(id, fields)Fetch an user with idUser
joinOrganization(userId, organizationId, fields)Make a user member of an organizationOrganization
joinTeam(userIds, teamId, fields)Make a user member of a teamTeam
leaveOrganization(userId, organizationId, fields)Kick a user from an organizationOrganization
leaveTeam(userId, teamId, fields)Kick a user from a teamTeam
resourcesApps(fields)List all available resourcesApps to be use as an enumerationResourceApp
resourcesTypes(fields)List all available resourcesTypes to be use as an enumerationResourceType
saveProfile(user, fields)Save changes to a user profileUser
saveProfilePicture(avatarUrl, fields)Specifically change the user avatar pictureUser
updateOrganization(organization, fields)Save changes made to an organizationOrganization

Objects

type Organization {
  id: ID
  name: String
  siteUri: String
  logoUri: String
  contracted: Boolean,
  description: String
  users: [User]
  paginatedUsers: PaginatedUser
  teams: [Team]
  owners: [User]
  admins: [User]
  employeesLength: Int
  employees: [User]
  createdAt: Datetime
  deletedAt: Datetime
}

input InputOrganizationFilter {
  id: ID
  name: String
}

input InputUserOrganizationCreate {
  name: String
  description: String
  contracted: Boolean,
  siteUri: String
  logoUri: String
}

input InputUserOrganizationUpdate {
  id: ID!
  name: String
  description: String
  contracted: Boolean,
  siteUri: String
  logoUri: String
}
input InputResource {
  id: ID
  name: String
  typeId: ID
  url: String
  appId: ID
}

input InputResourceFilters {
  id: ID
  appId: ID
  typeId: ID
  teamId: ID
  orgId: ID
  userId: ID
}

type Resource {
  id: ID
  name: String
  type: String
  url: String
  app: String
}

type ResourceType {
  id: ID!
  name: String!
}

type ResourceApp {
  id: ID!
  name: String!
}
input InputTeam {
  id: ID
  name: String
  organizationId: ID
}

type Team {
  id: ID
  name: String
  organizationId: ID
  members: [User]
}

type User @key(fields: "id") {
  id: ID!
  email: String!
  firstName: String
  lastName: String
  gender: Gender
  company: String
  birthdate: String
  phone: String
  zipcode: String
  city: String
  address: String
  avatar: String
  alias: String
  createdAt: Datetime
  deletedAt: Datetime
}

input InputUserProfileUpdate {
  email: String!
  firstName: String
  lastName: String
  gender: Gender
  company: String
  birthdate: String
  phone: String
  zipcode: String
  city: String
  address: String
  avatar: String
  alias: String!
}

enum Gender {
  FEMALE
  MALE
  UNKNOWN
}

type PaginatedUser {
  page: Int
  perPage: Int
  items: [User]
  count: Int
}
0.2.6

3 months ago

0.2.5

3 years ago

0.2.4

3 years ago

0.2.3

3 years ago

0.2.2

3 years ago

0.2.1

3 years ago

0.2.0

4 years ago

0.1.7

4 years ago

0.1.6

4 years ago

0.1.5

4 years ago

0.1.4

4 years ago

0.1.4-0

4 years ago

0.1.2

4 years ago

0.1.3

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago

0.0.4

4 years ago

0.0.4-0

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago

0.0.1-7

4 years ago

0.0.1-6

4 years ago

0.0.1-5

4 years ago

0.0.1-8

4 years ago

0.0.1-3

4 years ago

0.0.1-4

4 years ago

0.0.1-2

4 years ago

0.0.1-1

4 years ago

0.0.1-0

4 years ago