https://github.com/foodee/master-fox-client
Generated master fox JavaScript client
https://github.com/foodee/master-fox-client
Last synced: over 1 year ago
JSON representation
Generated master fox JavaScript client
- Host: GitHub
- URL: https://github.com/foodee/master-fox-client
- Owner: Foodee
- Created: 2017-10-17T15:36:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T15:15:52.000Z (over 3 years ago)
- Last Synced: 2025-01-21T20:48:54.992Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1000 KB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MasterFox JSONAPI Client
MasterFox is a a JSONAPI compliant api details can be found here: http://jsonapi.org/
## TOC
| ResourceName | | | |
| --- | --- | --- | --- |
AccountingConsolidationConfiguration | [Data Access Object](#resource-dao-AccountingConsolidationConfiguration) | [Schema](#resource-AccountingConsolidationConfiguration) | [Filter Definition](#resource-filter-AccountingConsolidationConfiguration) |
AccountingConsolidationRun | [Data Access Object](#resource-dao-AccountingConsolidationRun) | [Schema](#resource-AccountingConsolidationRun) | [Filter Definition](#resource-filter-AccountingConsolidationRun) |
AccountingLedgerItem | [Data Access Object](#resource-dao-AccountingLedgerItem) | [Schema](#resource-AccountingLedgerItem) | [Filter Definition](#resource-filter-AccountingLedgerItem) |
AccountingLineItem | [Data Access Object](#resource-dao-AccountingLineItem) | [Schema](#resource-AccountingLineItem) | [Filter Definition](#resource-filter-AccountingLineItem) |
AppConfiguration | [Data Access Object](#resource-dao-AppConfiguration) | [Schema](#resource-AppConfiguration) | [Filter Definition](#resource-filter-AppConfiguration) |
Area | [Data Access Object](#resource-dao-Area) | [Schema](#resource-Area) | [Filter Definition](#resource-filter-Area) |
AreaClosure | [Data Access Object](#resource-dao-AreaClosure) | [Schema](#resource-AreaClosure) | [Filter Definition](#resource-filter-AreaClosure) |
Client | [Data Access Object](#resource-dao-Client) | [Schema](#resource-Client) | [Filter Definition](#resource-filter-Client) |
ClientDiscount | [Data Access Object](#resource-dao-ClientDiscount) | [Schema](#resource-ClientDiscount) | [Filter Definition](#resource-filter-ClientDiscount) |
ClientOrderInvoice | [Data Access Object](#resource-dao-ClientOrderInvoice) | [Schema](#resource-ClientOrderInvoice) | [Filter Definition](#resource-filter-ClientOrderInvoice) |
ClientSignup | [Data Access Object](#resource-dao-ClientSignup) | [Schema](#resource-ClientSignup) | [Filter Definition](#resource-filter-ClientSignup) |
CommunicationPreference | [Data Access Object](#resource-dao-CommunicationPreference) | [Schema](#resource-CommunicationPreference) | [Filter Definition](#resource-filter-CommunicationPreference) |
Company | [Data Access Object](#resource-dao-Company) | [Schema](#resource-Company) | [Filter Definition](#resource-filter-Company) |
Contact | [Data Access Object](#resource-dao-Contact) | [Schema](#resource-Contact) | [Filter Definition](#resource-filter-Contact) |
Courier | [Data Access Object](#resource-dao-Courier) | [Schema](#resource-Courier) | [Filter Definition](#resource-filter-Courier) |
CurrenciesCurrency | [Data Access Object](#resource-dao-CurrenciesCurrency) | [Schema](#resource-CurrenciesCurrency) | [Filter Definition](#resource-filter-CurrenciesCurrency) |
CurrenciesTransaction | [Data Access Object](#resource-dao-CurrenciesTransaction) | [Schema](#resource-CurrenciesTransaction) | [Filter Definition](#resource-filter-CurrenciesTransaction) |
CurrenciesWallet | [Data Access Object](#resource-dao-CurrenciesWallet) | [Schema](#resource-CurrenciesWallet) | [Filter Definition](#resource-filter-CurrenciesWallet) |
DeliveryCase | [Data Access Object](#resource-dao-DeliveryCase) | [Schema](#resource-DeliveryCase) | [Filter Definition](#resource-filter-DeliveryCase) |
DeliveryLocation | [Data Access Object](#resource-dao-DeliveryLocation) | [Schema](#resource-DeliveryLocation) | [Filter Definition](#resource-filter-DeliveryLocation) |
DeskCase | [Data Access Object](#resource-dao-DeskCase) | [Schema](#resource-DeskCase) | [Filter Definition](#resource-filter-DeskCase) |
DietaryTag | [Data Access Object](#resource-dao-DietaryTag) | [Schema](#resource-DietaryTag) | [Filter Definition](#resource-filter-DietaryTag) |
DiscountCode | [Data Access Object](#resource-dao-DiscountCode) | [Schema](#resource-DiscountCode) | [Filter Definition](#resource-filter-DiscountCode) |
DriverDay | [Data Access Object](#resource-dao-DriverDay) | [Schema](#resource-DriverDay) | [Filter Definition](#resource-filter-DriverDay) |
DriverPayment | [Data Access Object](#resource-dao-DriverPayment) | [Schema](#resource-DriverPayment) | [Filter Definition](#resource-filter-DriverPayment) |
DriverPayrollRun | [Data Access Object](#resource-dao-DriverPayrollRun) | [Schema](#resource-DriverPayrollRun) | [Filter Definition](#resource-filter-DriverPayrollRun) |
DriverPing | [Data Access Object](#resource-dao-DriverPing) | [Schema](#resource-DriverPing) | [Filter Definition](#resource-filter-DriverPing) |
DriverResource | [Data Access Object](#resource-dao-DriverResource) | [Schema](#resource-DriverResource) | [Filter Definition](#resource-filter-DriverResource) |
DriverWeek | [Data Access Object](#resource-dao-DriverWeek) | [Schema](#resource-DriverWeek) | [Filter Definition](#resource-filter-DriverWeek) |
EmailMessage | [Data Access Object](#resource-dao-EmailMessage) | [Schema](#resource-EmailMessage) | [Filter Definition](#resource-filter-EmailMessage) |
Event | [Data Access Object](#resource-dao-Event) | [Schema](#resource-Event) | [Filter Definition](#resource-filter-Event) |
FeatureFlagDescription | [Data Access Object](#resource-dao-FeatureFlagDescription) | [Schema](#resource-FeatureFlagDescription) | [Filter Definition](#resource-filter-FeatureFlagDescription) |
FoodType | [Data Access Object](#resource-dao-FoodType) | [Schema](#resource-FoodType) | [Filter Definition](#resource-filter-FoodType) |
GiftbitCard | [Data Access Object](#resource-dao-GiftbitCard) | [Schema](#resource-GiftbitCard) | [Filter Definition](#resource-filter-GiftbitCard) |
GiftbitError | [Data Access Object](#resource-dao-GiftbitError) | [Schema](#resource-GiftbitError) | [Filter Definition](#resource-filter-GiftbitError) |
GiftbitGift | [Data Access Object](#resource-dao-GiftbitGift) | [Schema](#resource-GiftbitGift) | [Filter Definition](#resource-filter-GiftbitGift) |
GroupOrderMember | [Data Access Object](#resource-dao-GroupOrderMember) | [Schema](#resource-GroupOrderMember) | [Filter Definition](#resource-filter-GroupOrderMember) |
HistorianVersion | [Data Access Object](#resource-dao-HistorianVersion) | [Schema](#resource-HistorianVersion) | [Filter Definition](#resource-filter-HistorianVersion) |
Invoice | [Data Access Object](#resource-dao-Invoice) | [Schema](#resource-Invoice) | [Filter Definition](#resource-filter-Invoice) |
InvoicingLedgerItem | [Data Access Object](#resource-dao-InvoicingLedgerItem) | [Schema](#resource-InvoicingLedgerItem) | [Filter Definition](#resource-filter-InvoicingLedgerItem) |
InvoicingTaxRate | [Data Access Object](#resource-dao-InvoicingTaxRate) | [Schema](#resource-InvoicingTaxRate) | [Filter Definition](#resource-filter-InvoicingTaxRate) |
Location | [Data Access Object](#resource-dao-Location) | [Schema](#resource-Location) | [Filter Definition](#resource-filter-Location) |
LogisticsArrivalEstimate | [Data Access Object](#resource-dao-LogisticsArrivalEstimate) | [Schema](#resource-LogisticsArrivalEstimate) | [Filter Definition](#resource-filter-LogisticsArrivalEstimate) |
LogisticsDelivery | [Data Access Object](#resource-dao-LogisticsDelivery) | [Schema](#resource-LogisticsDelivery) | [Filter Definition](#resource-filter-LogisticsDelivery) |
MealPlan | [Data Access Object](#resource-dao-MealPlan) | [Schema](#resource-MealPlan) | [Filter Definition](#resource-filter-MealPlan) |
MealPlanningEvent | [Data Access Object](#resource-dao-MealPlanningEvent) | [Schema](#resource-MealPlanningEvent) | [Filter Definition](#resource-filter-MealPlanningEvent) |
MealPlanningInstance | [Data Access Object](#resource-dao-MealPlanningInstance) | [Schema](#resource-MealPlanningInstance) | [Filter Definition](#resource-filter-MealPlanningInstance) |
MealPlanningLogRecord | [Data Access Object](#resource-dao-MealPlanningLogRecord) | [Schema](#resource-MealPlanningLogRecord) | [Filter Definition](#resource-filter-MealPlanningLogRecord) |
MealPlanningPreferenceProfile | [Data Access Object](#resource-dao-MealPlanningPreferenceProfile) | [Schema](#resource-MealPlanningPreferenceProfile) | [Filter Definition](#resource-filter-MealPlanningPreferenceProfile) |
MealPlanningRequirement | [Data Access Object](#resource-dao-MealPlanningRequirement) | [Schema](#resource-MealPlanningRequirement) | [Filter Definition](#resource-filter-MealPlanningRequirement) |
MealPlanningRequirementConstraint | [Data Access Object](#resource-dao-MealPlanningRequirementConstraint) | [Schema](#resource-MealPlanningRequirementConstraint) | [Filter Definition](#resource-filter-MealPlanningRequirementConstraint) |
MealPlanningRequirementGroup | [Data Access Object](#resource-dao-MealPlanningRequirementGroup) | [Schema](#resource-MealPlanningRequirementGroup) | [Filter Definition](#resource-filter-MealPlanningRequirementGroup) |
MealPlanningReservation | [Data Access Object](#resource-dao-MealPlanningReservation) | [Schema](#resource-MealPlanningReservation) | [Filter Definition](#resource-filter-MealPlanningReservation) |
MealPlanningRestaurantConstraint | [Data Access Object](#resource-dao-MealPlanningRestaurantConstraint) | [Schema](#resource-MealPlanningRestaurantConstraint) | [Filter Definition](#resource-filter-MealPlanningRestaurantConstraint) |
MealPlanningSchedule | [Data Access Object](#resource-dao-MealPlanningSchedule) | [Schema](#resource-MealPlanningSchedule) | [Filter Definition](#resource-filter-MealPlanningSchedule) |
MealPlanningTemplate | [Data Access Object](#resource-dao-MealPlanningTemplate) | [Schema](#resource-MealPlanningTemplate) | [Filter Definition](#resource-filter-MealPlanningTemplate) |
MealType | [Data Access Object](#resource-dao-MealType) | [Schema](#resource-MealType) | [Filter Definition](#resource-filter-MealType) |
Menu | [Data Access Object](#resource-dao-Menu) | [Schema](#resource-Menu) | [Filter Definition](#resource-filter-Menu) |
MenuGroup | [Data Access Object](#resource-dao-MenuGroup) | [Schema](#resource-MenuGroup) | [Filter Definition](#resource-filter-MenuGroup) |
MenuItem | [Data Access Object](#resource-dao-MenuItem) | [Schema](#resource-MenuItem) | [Filter Definition](#resource-filter-MenuItem) |
MenuOptionGroup | [Data Access Object](#resource-dao-MenuOptionGroup) | [Schema](#resource-MenuOptionGroup) | [Filter Definition](#resource-filter-MenuOptionGroup) |
MenuOptionItem | [Data Access Object](#resource-dao-MenuOptionItem) | [Schema](#resource-MenuOptionItem) | [Filter Definition](#resource-filter-MenuOptionItem) |
NotificationLog | [Data Access Object](#resource-dao-NotificationLog) | [Schema](#resource-NotificationLog) | [Filter Definition](#resource-filter-NotificationLog) |
Order | [Data Access Object](#resource-dao-Order) | [Schema](#resource-Order) | [Filter Definition](#resource-filter-Order) |
OrderItem | [Data Access Object](#resource-dao-OrderItem) | [Schema](#resource-OrderItem) | [Filter Definition](#resource-filter-OrderItem) |
PaymentAccount | [Data Access Object](#resource-dao-PaymentAccount) | [Schema](#resource-PaymentAccount) | [Filter Definition](#resource-filter-PaymentAccount) |
PaymentCard | [Data Access Object](#resource-dao-PaymentCard) | [Schema](#resource-PaymentCard) | [Filter Definition](#resource-filter-PaymentCard) |
PayrollRun | [Data Access Object](#resource-dao-PayrollRun) | [Schema](#resource-PayrollRun) | [Filter Definition](#resource-filter-PayrollRun) |
PickupLocation | [Data Access Object](#resource-dao-PickupLocation) | [Schema](#resource-PickupLocation) | [Filter Definition](#resource-filter-PickupLocation) |
PromoCode | [Data Access Object](#resource-dao-PromoCode) | [Schema](#resource-PromoCode) | [Filter Definition](#resource-filter-PromoCode) |
QualifyingQuestion | [Data Access Object](#resource-dao-QualifyingQuestion) | [Schema](#resource-QualifyingQuestion) | [Filter Definition](#resource-filter-QualifyingQuestion) |
ReleaseNote | [Data Access Object](#resource-dao-ReleaseNote) | [Schema](#resource-ReleaseNote) | [Filter Definition](#resource-filter-ReleaseNote) |
Restaurant | [Data Access Object](#resource-dao-Restaurant) | [Schema](#resource-Restaurant) | [Filter Definition](#resource-filter-Restaurant) |
RestaurantCapacityTranche | [Data Access Object](#resource-dao-RestaurantCapacityTranche) | [Schema](#resource-RestaurantCapacityTranche) | [Filter Definition](#resource-filter-RestaurantCapacityTranche) |
RestaurantClosure | [Data Access Object](#resource-dao-RestaurantClosure) | [Schema](#resource-RestaurantClosure) | [Filter Definition](#resource-filter-RestaurantClosure) |
RestaurantDiscount | [Data Access Object](#resource-dao-RestaurantDiscount) | [Schema](#resource-RestaurantDiscount) | [Filter Definition](#resource-filter-RestaurantDiscount) |
RestaurantOrderInvoice | [Data Access Object](#resource-dao-RestaurantOrderInvoice) | [Schema](#resource-RestaurantOrderInvoice) | [Filter Definition](#resource-filter-RestaurantOrderInvoice) |
RestaurantRanking | [Data Access Object](#resource-dao-RestaurantRanking) | [Schema](#resource-RestaurantRanking) | [Filter Definition](#resource-filter-RestaurantRanking) |
RestaurantVote | [Data Access Object](#resource-dao-RestaurantVote) | [Schema](#resource-RestaurantVote) | [Filter Definition](#resource-filter-RestaurantVote) |
Role | [Data Access Object](#resource-dao-Role) | [Schema](#resource-Role) | [Filter Definition](#resource-filter-Role) |
SalesforceCase | [Data Access Object](#resource-dao-SalesforceCase) | [Schema](#resource-SalesforceCase) | [Filter Definition](#resource-filter-SalesforceCase) |
SalesforceSyncError | [Data Access Object](#resource-dao-SalesforceSyncError) | [Schema](#resource-SalesforceSyncError) | [Filter Definition](#resource-filter-SalesforceSyncError) |
ServiceTime | [Data Access Object](#resource-dao-ServiceTime) | [Schema](#resource-ServiceTime) | [Filter Definition](#resource-filter-ServiceTime) |
SubscriptionPlan | [Data Access Object](#resource-dao-SubscriptionPlan) | [Schema](#resource-SubscriptionPlan) | [Filter Definition](#resource-filter-SubscriptionPlan) |
Tag | [Data Access Object](#resource-dao-Tag) | [Schema](#resource-Tag) | [Filter Definition](#resource-filter-Tag) |
Team | [Data Access Object](#resource-dao-Team) | [Schema](#resource-Team) | [Filter Definition](#resource-filter-Team) |
User | [Data Access Object](#resource-dao-User) | [Schema](#resource-User) | [Filter Definition](#resource-filter-User) |
UserFeedback | [Data Access Object](#resource-dao-UserFeedback) | [Schema](#resource-UserFeedback) | [Filter Definition](#resource-filter-UserFeedback) |
UserInvite | [Data Access Object](#resource-dao-UserInvite) | [Schema](#resource-UserInvite) | [Filter Definition](#resource-filter-UserInvite) |
## Data Access
Data access objects are connected to the base of the MasterFox client. You can initialize a new MasterFox client using the
following code:
```JavaScript
import MasterFox from 'master-fox-client';
const client = new MasterFox('https://food.ee/', '');
```
You can also connect using an email and password as follows:
```JavaScript
import MasterFox from 'master-fox-client';
const client = await MasterFox.login('https://food.ee/', '', '');
// will be your current API token, you can save this in order to prevent subsequent logins
// NOTE: never store a user's password but rather use this to power login experiences and store
// the resulting tokens
client.apiKey;
```
Once connected, any of the resource, and their related resources may be accessed using the patterns outlined in this section below
#### IndexResult
Note that any of the index endpoints will return an IndexResult which contains an array of results with additional meta information
about the contained results with regards to pagination. It supports standard higher order functions (map, filter, reduce) and also
supports the following:
```javascript
const result = await = client.restaurants.index();
result.hasMore; // true / false if there are more results on the server
result.total; // total number of records on the server
result.length; // total number of records in this request
```
### AccountingConsolidationConfiguration
See [AccountingConsolidationConfigurationFilter](#resource-filter-AccountingConsolidationConfiguration) for valid filters.
See [AccountingConsolidationConfiguration](#resource-AccountingConsolidationConfiguration) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleAccountingConsolidationConfiguration= await client.accountingConsolidationConfigurations.get(1, options);
const pagedIndexOfAccountingConsolidationConfigurations = await client.accountingConsolidationConfigurations.index(options);
// Related Resources
// To One
// Get AccountingConsolidationConfiguration#1's paymentCard
const singlePaymentCard = await client.accountingConsolidationConfigurations.from(1).get.paymentCard(1, options);
// Get AccountingConsolidationConfiguration#1's client
const singleClient = await client.accountingConsolidationConfigurations.from(1).get.client(1, options);
// To Many
// Index AccountingConsolidationConfiguration#1's runs
const pagedIndexOfAccountingConsolidationRuns = await client.accountingConsolidationConfigurations.from(1).index.runs(options);
```
### AccountingConsolidationRun
See [AccountingConsolidationRunFilter](#resource-filter-AccountingConsolidationRun) for valid filters.
See [AccountingConsolidationRun](#resource-AccountingConsolidationRun) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleAccountingConsolidationRun= await client.accountingConsolidationRuns.get(1, options);
const pagedIndexOfAccountingConsolidationRuns = await client.accountingConsolidationRuns.index(options);
// Related Resources
// To One
// Get AccountingConsolidationRun#1's configuration
const singleAccountingConsolidationConfiguration = await client.accountingConsolidationRuns.from(1).get.configuration(1, options);
// Get AccountingConsolidationRun#1's invoice
const singleAccountingLedgerItem = await client.accountingConsolidationRuns.from(1).get.invoice(1, options);
// Get AccountingConsolidationRun#1's client
const singleClient = await client.accountingConsolidationRuns.from(1).get.client(1, options);
```
### AccountingLedgerItem
See [AccountingLedgerItemFilter](#resource-filter-AccountingLedgerItem) for valid filters.
See [AccountingLedgerItem](#resource-AccountingLedgerItem) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleAccountingLedgerItem= await client.accountingLedgerItems.get(1, options);
const pagedIndexOfAccountingLedgerItems = await client.accountingLedgerItems.index(options);
// Related Resources
// To One
// Get AccountingLedgerItem#1's parent
const singleAccountingLedgerItem = await client.accountingLedgerItems.from(1).get.parent(1, options);
// To Many
// Index AccountingLedgerItem#1's lineItems
const pagedIndexOfAccountingLineItems = await client.accountingLedgerItems.from(1).index.lineItems(options);
// Index AccountingLedgerItem#1's children
const pagedIndexOfAccountingLedgerItems = await client.accountingLedgerItems.from(1).index.children(options);
```
### AccountingLineItem
See [AccountingLineItemFilter](#resource-filter-AccountingLineItem) for valid filters.
See [AccountingLineItem](#resource-AccountingLineItem) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleAccountingLineItem= await client.accountingLineItems.get(1, options);
const pagedIndexOfAccountingLineItems = await client.accountingLineItems.index(options);
// Related Resources
// To One
// Get AccountingLineItem#1's ledgerItem
const singleAccountingLedgerItem = await client.accountingLineItems.from(1).get.ledgerItem(1, options);
```
### AppConfiguration
See [AppConfigurationFilter](#resource-filter-AppConfiguration) for valid filters.
See [AppConfiguration](#resource-AppConfiguration) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleAppConfiguration= await client.appConfigurations.get(1, options);
const pagedIndexOfAppConfigurations = await client.appConfigurations.index(options);
// Related Resources
// To Many
// Index AppConfiguration#1's versions
const pagedIndexOfHistorianVersions = await client.appConfigurations.from(1).index.versions(options);
```
### Area
See [AreaFilter](#resource-filter-Area) for valid filters.
See [Area](#resource-Area) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleArea= await client.areas.get(1, options);
const pagedIndexOfAreas = await client.areas.index(options);
// Related Resources
// To One
// Get Area#1's deliveryFeeTaxRate
const singleInvoicingTaxRate = await client.areas.from(1).get.deliveryFeeTaxRate(1, options);
// To Many
// Index Area#1's couriers
const pagedIndexOfCouriers = await client.areas.from(1).index.couriers(options);
// Index Area#1's clients
const pagedIndexOfClients = await client.areas.from(1).index.clients(options);
// Index Area#1's restaurants
const pagedIndexOfRestaurants = await client.areas.from(1).index.restaurants(options);
// Index Area#1's invoicingTaxRates
const pagedIndexOfInvoicingTaxRates = await client.areas.from(1).index.invoicingTaxRates(options);
// Index Area#1's globalInvoicingTaxRates
const pagedIndexOfInvoicingTaxRates = await client.areas.from(1).index.globalInvoicingTaxRates(options);
// Index Area#1's areaClosures
const pagedIndexOfAreaClosures = await client.areas.from(1).index.areaClosures(options);
// Index Area#1's currentWeekAreaClosures
const pagedIndexOfAreaClosures = await client.areas.from(1).index.currentWeekAreaClosures(options);
// Index Area#1's promoCodes
const pagedIndexOfPromoCodes = await client.areas.from(1).index.promoCodes(options);
// Index Area#1's orders
const pagedIndexOfOrders = await client.areas.from(1).index.orders(options);
// Index Area#1's versions
const pagedIndexOfHistorianVersions = await client.areas.from(1).index.versions(options);
// Index Area#1's allAreaVersions
const pagedIndexOfHistorianVersions = await client.areas.from(1).index.allAreaVersions(options);
```
### AreaClosure
See [AreaClosureFilter](#resource-filter-AreaClosure) for valid filters.
See [AreaClosure](#resource-AreaClosure) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleAreaClosure= await client.areaClosures.get(1, options);
const pagedIndexOfAreaClosures = await client.areaClosures.index(options);
// Related Resources
// To One
// Get AreaClosure#1's area
const singleArea = await client.areaClosures.from(1).get.area(1, options);
```
### Client
See [ClientFilter](#resource-filter-Client) for valid filters.
See [Client](#resource-Client) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleClient= await client.clients.get(1, options);
const pagedIndexOfClients = await client.clients.index(options);
// Related Resources
// To One
// Get Client#1's defaultArea
const singleArea = await client.clients.from(1).get.defaultArea(1, options);
// Get Client#1's billingLocation
const singleLocation = await client.clients.from(1).get.billingLocation(1, options);
// Get Client#1's billingContact
const singleContact = await client.clients.from(1).get.billingContact(1, options);
// Get Client#1's subscriptionPlan
const singleSubscriptionPlan = await client.clients.from(1).get.subscriptionPlan(1, options);
// Get Client#1's accountManager
const singleUser = await client.clients.from(1).get.accountManager(1, options);
// Get Client#1's owner
const singleUser = await client.clients.from(1).get.owner(1, options);
// Get Client#1's salesSupport
const singleUser = await client.clients.from(1).get.salesSupport(1, options);
// Get Client#1's company
const singleCompany = await client.clients.from(1).get.company(1, options);
// Get Client#1's mealPlan
const singleMealPlan = await client.clients.from(1).get.mealPlan(1, options);
// Get Client#1's preferenceProfile
const singleMealPlanningPreferenceProfile = await client.clients.from(1).get.preferenceProfile(1, options);
// Get Client#1's taxRate
const singleInvoicingTaxRate = await client.clients.from(1).get.taxRate(1, options);
// Get Client#1's giftbitCard
const singleGiftbitCard = await client.clients.from(1).get.giftbitCard(1, options);
// Get Client#1's wallet
const singleCurrenciesWallet = await client.clients.from(1).get.wallet(1, options);
// To Many
// Index Client#1's areas
const pagedIndexOfAreas = await client.clients.from(1).index.areas(options);
// Index Client#1's deliveryLocations
const pagedIndexOfDeliveryLocations = await client.clients.from(1).index.deliveryLocations(options);
// Index Client#1's paymentCards
const pagedIndexOfPaymentCards = await client.clients.from(1).index.paymentCards(options);
// Index Client#1's adminContacts
const pagedIndexOfContacts = await client.clients.from(1).index.adminContacts(options);
// Index Client#1's admins
const pagedIndexOfUsers = await client.clients.from(1).index.admins(options);
// Index Client#1's orderContacts
const pagedIndexOfContacts = await client.clients.from(1).index.orderContacts(options);
// Index Client#1's orders
const pagedIndexOfOrders = await client.clients.from(1).index.orders(options);
// Index Client#1's contacts
const pagedIndexOfContacts = await client.clients.from(1).index.contacts(options);
// Index Client#1's teams
const pagedIndexOfTeams = await client.clients.from(1).index.teams(options);
// Index Client#1's allClientVersions
const pagedIndexOfHistorianVersions = await client.clients.from(1).index.allClientVersions(options);
// Index Client#1's versions
const pagedIndexOfHistorianVersions = await client.clients.from(1).index.versions(options);
// Index Client#1's mealPlanningTemplates
const pagedIndexOfMealPlanningTemplates = await client.clients.from(1).index.mealPlanningTemplates(options);
// Index Client#1's mealPlanningInstances
const pagedIndexOfMealPlanningInstances = await client.clients.from(1).index.mealPlanningInstances(options);
// Index Client#1's mealPlanningReservations
const pagedIndexOfMealPlanningReservations = await client.clients.from(1).index.mealPlanningReservations(options);
// Index Client#1's clientDiscounts
const pagedIndexOfClientDiscounts = await client.clients.from(1).index.clientDiscounts(options);
// Index Client#1's giftbitGifts
const pagedIndexOfGiftbitGifts = await client.clients.from(1).index.giftbitGifts(options);
// Index Client#1's giftbitErrors
const pagedIndexOfGiftbitErrors = await client.clients.from(1).index.giftbitErrors(options);
```
### ClientDiscount
See [ClientDiscountFilter](#resource-filter-ClientDiscount) for valid filters.
See [ClientDiscount](#resource-ClientDiscount) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleClientDiscount= await client.clientDiscounts.get(1, options);
const pagedIndexOfClientDiscounts = await client.clientDiscounts.index(options);
// Related Resources
// To One
// Get ClientDiscount#1's order
const singleOrder = await client.clientDiscounts.from(1).get.order(1, options);
// Get ClientDiscount#1's owner
const singleOwner = await client.clientDiscounts.from(1).get.owner(1, options);
```
### ClientOrderInvoice
See [ClientOrderInvoiceFilter](#resource-filter-ClientOrderInvoice) for valid filters.
See [ClientOrderInvoice](#resource-ClientOrderInvoice) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleClientOrderInvoice= await client.clientOrderInvoices.get(1, options);
const pagedIndexOfClientOrderInvoices = await client.clientOrderInvoices.index(options);
```
### ClientSignup
See [ClientSignupFilter](#resource-filter-ClientSignup) for valid filters.
See [ClientSignup](#resource-ClientSignup) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleClientSignup= await client.clientSignups.get(1, options);
const pagedIndexOfClientSignups = await client.clientSignups.index(options);
// Related Resources
// To One
// Get ClientSignup#1's user
const singleUser = await client.clientSignups.from(1).get.user(1, options);
// Get ClientSignup#1's qualifyingQuestion
const singleQualifyingQuestion = await client.clientSignups.from(1).get.qualifyingQuestion(1, options);
// Get ClientSignup#1's billingLocation
const singleLocation = await client.clientSignups.from(1).get.billingLocation(1, options);
// Get ClientSignup#1's deliveryLocation
const singleLocation = await client.clientSignups.from(1).get.deliveryLocation(1, options);
// Get ClientSignup#1's billingContact
const singleContact = await client.clientSignups.from(1).get.billingContact(1, options);
// Get ClientSignup#1's contact
const singleContact = await client.clientSignups.from(1).get.contact(1, options);
// To Many
// Index ClientSignup#1's clients
const pagedIndexOfClients = await client.clientSignups.from(1).index.clients(options);
// Index ClientSignup#1's areas
const pagedIndexOfAreas = await client.clientSignups.from(1).index.areas(options);
```
### CommunicationPreference
See [CommunicationPreferenceFilter](#resource-filter-CommunicationPreference) for valid filters.
See [CommunicationPreference](#resource-CommunicationPreference) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleCommunicationPreference= await client.communicationPreferences.get(1, options);
const pagedIndexOfCommunicationPreferences = await client.communicationPreferences.index(options);
// Related Resources
// To One
// Get CommunicationPreference#1's user
const singleUser = await client.communicationPreferences.from(1).get.user(1, options);
```
### Company
See [CompanyFilter](#resource-filter-Company) for valid filters.
See [Company](#resource-Company) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleCompany= await client.companies.get(1, options);
const pagedIndexOfCompanies = await client.companies.index(options);
// Related Resources
// To Many
// Index Company#1's clients
const pagedIndexOfClients = await client.companies.from(1).index.clients(options);
```
### Contact
See [ContactFilter](#resource-filter-Contact) for valid filters.
See [Contact](#resource-Contact) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleContact= await client.contacts.get(1, options);
const pagedIndexOfContacts = await client.contacts.index(options);
```
### Courier
See [CourierFilter](#resource-filter-Courier) for valid filters.
See [Courier](#resource-Courier) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleCourier= await client.couriers.get(1, options);
const pagedIndexOfCouriers = await client.couriers.index(options);
// Related Resources
// To One
// Get Courier#1's owner
const singleUser = await client.couriers.from(1).get.owner(1, options);
// To Many
// Index Courier#1's drivers
const pagedIndexOfUsers = await client.couriers.from(1).index.drivers(options);
// Index Courier#1's areas
const pagedIndexOfAreas = await client.couriers.from(1).index.areas(options);
// Index Courier#1's versions
const pagedIndexOfHistorianVersions = await client.couriers.from(1).index.versions(options);
```
### CurrenciesCurrency
See [CurrenciesCurrencyFilter](#resource-filter-CurrenciesCurrency) for valid filters.
See [CurrenciesCurrency](#resource-CurrenciesCurrency) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleCurrenciesCurrency= await client.currenciesCurrencies.get(1, options);
const pagedIndexOfCurrenciesCurrencies = await client.currenciesCurrencies.index(options);
```
### CurrenciesTransaction
See [CurrenciesTransactionFilter](#resource-filter-CurrenciesTransaction) for valid filters.
See [CurrenciesTransaction](#resource-CurrenciesTransaction) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleCurrenciesTransaction= await client.currenciesTransactions.get(1, options);
const pagedIndexOfCurrenciesTransactions = await client.currenciesTransactions.index(options);
// Related Resources
// To One
// Get CurrenciesTransaction#1's agent
const singleAgent = await client.currenciesTransactions.from(1).get.agent(1, options);
// Get CurrenciesTransaction#1's subject
const singleSubject = await client.currenciesTransactions.from(1).get.subject(1, options);
```
### CurrenciesWallet
See [CurrenciesWalletFilter](#resource-filter-CurrenciesWallet) for valid filters.
See [CurrenciesWallet](#resource-CurrenciesWallet) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleCurrenciesWallet= await client.currenciesWallets.get(1, options);
const pagedIndexOfCurrenciesWallets = await client.currenciesWallets.index(options);
// Related Resources
// To One
// Get CurrenciesWallet#1's owner
const singleOwner = await client.currenciesWallets.from(1).get.owner(1, options);
// To Many
// Index CurrenciesWallet#1's transactions
const pagedIndexOfCurrencies::Transactions = await client.currenciesWallets.from(1).index.transactions(options);
```
### DeliveryCase
See [DeliveryCaseFilter](#resource-filter-DeliveryCase) for valid filters.
See [DeliveryCase](#resource-DeliveryCase) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDeliveryCase= await client.deliveryCases.get(1, options);
const pagedIndexOfDeliveryCases = await client.deliveryCases.index(options);
// Related Resources
// To One
// Get DeliveryCase#1's user
const singleUser = await client.deliveryCases.from(1).get.user(1, options);
// Get DeliveryCase#1's order
const singleOrder = await client.deliveryCases.from(1).get.order(1, options);
```
### DeliveryLocation
See [DeliveryLocationFilter](#resource-filter-DeliveryLocation) for valid filters.
See [DeliveryLocation](#resource-DeliveryLocation) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDeliveryLocation= await client.deliveryLocations.get(1, options);
const pagedIndexOfDeliveryLocations = await client.deliveryLocations.index(options);
// Related Resources
// To One
// Get DeliveryLocation#1's client
const singleClient = await client.deliveryLocations.from(1).get.client(1, options);
// Get DeliveryLocation#1's location
const singleLocation = await client.deliveryLocations.from(1).get.location(1, options);
```
### DeskCase
See [DeskCaseFilter](#resource-filter-DeskCase) for valid filters.
See [DeskCase](#resource-DeskCase) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDeskCase= await client.deskCases.get(1, options);
const pagedIndexOfDeskCases = await client.deskCases.index(options);
// Related Resources
// To One
// Get DeskCase#1's user
const singleUser = await client.deskCases.from(1).get.user(1, options);
// Get DeskCase#1's order
const singleOrder = await client.deskCases.from(1).get.order(1, options);
```
### DietaryTag
See [DietaryTagFilter](#resource-filter-DietaryTag) for valid filters.
See [DietaryTag](#resource-DietaryTag) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDietaryTag= await client.dietaryTags.get(1, options);
const pagedIndexOfDietaryTags = await client.dietaryTags.index(options);
// Related Resources
// To Many
// Index DietaryTag#1's menuOptionItems
const pagedIndexOfMenuOptionItems = await client.dietaryTags.from(1).index.menuOptionItems(options);
```
### DiscountCode
See [DiscountCodeFilter](#resource-filter-DiscountCode) for valid filters.
See [DiscountCode](#resource-DiscountCode) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDiscountCode= await client.discountCodes.get(1, options);
const pagedIndexOfDiscountCodes = await client.discountCodes.index(options);
```
### DriverDay
See [DriverDayFilter](#resource-filter-DriverDay) for valid filters.
See [DriverDay](#resource-DriverDay) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDriverDay= await client.driverDays.get(1, options);
const pagedIndexOfDriverDays = await client.driverDays.index(options);
// Related Resources
// To One
// Get DriverDay#1's driver
const singleUser = await client.driverDays.from(1).get.driver(1, options);
```
### DriverPayment
See [DriverPaymentFilter](#resource-filter-DriverPayment) for valid filters.
See [DriverPayment](#resource-DriverPayment) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDriverPayment= await client.driverPayments.get(1, options);
const pagedIndexOfDriverPayments = await client.driverPayments.index(options);
// Related Resources
// To One
// Get DriverPayment#1's driverPayrollRun
const singleDriverPayrollRun = await client.driverPayments.from(1).get.driverPayrollRun(1, options);
```
### DriverPayrollRun
See [DriverPayrollRunFilter](#resource-filter-DriverPayrollRun) for valid filters.
See [DriverPayrollRun](#resource-DriverPayrollRun) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDriverPayrollRun= await client.driverPayrollRuns.get(1, options);
const pagedIndexOfDriverPayrollRuns = await client.driverPayrollRuns.index(options);
// Related Resources
// To One
// Get DriverPayrollRun#1's driver
const singleDriver = await client.driverPayrollRuns.from(1).get.driver(1, options);
// Get DriverPayrollRun#1's payrollRun
const singlePayrollRun = await client.driverPayrollRuns.from(1).get.payrollRun(1, options);
```
### DriverPing
See [DriverPingFilter](#resource-filter-DriverPing) for valid filters.
See [DriverPing](#resource-DriverPing) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDriverPing= await client.driverPings.get(1, options);
const pagedIndexOfDriverPings = await client.driverPings.index(options);
// Related Resources
// To One
// Get DriverPing#1's user
const singleUser = await client.driverPings.from(1).get.user(1, options);
```
### DriverResource
See [DriverResourceFilter](#resource-filter-DriverResource) for valid filters.
See [DriverResource](#resource-DriverResource) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDriverResource= await client.driverResources.get(1, options);
const pagedIndexOfDriverResources = await client.driverResources.index(options);
```
### DriverWeek
See [DriverWeekFilter](#resource-filter-DriverWeek) for valid filters.
See [DriverWeek](#resource-DriverWeek) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleDriverWeek= await client.driverWeeks.get(1, options);
const pagedIndexOfDriverWeeks = await client.driverWeeks.index(options);
// Related Resources
// To One
// Get DriverWeek#1's driver
const singleUser = await client.driverWeeks.from(1).get.driver(1, options);
```
### EmailMessage
See [EmailMessageFilter](#resource-filter-EmailMessage) for valid filters.
See [EmailMessage](#resource-EmailMessage) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleEmailMessage= await client.emailMessages.get(1, options);
const pagedIndexOfEmailMessages = await client.emailMessages.index(options);
// Related Resources
// To One
// Get EmailMessage#1's order
const singleOrder = await client.emailMessages.from(1).get.order(1, options);
```
### Event
See [EventFilter](#resource-filter-Event) for valid filters.
See [Event](#resource-Event) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleEvent= await client.events.get(1, options);
const pagedIndexOfEvents = await client.events.index(options);
```
### FeatureFlagDescription
See [FeatureFlagDescriptionFilter](#resource-filter-FeatureFlagDescription) for valid filters.
See [FeatureFlagDescription](#resource-FeatureFlagDescription) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleFeatureFlagDescription= await client.featureFlagDescriptions.get(1, options);
const pagedIndexOfFeatureFlagDescriptions = await client.featureFlagDescriptions.index(options);
// Related Resources
// To Many
// Index FeatureFlagDescription#1's subscriptionPlans
const pagedIndexOfSubscriptionPlans = await client.featureFlagDescriptions.from(1).index.subscriptionPlans(options);
```
### FoodType
See [FoodTypeFilter](#resource-filter-FoodType) for valid filters.
See [FoodType](#resource-FoodType) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleFoodType= await client.foodTypes.get(1, options);
const pagedIndexOfFoodTypes = await client.foodTypes.index(options);
```
### GiftbitCard
See [GiftbitCardFilter](#resource-filter-GiftbitCard) for valid filters.
See [GiftbitCard](#resource-GiftbitCard) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleGiftbitCard= await client.giftbitCards.get(1, options);
const pagedIndexOfGiftbitCards = await client.giftbitCards.index(options);
```
### GiftbitError
See [GiftbitErrorFilter](#resource-filter-GiftbitError) for valid filters.
See [GiftbitError](#resource-GiftbitError) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleGiftbitError= await client.giftbitErrors.get(1, options);
const pagedIndexOfGiftbitErrors = await client.giftbitErrors.index(options);
// Related Resources
// To One
// Get GiftbitError#1's order
const singleOrder = await client.giftbitErrors.from(1).get.order(1, options);
```
### GiftbitGift
See [GiftbitGiftFilter](#resource-filter-GiftbitGift) for valid filters.
See [GiftbitGift](#resource-GiftbitGift) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleGiftbitGift= await client.giftbitGifts.get(1, options);
const pagedIndexOfGiftbitGifts = await client.giftbitGifts.index(options);
```
### GroupOrderMember
See [GroupOrderMemberFilter](#resource-filter-GroupOrderMember) for valid filters.
See [GroupOrderMember](#resource-GroupOrderMember) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleGroupOrderMember= await client.groupOrderMembers.get(1, options);
const pagedIndexOfGroupOrderMembers = await client.groupOrderMembers.index(options);
// Related Resources
// To One
// Get GroupOrderMember#1's user
const singleUser = await client.groupOrderMembers.from(1).get.user(1, options);
// Get GroupOrderMember#1's order
const singleOrder = await client.groupOrderMembers.from(1).get.order(1, options);
// Get GroupOrderMember#1's invoice
const singleAccountingLedgerItem = await client.groupOrderMembers.from(1).get.invoice(1, options);
// To Many
// Index GroupOrderMember#1's orderItems
const pagedIndexOfOrderItems = await client.groupOrderMembers.from(1).index.orderItems(options);
```
### HistorianVersion
See [HistorianVersionFilter](#resource-filter-HistorianVersion) for valid filters.
See [HistorianVersion](#resource-HistorianVersion) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleHistorianVersion= await client.historianVersions.get(1, options);
const pagedIndexOfHistorianVersions = await client.historianVersions.index(options);
```
### Invoice
See [InvoiceFilter](#resource-filter-Invoice) for valid filters.
See [Invoice](#resource-Invoice) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleInvoice= await client.invoices.get(1, options);
const pagedIndexOfInvoices = await client.invoices.index(options);
```
### InvoicingLedgerItem
See [InvoicingLedgerItemFilter](#resource-filter-InvoicingLedgerItem) for valid filters.
See [InvoicingLedgerItem](#resource-InvoicingLedgerItem) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleInvoicingLedgerItem= await client.invoicingLedgerItems.get(1, options);
const pagedIndexOfInvoicingLedgerItems = await client.invoicingLedgerItems.index(options);
```
### InvoicingTaxRate
See [InvoicingTaxRateFilter](#resource-filter-InvoicingTaxRate) for valid filters.
See [InvoicingTaxRate](#resource-InvoicingTaxRate) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleInvoicingTaxRate= await client.invoicingTaxRates.get(1, options);
const pagedIndexOfInvoicingTaxRates = await client.invoicingTaxRates.index(options);
// Related Resources
// To Many
// Index InvoicingTaxRate#1's areas
const pagedIndexOfAreas = await client.invoicingTaxRates.from(1).index.areas(options);
```
### Location
See [LocationFilter](#resource-filter-Location) for valid filters.
See [Location](#resource-Location) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleLocation= await client.locations.get(1, options);
const pagedIndexOfLocations = await client.locations.index(options);
// Related Resources
// To One
// Get Location#1's area
const singleArea = await client.locations.from(1).get.area(1, options);
```
### LogisticsArrivalEstimate
See [LogisticsArrivalEstimateFilter](#resource-filter-LogisticsArrivalEstimate) for valid filters.
See [LogisticsArrivalEstimate](#resource-LogisticsArrivalEstimate) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleLogisticsArrivalEstimate= await client.logisticsArrivalEstimates.get(1, options);
const pagedIndexOfLogisticsArrivalEstimates = await client.logisticsArrivalEstimates.index(options);
```
### LogisticsDelivery
See [LogisticsDeliveryFilter](#resource-filter-LogisticsDelivery) for valid filters.
See [LogisticsDelivery](#resource-LogisticsDelivery) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleLogisticsDelivery= await client.logisticsDeliveries.get(1, options);
const pagedIndexOfLogisticsDeliveries = await client.logisticsDeliveries.index(options);
// Related Resources
// To One
// Get LogisticsDelivery#1's driver
const singleUser = await client.logisticsDeliveries.from(1).get.driver(1, options);
// Get LogisticsDelivery#1's courier
const singleCourier = await client.logisticsDeliveries.from(1).get.courier(1, options);
// Get LogisticsDelivery#1's area
const singleArea = await client.logisticsDeliveries.from(1).get.area(1, options);
// Get LogisticsDelivery#1's order
const singleOrder = await client.logisticsDeliveries.from(1).get.order(1, options);
```
### MealPlan
See [MealPlanFilter](#resource-filter-MealPlan) for valid filters.
See [MealPlan](#resource-MealPlan) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlan= await client.mealPlans.get(1, options);
const pagedIndexOfMealPlans = await client.mealPlans.index(options);
// Related Resources
// To One
// Get MealPlan#1's mealPlanUser
const singleUser = await client.mealPlans.from(1).get.mealPlanUser(1, options);
// Get MealPlan#1's client
const singleClient = await client.mealPlans.from(1).get.client(1, options);
// To Many
// Index MealPlan#1's orders
const pagedIndexOfOrders = await client.mealPlans.from(1).index.orders(options);
```
### MealPlanningEvent
See [MealPlanningEventFilter](#resource-filter-MealPlanningEvent) for valid filters.
See [MealPlanningEvent](#resource-MealPlanningEvent) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningEvent= await client.mealPlanningEvents.get(1, options);
const pagedIndexOfMealPlanningEvents = await client.mealPlanningEvents.index(options);
// Related Resources
// To One
// Get MealPlanningEvent#1's instance
const singleMealPlanningInstance = await client.mealPlanningEvents.from(1).get.instance(1, options);
// To Many
// Index MealPlanningEvent#1's orders
const pagedIndexOfOrders = await client.mealPlanningEvents.from(1).index.orders(options);
// Index MealPlanningEvent#1's restaurants
const pagedIndexOfRestaurants = await client.mealPlanningEvents.from(1).index.restaurants(options);
// Index MealPlanningEvent#1's reservations
const pagedIndexOfMealPlanningReservations = await client.mealPlanningEvents.from(1).index.reservations(options);
// Index MealPlanningEvent#1's restaurantConstraints
const pagedIndexOfMealPlanningRestaurantConstraints = await client.mealPlanningEvents.from(1).index.restaurantConstraints(options);
// Index MealPlanningEvent#1's users
const pagedIndexOfUsers = await client.mealPlanningEvents.from(1).index.users(options);
```
### MealPlanningInstance
See [MealPlanningInstanceFilter](#resource-filter-MealPlanningInstance) for valid filters.
See [MealPlanningInstance](#resource-MealPlanningInstance) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningInstance= await client.mealPlanningInstances.get(1, options);
const pagedIndexOfMealPlanningInstances = await client.mealPlanningInstances.index(options);
// Related Resources
// To One
// Get MealPlanningInstance#1's client
const singleClient = await client.mealPlanningInstances.from(1).get.client(1, options);
// Get MealPlanningInstance#1's area
const singleArea = await client.mealPlanningInstances.from(1).get.area(1, options);
// Get MealPlanningInstance#1's mealPlanningTemplate
const singleMealPlanningTemplate = await client.mealPlanningInstances.from(1).get.mealPlanningTemplate(1, options);
// Get MealPlanningInstance#1's preferenceProfile
const singleMealPlanningPreferenceProfile = await client.mealPlanningInstances.from(1).get.preferenceProfile(1, options);
// Get MealPlanningInstance#1's orderTemplate
const singleOrder = await client.mealPlanningInstances.from(1).get.orderTemplate(1, options);
// Get MealPlanningInstance#1's defaultOrderOwner
const singleUser = await client.mealPlanningInstances.from(1).get.defaultOrderOwner(1, options);
// To Many
// Index MealPlanningInstance#1's mealPlanningReservations
const pagedIndexOfMealPlanningReservations = await client.mealPlanningInstances.from(1).index.mealPlanningReservations(options);
// Index MealPlanningInstance#1's events
const pagedIndexOfMealPlanningEvents = await client.mealPlanningInstances.from(1).index.events(options);
// Index MealPlanningInstance#1's restaurantConstraints
const pagedIndexOfMealPlanningRestaurantConstraints = await client.mealPlanningInstances.from(1).index.restaurantConstraints(options);
// Index MealPlanningInstance#1's teamMembers
const pagedIndexOfUsers = await client.mealPlanningInstances.from(1).index.teamMembers(options);
// Index MealPlanningInstance#1's orders
const pagedIndexOfOrders = await client.mealPlanningInstances.from(1).index.orders(options);
// Index MealPlanningInstance#1's logRecords
const pagedIndexOfMealPlanningLogRecords = await client.mealPlanningInstances.from(1).index.logRecords(options);
```
### MealPlanningLogRecord
See [MealPlanningLogRecordFilter](#resource-filter-MealPlanningLogRecord) for valid filters.
See [MealPlanningLogRecord](#resource-MealPlanningLogRecord) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningLogRecord= await client.mealPlanningLogRecords.get(1, options);
const pagedIndexOfMealPlanningLogRecords = await client.mealPlanningLogRecords.index(options);
// Related Resources
// To One
// Get MealPlanningLogRecord#1's planable
const singlePlanable = await client.mealPlanningLogRecords.from(1).get.planable(1, options);
```
### MealPlanningPreferenceProfile
See [MealPlanningPreferenceProfileFilter](#resource-filter-MealPlanningPreferenceProfile) for valid filters.
See [MealPlanningPreferenceProfile](#resource-MealPlanningPreferenceProfile) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningPreferenceProfile= await client.mealPlanningPreferenceProfiles.get(1, options);
const pagedIndexOfMealPlanningPreferenceProfiles = await client.mealPlanningPreferenceProfiles.index(options);
// Related Resources
// To One
// Get MealPlanningPreferenceProfile#1's preferee
const singlePreferee = await client.mealPlanningPreferenceProfiles.from(1).get.preferee(1, options);
// To Many
// Index MealPlanningPreferenceProfile#1's requirements
const pagedIndexOfMealPlanningRequirements = await client.mealPlanningPreferenceProfiles.from(1).index.requirements(options);
// Index MealPlanningPreferenceProfile#1's requirementGroups
const pagedIndexOfMealPlanningRequirementGroups = await client.mealPlanningPreferenceProfiles.from(1).index.requirementGroups(options);
// Index MealPlanningPreferenceProfile#1's lovedRestaurants
const pagedIndexOfRestaurants = await client.mealPlanningPreferenceProfiles.from(1).index.lovedRestaurants(options);
// Index MealPlanningPreferenceProfile#1's hatedRestaurants
const pagedIndexOfRestaurants = await client.mealPlanningPreferenceProfiles.from(1).index.hatedRestaurants(options);
// Index MealPlanningPreferenceProfile#1's lovedCuisineTypes
const pagedIndexOfTags = await client.mealPlanningPreferenceProfiles.from(1).index.lovedCuisineTypes(options);
// Index MealPlanningPreferenceProfile#1's hatedCuisineTypes
const pagedIndexOfTags = await client.mealPlanningPreferenceProfiles.from(1).index.hatedCuisineTypes(options);
```
### MealPlanningRequirement
See [MealPlanningRequirementFilter](#resource-filter-MealPlanningRequirement) for valid filters.
See [MealPlanningRequirement](#resource-MealPlanningRequirement) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningRequirement= await client.mealPlanningRequirements.get(1, options);
const pagedIndexOfMealPlanningRequirements = await client.mealPlanningRequirements.index(options);
// Related Resources
// To One
// Get MealPlanningRequirement#1's preferenceProfile
const singleMealPlanningPreferenceProfile = await client.mealPlanningRequirements.from(1).get.preferenceProfile(1, options);
// Get MealPlanningRequirement#1's requirementGroup
const singleMealPlanningRequirementGroup = await client.mealPlanningRequirements.from(1).get.requirementGroup(1, options);
// Get MealPlanningRequirement#1's restaurantConstraint
const singleMealPlanningRestaurantConstraint = await client.mealPlanningRequirements.from(1).get.restaurantConstraint(1, options);
// Get MealPlanningRequirement#1's order
const singleOrder = await client.mealPlanningRequirements.from(1).get.order(1, options);
// To Many
// Index MealPlanningRequirement#1's requirementConstraints
const pagedIndexOfMealPlanningRequirementConstraints = await client.mealPlanningRequirements.from(1).index.requirementConstraints(options);
// Index MealPlanningRequirement#1's tags
const pagedIndexOfTags = await client.mealPlanningRequirements.from(1).index.tags(options);
// Index MealPlanningRequirement#1's dietaryTags
const pagedIndexOfDietaryTags = await client.mealPlanningRequirements.from(1).index.dietaryTags(options);
// Index MealPlanningRequirement#1's allergyTags
const pagedIndexOfDietaryTags = await client.mealPlanningRequirements.from(1).index.allergyTags(options);
// Index MealPlanningRequirement#1's packagingTags
const pagedIndexOfDietaryTags = await client.mealPlanningRequirements.from(1).index.packagingTags(options);
// Index MealPlanningRequirement#1's foodTypes
const pagedIndexOfFoodTypes = await client.mealPlanningRequirements.from(1).index.foodTypes(options);
// Index MealPlanningRequirement#1's mealTypes
const pagedIndexOfMealTypes = await client.mealPlanningRequirements.from(1).index.mealTypes(options);
```
### MealPlanningRequirementConstraint
See [MealPlanningRequirementConstraintFilter](#resource-filter-MealPlanningRequirementConstraint) for valid filters.
See [MealPlanningRequirementConstraint](#resource-MealPlanningRequirementConstraint) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningRequirementConstraint= await client.mealPlanningRequirementConstraints.get(1, options);
const pagedIndexOfMealPlanningRequirementConstraints = await client.mealPlanningRequirementConstraints.index(options);
// Related Resources
// To One
// Get MealPlanningRequirementConstraint#1's requirement
const singleMealPlanningRequirement = await client.mealPlanningRequirementConstraints.from(1).get.requirement(1, options);
// To Many
// Index MealPlanningRequirementConstraint#1's mealTypes
const pagedIndexOfMealTypes = await client.mealPlanningRequirementConstraints.from(1).index.mealTypes(options);
// Index MealPlanningRequirementConstraint#1's foodTypes
const pagedIndexOfFoodTypes = await client.mealPlanningRequirementConstraints.from(1).index.foodTypes(options);
// Index MealPlanningRequirementConstraint#1's dietaryTags
const pagedIndexOfDietaryTags = await client.mealPlanningRequirementConstraints.from(1).index.dietaryTags(options);
// Index MealPlanningRequirementConstraint#1's allergyTags
const pagedIndexOfDietaryTags = await client.mealPlanningRequirementConstraints.from(1).index.allergyTags(options);
// Index MealPlanningRequirementConstraint#1's packagingTags
const pagedIndexOfDietaryTags = await client.mealPlanningRequirementConstraints.from(1).index.packagingTags(options);
```
### MealPlanningRequirementGroup
See [MealPlanningRequirementGroupFilter](#resource-filter-MealPlanningRequirementGroup) for valid filters.
See [MealPlanningRequirementGroup](#resource-MealPlanningRequirementGroup) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningRequirementGroup= await client.mealPlanningRequirementGroups.get(1, options);
const pagedIndexOfMealPlanningRequirementGroups = await client.mealPlanningRequirementGroups.index(options);
// Related Resources
// To One
// Get MealPlanningRequirementGroup#1's preferenceProfile
const singleMealPlanningPreferenceProfile = await client.mealPlanningRequirementGroups.from(1).get.preferenceProfile(1, options);
// To Many
// Index MealPlanningRequirementGroup#1's requirements
const pagedIndexOfMealPlanningRequirements = await client.mealPlanningRequirementGroups.from(1).index.requirements(options);
```
### MealPlanningReservation
See [MealPlanningReservationFilter](#resource-filter-MealPlanningReservation) for valid filters.
See [MealPlanningReservation](#resource-MealPlanningReservation) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningReservation= await client.mealPlanningReservations.get(1, options);
const pagedIndexOfMealPlanningReservations = await client.mealPlanningReservations.index(options);
// Related Resources
// To One
// Get MealPlanningReservation#1's area
const singleArea = await client.mealPlanningReservations.from(1).get.area(1, options);
// Get MealPlanningReservation#1's client
const singleClient = await client.mealPlanningReservations.from(1).get.client(1, options);
// Get MealPlanningReservation#1's restaurant
const singleRestaurant = await client.mealPlanningReservations.from(1).get.restaurant(1, options);
// Get MealPlanningReservation#1's mealPlanningInstance
const singleMealPlanningInstance = await client.mealPlanningReservations.from(1).get.mealPlanningInstance(1, options);
// Get MealPlanningReservation#1's event
const singleMealPlanningEvent = await client.mealPlanningReservations.from(1).get.event(1, options);
// Get MealPlanningReservation#1's order
const singleOrder = await client.mealPlanningReservations.from(1).get.order(1, options);
```
### MealPlanningRestaurantConstraint
See [MealPlanningRestaurantConstraintFilter](#resource-filter-MealPlanningRestaurantConstraint) for valid filters.
See [MealPlanningRestaurantConstraint](#resource-MealPlanningRestaurantConstraint) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningRestaurantConstraint= await client.mealPlanningRestaurantConstraints.get(1, options);
const pagedIndexOfMealPlanningRestaurantConstraints = await client.mealPlanningRestaurantConstraints.index(options);
// Related Resources
// To One
// Get MealPlanningRestaurantConstraint#1's template
const singleMealPlanningTemplate = await client.mealPlanningRestaurantConstraints.from(1).get.template(1, options);
// Get MealPlanningRestaurantConstraint#1's instance
const singleMealPlanningInstance = await client.mealPlanningRestaurantConstraints.from(1).get.instance(1, options);
// Get MealPlanningRestaurantConstraint#1's event
const singleMealPlanningEvent = await client.mealPlanningRestaurantConstraints.from(1).get.event(1, options);
// Get MealPlanningRestaurantConstraint#1's requirement
const singleMealPlanningRequirement = await client.mealPlanningRestaurantConstraints.from(1).get.requirement(1, options);
// To Many
// Index MealPlanningRestaurantConstraint#1's restaurants
const pagedIndexOfRestaurants = await client.mealPlanningRestaurantConstraints.from(1).index.restaurants(options);
```
### MealPlanningSchedule
See [MealPlanningScheduleFilter](#resource-filter-MealPlanningSchedule) for valid filters.
See [MealPlanningSchedule](#resource-MealPlanningSchedule) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningSchedule= await client.mealPlanningSchedules.get(1, options);
const pagedIndexOfMealPlanningSchedules = await client.mealPlanningSchedules.index(options);
// Related Resources
// To One
// Get MealPlanningSchedule#1's template
const singleMealPlanningTemplate = await client.mealPlanningSchedules.from(1).get.template(1, options);
// To Many
// Index MealPlanningSchedule#1's skipPeriods
const pagedIndexOfMealPlanningSkipPeriods = await client.mealPlanningSchedules.from(1).index.skipPeriods(options);
```
### MealPlanningTemplate
See [MealPlanningTemplateFilter](#resource-filter-MealPlanningTemplate) for valid filters.
See [MealPlanningTemplate](#resource-MealPlanningTemplate) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealPlanningTemplate= await client.mealPlanningTemplates.get(1, options);
const pagedIndexOfMealPlanningTemplates = await client.mealPlanningTemplates.index(options);
// Related Resources
// To One
// Get MealPlanningTemplate#1's client
const singleClient = await client.mealPlanningTemplates.from(1).get.client(1, options);
// Get MealPlanningTemplate#1's orderTemplate
const singleOrder = await client.mealPlanningTemplates.from(1).get.orderTemplate(1, options);
// Get MealPlanningTemplate#1's area
const singleArea = await client.mealPlanningTemplates.from(1).get.area(1, options);
// Get MealPlanningTemplate#1's preferenceProfile
const singleMealPlanningPreferenceProfile = await client.mealPlanningTemplates.from(1).get.preferenceProfile(1, options);
// Get MealPlanningTemplate#1's schedule
const singleMealPlanningSchedule = await client.mealPlanningTemplates.from(1).get.schedule(1, options);
// Get MealPlanningTemplate#1's defaultOrderOwner
const singleUser = await client.mealPlanningTemplates.from(1).get.defaultOrderOwner(1, options);
// To Many
// Index MealPlanningTemplate#1's mealPlanningInstances
const pagedIndexOfMealPlanningInstances = await client.mealPlanningTemplates.from(1).index.mealPlanningInstances(options);
// Index MealPlanningTemplate#1's restaurantConstraints
const pagedIndexOfMealPlanningRestaurantConstraints = await client.mealPlanningTemplates.from(1).index.restaurantConstraints(options);
```
### MealType
See [MealTypeFilter](#resource-filter-MealType) for valid filters.
See [MealType](#resource-MealType) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMealType= await client.mealTypes.get(1, options);
const pagedIndexOfMealTypes = await client.mealTypes.index(options);
```
### Menu
See [MenuFilter](#resource-filter-Menu) for valid filters.
See [Menu](#resource-Menu) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMenu= await client.menus.get(1, options);
const pagedIndexOfMenus = await client.menus.index(options);
// Related Resources
// To One
// Get Menu#1's area
const singleArea = await client.menus.from(1).get.area(1, options);
// Get Menu#1's restaurant
const singleRestaurant = await client.menus.from(1).get.restaurant(1, options);
// To Many
// Index Menu#1's menuGroups
const pagedIndexOfMenuGroups = await client.menus.from(1).index.menuGroups(options);
// Index Menu#1's menuItems
const pagedIndexOfMenuItems = await client.menus.from(1).index.menuItems(options);
// Index Menu#1's dietaryTags
const pagedIndexOfDietaryTags = await client.menus.from(1).index.dietaryTags(options);
// Index Menu#1's orders
const pagedIndexOfOrders = await client.menus.from(1).index.orders(options);
```
### MenuGroup
See [MenuGroupFilter](#resource-filter-MenuGroup) for valid filters.
See [MenuGroup](#resource-MenuGroup) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMenuGroup= await client.menuGroups.get(1, options);
const pagedIndexOfMenuGroups = await client.menuGroups.index(options);
// Related Resources
// To One
// Get MenuGroup#1's menu
const singleMenu = await client.menuGroups.from(1).get.menu(1, options);
// To Many
// Index MenuGroup#1's menuItems
const pagedIndexOfMenuItems = await client.menuGroups.from(1).index.menuItems(options);
// Index MenuGroup#1's mealTypes
const pagedIndexOfMealTypes = await client.menuGroups.from(1).index.mealTypes(options);
// Index MenuGroup#1's foodTypes
const pagedIndexOfFoodTypes = await client.menuGroups.from(1).index.foodTypes(options);
```
### MenuItem
See [MenuItemFilter](#resource-filter-MenuItem) for valid filters.
See [MenuItem](#resource-MenuItem) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMenuItem= await client.menuItems.get(1, options);
const pagedIndexOfMenuItems = await client.menuItems.index(options);
// Related Resources
// To One
// Get MenuItem#1's taxRate
const singleInvoicingTaxRate = await client.menuItems.from(1).get.taxRate(1, options);
// Get MenuItem#1's menuGroup
const singleMenuGroup = await client.menuItems.from(1).get.menuGroup(1, options);
// To Many
// Index MenuItem#1's dietaryTags
const pagedIndexOfDietaryTags = await client.menuItems.from(1).index.dietaryTags(options);
// Index MenuItem#1's mealTypes
const pagedIndexOfMealTypes = await client.menuItems.from(1).index.mealTypes(options);
// Index MenuItem#1's foodTypes
const pagedIndexOfFoodTypes = await client.menuItems.from(1).index.foodTypes(options);
// Index MenuItem#1's menuOptionGroups
const pagedIndexOfMenuOptionGroups = await client.menuItems.from(1).index.menuOptionGroups(options);
```
### MenuOptionGroup
See [MenuOptionGroupFilter](#resource-filter-MenuOptionGroup) for valid filters.
See [MenuOptionGroup](#resource-MenuOptionGroup) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMenuOptionGroup= await client.menuOptionGroups.get(1, options);
const pagedIndexOfMenuOptionGroups = await client.menuOptionGroups.index(options);
// Related Resources
// To One
// Get MenuOptionGroup#1's menuItem
const singleMenuItem = await client.menuOptionGroups.from(1).get.menuItem(1, options);
// To Many
// Index MenuOptionGroup#1's menuOptionItems
const pagedIndexOfMenuOptionItems = await client.menuOptionGroups.from(1).index.menuOptionItems(options);
```
### MenuOptionItem
See [MenuOptionItemFilter](#resource-filter-MenuOptionItem) for valid filters.
See [MenuOptionItem](#resource-MenuOptionItem) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleMenuOptionItem= await client.menuOptionItems.get(1, options);
const pagedIndexOfMenuOptionItems = await client.menuOptionItems.index(options);
// Related Resources
// To One
// Get MenuOptionItem#1's menuOptionGroup
const singleMenuOptionGroup = await client.menuOptionItems.from(1).get.menuOptionGroup(1, options);
// To Many
// Index MenuOptionItem#1's dietaryTags
const pagedIndexOfDietaryTags = await client.menuOptionItems.from(1).index.dietaryTags(options);
// Index MenuOptionItem#1's orderItems
const pagedIndexOfOrderItems = await client.menuOptionItems.from(1).index.orderItems(options);
```
### NotificationLog
See [NotificationLogFilter](#resource-filter-NotificationLog) for valid filters.
See [NotificationLog](#resource-NotificationLog) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleNotificationLog= await client.notificationLogs.get(1, options);
const pagedIndexOfNotificationLogs = await client.notificationLogs.index(options);
// Related Resources
// To One
// Get NotificationLog#1's order
const singleOrder = await client.notificationLogs.from(1).get.order(1, options);
```
### Order
See [OrderFilter](#resource-filter-Order) for valid filters.
See [Order](#resource-Order) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleOrder= await client.orders.get(1, options);
const pagedIndexOfOrders = await client.orders.index(options);
// Related Resources
// To One
// Get Order#1's area
const singleArea = await client.orders.from(1).get.area(1, options);
// Get Order#1's owner
const singleUser = await client.orders.from(1).get.owner(1, options);
// Get Order#1's creator
const singleUser = await client.orders.from(1).get.creator(1, options);
// Get Order#1's paymentCard
const singlePaymentCard = await client.orders.from(1).get.paymentCard(1, options);
// Get Order#1's contact
const singleContact = await client.orders.from(1).get.contact(1, options);
// Get Order#1's client
const singleClient = await client.orders.from(1).get.client(1, options);
// Get Order#1's restaurant
const singleRestaurant = await client.orders.from(1).get.restaurant(1, options);
// Get Order#1's courier
const singleCourier = await client.orders.from(1).get.courier(1, options);
// Get Order#1's promoCode
const singlePromoCode = await client.orders.from(1).get.promoCode(1, options);
// Get Order#1's driver
const singleUser = await client.orders.from(1).get.driver(1, options);
// Get Order#1's salesSupport
const singleUser = await client.orders.from(1).get.salesSupport(1, options);
// Get Order#1's restaurantLocation
const singleLocation = await client.orders.from(1).get.restaurantLocation(1, options);
// Get Order#1's clientLocation
const singleLocation = await client.orders.from(1).get.clientLocation(1, options);
// Get Order#1's menu
const singleMenu = await client.orders.from(1).get.menu(1, options);
// Get Order#1's menuFilter
const singleMealPlanningRequirement = await client.orders.from(1).get.menuFilter(1, options);
// Get Order#1's customLocation
const singleLocation = await client.orders.from(1).get.customLocation(1, options);
// Get Order#1's giftbitError
const singleGiftbitError = await client.orders.from(1).get.giftbitError(1, options);
// Get Order#1's restaurantInvoice
const singleInvoicingLedgerItem = await client.orders.from(1).get.restaurantInvoice(1, options);
// Get Order#1's clientInvoice
const singleInvoicingLedgerItem = await client.orders.from(1).get.clientInvoice(1, options);
// Get Order#1's invoice
const singleAccountingLedgerItem = await client.orders.from(1).get.invoice(1, options);
// Get Order#1's restaurantBill
const singleAccountingLedgerItem = await client.orders.from(1).get.restaurantBill(1, options);
// Get Order#1's clientOrderInvoice
const singleClientOrderInvoice = await client.orders.from(1).get.clientOrderInvoice(1, options);
// Get Order#1's restaurantOrderInvoice
const singleRestaurantOrderInvoice = await client.orders.from(1).get.restaurantOrderInvoice(1, options);
// Get Order#1's arrivalEstimate
const singleLogisticsArrivalEstimate = await client.orders.from(1).get.arrivalEstimate(1, options);
// To Many
// Index Order#1's clientDiscounts
const pagedIndexOfClientDiscounts = await client.orders.from(1).index.clientDiscounts(options);
// Index Order#1's restaurantDiscounts
const pagedIndexOfRestaurantDiscounts = await client.orders.from(1).index.restaurantDiscounts(options);
// Index Order#1's emailMessages
const pagedIndexOfEmailMessages = await client.orders.from(1).index.emailMessages(options);
// Index Order#1's deliveryCases
const pagedIndexOfDeliveryCases = await client.orders.from(1).index.deliveryCases(options);
// Index Order#1's deskCases
const pagedIndexOfDeskCases = await client.orders.from(1).index.deskCases(options);
// Index Order#1's allOrderVersions
const pagedIndexOfHistorianVersions = await client.orders.from(1).index.allOrderVersions(options);
// Index Order#1's versions
const pagedIndexOfHistorianVersions = await client.orders.from(1).index.versions(options);
// Index Order#1's pollableRestaurants
const pagedIndexOfRestaurants = await client.orders.from(1).index.pollableRestaurants(options);
// Index Order#1's restaurantVotes
const pagedIndexOfRestaurantVotes = await client.orders.from(1).index.restaurantVotes(options);
// Index Order#1's teams
const pagedIndexOfTeams = await client.orders.from(1).index.teams(options);
// Index Order#1's allUsers
const pagedIndexOfUsers = await client.orders.from(1).index.allUsers(options);
// Index Order#1's orderedUsers
const pagedIndexOfUsers = await client.orders.from(1).index.orderedUsers(options);
// Index Order#1's orderedGroupOrderMembers
const pagedIndexOfGroupOrderMembers = await client.orders.from(1).index.orderedGroupOrderMembers(options);
// Index Order#1's joinedUsers
const pagedIndexOfUsers = await client.orders.from(1).index.joinedUsers(options);
// Index Order#1's teamMembers
const pagedIndexOfUsers = await client.orders.from(1).index.teamMembers(options);
// Index Order#1's groupOrderMembers
const pagedIndexOfGroupOrderMembers = await client.orders.from(1).index.groupOrderMembers(options);
// Index Order#1's orderItems
const pagedIndexOfOrderItems = await client.orders.from(1).index.orderItems(options);
// Index Order#1's ledgerItems
const pagedIndexOfAccountingLedgerItems = await client.orders.from(1).index.ledgerItems(options);
// Index Order#1's salesforceCases
const pagedIndexOfSalesforceCases = await client.orders.from(1).index.salesforceCases(options);
// Index Order#1's notificationLogs
const pagedIndexOfNotificationLogs = await client.orders.from(1).index.notificationLogs(options);
```
### OrderItem
See [OrderItemFilter](#resource-filter-OrderItem) for valid filters.
See [OrderItem](#resource-OrderItem) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singleOrderItem= await client.orderItems.get(1, options);
const pagedIndexOfOrderItems = await client.orderItems.index(options);
// Related Resources
// To One
// Get OrderItem#1's order
const singleOrder = await client.orderItems.from(1).get.order(1, options);
// Get OrderItem#1's menuItem
const singleMenuItem = await client.orderItems.from(1).get.menuItem(1, options);
// Get OrderItem#1's groupOrderMember
const singleGroupOrderMember = await client.orderItems.from(1).get.groupOrderMember(1, options);
// To Many
// Index OrderItem#1's menuOptionItems
const pagedIndexOfMenuOptionItems = await client.orderItems.from(1).index.menuOptionItems(options);
```
### PaymentAccount
See [PaymentAccountFilter](#resource-filter-PaymentAccount) for valid filters.
See [PaymentAccount](#resource-PaymentAccount) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singlePaymentAccount= await client.paymentAccounts.get(1, options);
const pagedIndexOfPaymentAccounts = await client.paymentAccounts.index(options);
```
### PaymentCard
See [PaymentCardFilter](#resource-filter-PaymentCard) for valid filters.
See [PaymentCard](#resource-PaymentCard) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const singlePaymentCard= await client.paymentCards.get(1, options);
const pagedIndexOfPaymentCards = await client.paymentCards.index(options);
// Related Resources
// To One
// Get PaymentCard#1's client
const singleClient = await client.paymentCards.from(1).get.client(1, options);
// Get PaymentCard#1's user
const singleUser = await client.paymentCards.from(1).get.user(1, options);
```
### PayrollRun
See [PayrollRunFilter](#resource-filter-PayrollRun) for valid filters.
See [PayrollRun](#resource-PayrollRun) for the resource schema.
```JavaScript
const options = {
// this is used to include related resources on gets or indexes
// if provided it will include them on the returned resources
// see http://jsonapi.org/format/#fetching-includes for more details
include: '',
// only valid for index fields
fitlers: {},
sort: '',
page: {
offet: 0,
limit: 20
}
};
const single