Methods
Static activateOffer
- activateOffer(title_id, offer_id, options?): AxiosPromise<default<PreorderOffer>>
Parameters
title_id: string
offer_id: string
Static adminOrderAction
- adminOrderAction(title_id, order_id, action, options?): AxiosPromise<default<PreorderOrder>>
Parameters
title_id: string
order_id: string
Static adminOrders
- adminOrders(title_id, filters?, options?): AxiosPromise<default<{
orders: PreorderOrder[];
pagination: Record<string, number>;
}>> Returns AxiosPromise<default<{
orders: PreorderOrder[];
pagination: Record<string, number>;
}>>
Static archiveOffer
- archiveOffer(title_id, offer_id, options?): AxiosPromise<default<PreorderOffer>>
Parameters
title_id: string
offer_id: string
Static authenticateHostedSession
- authenticateHostedSession(title_id, session_id, checkoutToken, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
Static checkoutHostedSession
- checkoutHostedSession(title_id, session_id, checkoutToken, data, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
data: {
accept_terms: boolean;
payment_intent_id?: string;
payment_method_id?: string;
}
accept_terms: boolean
Optional payment_intent_id?: string
Optional payment_method_id?: string
Static createHostedRestoreSession
Static createHostedSession
Static hostedMine
- hostedMine(title_id, session_id, checkoutToken, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
Static Private hostedOptions
Static hostedSession
- hostedSession(title_id, session_id, checkoutToken, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
Static importKeyFile
- importKeyFile<T>(title_id, offer_id, file): AxiosPromise<default<T>>
Parameters
title_id: string
offer_id: string
file: Blob | File
Returns AxiosPromise<default<T>>
Static importKeys
- importKeys(title_id, offer_id, keys, options?): AxiosPromise<default<{
duplicate_existing: number;
duplicate_in_upload: number;
inserted: number;
invalid: number;
inventory: PreorderInventory;
}>> Parameters
title_id: string
offer_id: string
keys: string[]
Returns AxiosPromise<default<{
duplicate_existing: number;
duplicate_in_upload: number;
inserted: number;
invalid: number;
inventory: PreorderInventory;
}>>
Static inventory
- inventory(title_id, offer_id, options?): AxiosPromise<default<PreorderInventory>>
Parameters
title_id: string
offer_id: string
Static mcpCapabilities
- mcpCapabilities<T>(title_id, options?): AxiosPromise<default<T>>
Returns AxiosPromise<default<T>>
Static mcpOperation
- mcpOperation<T>(title_id, operation, argumentsData?, options?): AxiosPromise<default<T>>
Parameters
title_id: string
operation: string
argumentsData: Record<string, unknown> = {}
Returns AxiosPromise<default<T>>
Static offer
- offer(title_id, offer_id, options?): AxiosPromise<default<PreorderOffer>>
Parameters
title_id: string
offer_id: string
Static order
- order(title_id, order_id, options?): AxiosPromise<default<PreorderOrder>>
Parameters
title_id: string
order_id: string
Static pauseOffer
- pauseOffer(title_id, offer_id, options?): AxiosPromise<default<PreorderOffer>>
Parameters
title_id: string
offer_id: string
Static purchase
- purchase(title_id, offer_id, data, options?): AxiosPromise<default<PreorderOrder>>
Parameters
title_id: string
offer_id: string
Static reconcileHostedSession
- reconcileHostedSession(title_id, session_id, checkoutToken, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
Static refundHostedOrder
- refundHostedOrder(title_id, session_id, checkoutToken, order_id, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
order_id: string
Static refundMine
- refundMine(title_id, order_id, options?): AxiosPromise<default<PreorderOrder>>
Parameters
title_id: string
order_id: string
Static resendHostedAccess
- resendHostedAccess(title_id, session_id, checkoutToken, order_id, options?): AxiosPromise<default<{
resent: boolean;
}>> Parameters
title_id: string
session_id: string
checkoutToken: string
order_id: string
Returns AxiosPromise<default<{
resent: boolean;
}>>
Static resendMine
- resendMine(title_id, order_id, options?): AxiosPromise<default<{
resent: boolean;
}>> Parameters
title_id: string
order_id: string
Returns AxiosPromise<default<{
resent: boolean;
}>>
Static retireKey
- retireKey(title_id, offer_id, key_id, reason, options?): AxiosPromise<default<{
id: string;
masked_suffix: string;
status: string;
}>> Parameters
title_id: string
offer_id: string
key_id: string
reason: string
Returns AxiosPromise<default<{
id: string;
masked_suffix: string;
status: string;
}>>
Static retryHostedSession
- retryHostedSession(title_id, session_id, checkoutToken, options?): AxiosPromise<default<HostedPreorderSession>>
Parameters
title_id: string
session_id: string
checkoutToken: string
Static updateOffer
- updateOffer(title_id, offer_id, data, options?): AxiosPromise<default<PreorderOffer>>
Parameters
title_id: string
offer_id: string
Static updateSettings
- updateSettings(title_id, data, options?): AxiosPromise<default<PreorderSettings>>
Parameters
title_id: string
data: Partial<Pick<PreorderSettings, "enabled" | "hosted_checkout_enabled" | "timezone">>