@foxy.io/sdk/dist/types/backend/Graph/index.d.ts

Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.

import type * as Core from '../../core';
import type { Encode } from './encode';
import type { PropertyHelpers } from './property_helpers';
import type { Reporting } from './reporting';
import type { Store } from './store';
import type { Stores } from './stores';
import type { User } from './user';

export interface Graph extends Core.Graph {
  links: {
    /** Your API starting point. */
    'self': Graph;
    /** Various helpers used for determing valid property values. */
    'fx:property_helpers': PropertyHelpers;
    /** Reporting API home. */
    'fx:reporting': Reporting;
    /** POST here to encode a body of html for use with our HMAC cart encryption. */
    'fx:encode': Encode;
    /** Your stores. */
    'fx:stores': Stores;
    /** The current store for your authentication token. */
    'fx:store': Store;
    /** OAuth endpoint for obtaining an access + refresh token pair. Please use the `FoxySDK.Backend.API.getAccessToken()` method to work with this endpoint. */
    'fx:token': never;
    /** Your API home page. */
    'fx:user': User;
  };

  props: {
    /** A small, human readable explanation of this resource. */
    message: string;
  };
}