OBJECT

Query

Available Queries

link GraphQL Schema definition

  • type Query {
  • # Returns the Pantone Book by ID
  • #
  • # Arguments
  • # id:
  • getBook(id: ID!): Book
  • # Returns all the Pantone Books
  • getBooks: [Book]
  • # Returns a Pantone Color by code (ID)
  • #
  • # Arguments
  • # code:
  • getColor(code: String!): Color
  • # Returns the Pantone Colors and data about the search result
  • # #### It returns maximum 100 colors
  • #
  • # Arguments
  • # textFilter:
  • # bookId:
  • getColors(textFilter: String, bookId: ID): ColorsSearch
  • # Returns requested Pantone Colors (by their code)
  • # #### Maximum numbers of colors to request is 10
  • #
  • # Arguments
  • # codes:
  • getColorsByCode(codes: [String]): [Color]
  • # Returns the closest Pantone Colors to the input Color.
  • # #### The input Color can be specified by code (Pantone Color ID) or by one of
  • # the available color spaces.
  • #
  • # Arguments
  • # bookId: Pantone Book ID.
  • # #### If specified, the results will be taken only from that Book. Otherwise they
  • # will be taken from all Pantone Boooks.
  • # colorCode: Input Color as Pantone Color, by code
  • # colorRGB: Input Color by RGB values
  • # colorCMYK: Input Color by CMYK values
  • # colorHex: Input Color by Hexadecimal value
  • # colorLAB: Input Color by L*a*b* values.
  • # #### Usage of this parameter needs specific permissions
  • getClosestColors(
  • bookId: ID,
  • colorCode: String,
  • colorRGB: RGBInput,
  • colorCMYK: CMYKInput,
  • colorHex: String,
  • colorLAB: LABInput
  • ): [Color]
  • # Returns the closest Pantone Colors from all books.
  • # #### The input Color can be specified by code (Pantone Color ID) or by one of
  • # the available color spaces.
  • #
  • # Arguments
  • # colorCode: Input Color as Pantone Color, by code
  • # colorRGB: Input Color by RGB values
  • # colorCMYK: Input Color by CMYK values
  • # colorHex: Input Color by Hexadecimal value
  • # colorLAB: Input Color by L*a*b* values.
  • # #### Usage of this parameter needs specific permissions
  • getClosestColorsFromAllBooks(
  • colorCode: String,
  • colorRGB: RGBInput,
  • colorCMYK: CMYKInput,
  • colorHex: String,
  • colorLAB: LABInput
  • ): [ClosestColorsFromAllBooks]
  • # Returns the Harmony of the specified Pantone Color
  • #
  • # Arguments
  • # colorCode:
  • # harmony:
  • getHarmony(colorCode: String!, harmony: Harmony!): [Color]
  • # Returns the Shades of the specified Pantone Color
  • #
  • # Arguments
  • # colorCode:
  • getShades(colorCode: String!): ColorShades
  • # Returns a Palette
  • #
  • # Arguments
  • # id:
  • getPalette(id: ID!): Palette
  • # Returns Palettes of the current User (sorted by most recent)
  • #
  • # Arguments
  • # limit:
  • # nextToken:
  • getPalettes(limit: Int, nextToken: String): PaletteConnection
  • # Returns Palettes shared with the current User (not sorted)
  • getSharedPalettes: [Palette]
  • # Returns Moodboards of the current User (sorted by most recent)
  • #
  • # Arguments
  • # limit:
  • # nextToken:
  • getMoodboards(limit: Int, nextToken: String): MoodboardConnection
  • # Returns a Moodboard
  • #
  • # Arguments
  • # id:
  • getMoodboard(id: ID!): Moodboard
  • # Returns Palettes shared with the current User (not sorted)
  • getSharedMoodboards: [Moodboard]
  • # Returns FastSpring subscriptions data
  • getSubscription: FastSpringSubscription
  • # Sync User Subscriptions
  • syncUserSubscriptions: SyncUserSubscriptions
  • # Returns preisgned URL for uploading files to S3
  • getPresignedUrl: S3PresignedURL
  • # Returns FastSpring info to manage own subscriptions
  • getSubscriptionManagement: SubscriptionManagement
  • # Arguments
  • # deleteNow:
  • cancelSubscription(deleteNow: Boolean): FastSpringSubscription
  • # Delete a custom user Data
  • deleteUserData: DeleteUserDataOutput
  • # Returns user machine ID
  • #
  • # Arguments
  • # machineId:
  • getUserMachineTrialPeriod(machineId: String!): UserMachineId
  • # Returns user data
  • getUserData: UserData
  • # Returns the Coupon Code by ID
  • #
  • # Arguments
  • # id:
  • getCouponCode(id: ID!): CouponCode
  • # Returns the Country of the user based on the location.
  • getAndStoreCurrentCountry: UserCountry
  • # Returns type of user account based on email.
  • #
  • # Arguments
  • # email:
  • getAccountType(email: String!): AccountType
  • # Returns FastSpring products pricing information
  • getProducts: Products
  • # Returns articles from Contentful
  • #
  • # Arguments
  • # subscriptionType: TODO: remove this argument. temporarily
  • # passing here for development
  • getArticles(subscriptionType: String): GetArticlesResponse!
  • # Returns a single article from Contentful
  • #
  • # Arguments
  • # articleId: id or slug
  • # subscriptionType: TODO: remove this argument. temporarily
  • # passing here for development
  • getArticle(articleId: String!, subscriptionType: String): Article
  • # Returns an article carousel from Contentful
  • #
  • # Arguments
  • # id: id or slug
  • getArticleCarousel(id: String!): ContentfulArticleCarousel
  • # Returns articles from Contentful; doesn't check subscription status and
  • # always uses unentitled state
  • syndicateArticles: GetArticlesResponse!
  • # Returns a single article from Contentful; doesn't check subscription status and
  • # always uses unentitled state
  • #
  • # Arguments
  • # articleId: id or slug
  • syndicateArticle(articleId: String!): Article
  • # Returns an article carousel from Contentful; doesn't check subscription status
  • # and
  • # always uses unentitled state
  • #
  • # Arguments
  • # id: id or slug
  • syndicateArticleCarousel(id: String!): ContentfulArticleCarousel
  • # Returns the announcement popup from Contentful
  • getAnnouncementPopup: AnnouncementPopup
  • # Returns colors statistics
  • #
  • # Arguments
  • # type: type of statictis to get
  • # filter: location and time filters for statistics
  • getStatistics(type: String!, filter: StatisticsFilter!): ColorStatistics
  • }

link Require by

This element is not required by anyone