API Summary

import { GraphQLClient } from 'graphql-request';
import { getSdk } from '@alpaca-travel/graph-sdk-graphql-request';

// Create a graphql-client
// Note: Substitute your API Access Token
const client = new GraphQLClient('https://withalpaca.com/api/graphql?accessToken=xxx');

// Initialise the SDK
const sdk = getSdk(client);

Collection

• sdk.createCollectionLocation(...) Creates an collection location within the provided collection
• sdk.deleteCollectionLocation(...) Removes a collection location from a collection
• sdk.findCollectionLocationIdsByExternal(...) Find collection location IDs by external identifiers
• sdk.findCollectionLocationIdsByTag(...) Find collection location IDs by a specific tag
• sdk.findCollectionLocationsByExternal(...) Find collection location IDs by an external ID
• sdk.findCollectionLocationsByTag(...) Find collection locations by a specific tag
• sdk.getCollectionLocation(...) Obtain informationa bout a collection location
• sdk.getCollection(...) Obtains information about a collection
• sdk.listCollections(...) Obtain a listing of the collections for a profile
• sdk.updateCollectionLocation(...) Update the collection location

Itinerary

• sdk.createItineraryDirections(...) Creates itinerary directions for between locations in an itinerary manually
• sdk.createItineraryLocation(...) Creates a new Itinerary Location, which can contain place information
• sdk.createItinerary(...) Creates a new Itinerary data structure for organising an itinerary
• sdk.deleteItineraryLocation(...) Removes an itinerary location from an itinerary
• sdk.deleteItinerary(...) Removes an itinerary
• sdk.disableItineraryAutoRoute(...) Modifies an itinerary to disable the automatic routing feature, which will turn off determining the directions between the sequence of locations that the itinerary contains
• sdk.enableItineraryAutoRoute(...) Modifies an itinerary to enable a feature that will automatically determine directions between a sequence of itinerary locations at the top level
• sdk.findItineraryLocationIdsByPlaceId(...) Checks whether a place has been added to an itinerary, for creating a button state on an "Add to Itinerary" button
• sdk.findItineraryLocationsByPlaceId(...) Checks whether a place has been added to an itinerary, for creating a button state on an "Add to Itinerary" button
• sdk.getItineraryDirections(...) Obtains an itinerary directions item
• sdk.getItineraryLocation(...) Loads information about an itinerary location
• sdk.getItinerary(...) Loads information about an individual itinerary
• sdk.listItineraries(...) Query a list of itineraries from an associated profile
• sdk.listItineraryLocations(...) Lists in itinerary locations for a provided Itinerary
• sdk.moveItineraryLocationAfter(...) Moves an itinerary location after another itinerary location
• sdk.moveItineraryLocationToStart(...) Moves an itinerary location ahead of other itinerary locations
• sdk.updateItineraryLocationIsOptional(...) Marks an itinerary location whether it is an optional stop
• sdk.updateItineraryLocation(...) Updates the itinerary location
• sdk.updateItinerary(...) Updates an itinerary

Media

• sdk.getMediaImage(...) Loads information about a media

Place

• sdk.autocompleteSearchPlace(...) Searches for places using Autocomplete search term
• sdk.getPlace(...) Gets a place based on the provided place ID
• sdk.reverseSearchPlaceByPosition(...) Queries a position and returns with matching places

Profile

• sdk.getProfile(...) Obtains the profile by the provided ID
• sdk.listAuthorizedProfiles(...) Obtains a list of the authorized profiles for the current access token

Route

• sdk.searchRoutesBetweenPositions(...) Searches for routes between provided positions