@munchi_oy/core 1.9.76 → 1.9.78

package/dist/generated/api.d.ts

@@ -927,6 +927,12 @@ export interface BusinessInfoResponseDto {
      * @memberof BusinessInfoResponseDto
      */
     'logoUrl': string | null;
+    /**
+     * The URL of the business banner
+     * @type {string}
+     * @memberof BusinessInfoResponseDto
+     */
+    'bannerUrl': string | null;
     /**
      * The phone of the business
      * @type {string}
@@ -1074,6 +1080,12 @@ export interface BusinessInfoV2ResponseDto {
      * @memberof BusinessInfoV2ResponseDto
      */
     'logoUrl': string | null;
+    /**
+     * The URL of the business banner
+     * @type {string}
+     * @memberof BusinessInfoV2ResponseDto
+     */
+    'bannerUrl': string | null;
     /**
      * The phone of the business
      * @type {string}
@@ -5009,6 +5021,62 @@ export interface DiscoverTerminalDto {
      */
     'provider': PaymentProvider;
 }
+/**
+ *
+ * @export
+ * @interface DisplayInitBodyDto
+ */
+export interface DisplayInitBodyDto {
+    /**
+     * Optional human-readable label for the display device.
+     * @type {string}
+     * @memberof DisplayInitBodyDto
+     */
+    'displayName'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface DisplayInitResponseDto
+ */
+export interface DisplayInitResponseDto {
+    /**
+     * Server-issued display identity.
+     * @type {string}
+     * @memberof DisplayInitResponseDto
+     */
+    'displayId': string;
+    /**
+     * Short pairing code shown on the display.
+     * @type {string}
+     * @memberof DisplayInitResponseDto
+     */
+    'code': string;
+    /**
+     * One-time nonce carried in the pairing QR.
+     * @type {string}
+     * @memberof DisplayInitResponseDto
+     */
+    'nonce': string;
+    /**
+     * Ably channel the display subscribes to for the ack.
+     * @type {string}
+     * @memberof DisplayInitResponseDto
+     */
+    'pairingChannel': string;
+    /**
+     * Epoch ms when the code/nonce expires.
+     * @type {number}
+     * @memberof DisplayInitResponseDto
+     */
+    'expiresAt': number;
+    /**
+     * Ably TokenRequest scoped to the pairing channel.
+     * @type {object}
+     * @memberof DisplayInitResponseDto
+     */
+    'ablyTokenRequest': object;
+}
 /**
  *
  * @export
@@ -12223,6 +12291,68 @@ export interface PaginationDto {
      */
     'totalPages': number;
 }
+/**
+ *
+ * @export
+ * @interface PairDisplayBodyDto
+ */
+export interface PairDisplayBodyDto {
+    /**
+     * Stable POS device identifier.
+     * @type {string}
+     * @memberof PairDisplayBodyDto
+     */
+    'posDeviceId': string;
+    /**
+     * Pairing code entered on the POS.
+     * @type {string}
+     * @memberof PairDisplayBodyDto
+     */
+    'code'?: string;
+    /**
+     * Display id (QR path, with nonce).
+     * @type {string}
+     * @memberof PairDisplayBodyDto
+     */
+    'displayId'?: string;
+    /**
+     * One-time nonce (QR path).
+     * @type {string}
+     * @memberof PairDisplayBodyDto
+     */
+    'nonce'?: string;
+    /**
+     * Business to pair to; must be in the caller\'s scope.
+     * @type {number}
+     * @memberof PairDisplayBodyDto
+     */
+    'businessId'?: number;
+}
+/**
+ *
+ * @export
+ * @interface PairDisplayResponseDto
+ */
+export interface PairDisplayResponseDto {
+    /**
+     *
+     * @type {string}
+     * @memberof PairDisplayResponseDto
+     */
+    'sessionId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof PairDisplayResponseDto
+     */
+    'sessionChannel': string;
+    /**
+     *
+     * @type {string}
+     * @memberof PairDisplayResponseDto
+     */
+    'displayId': string;
+}
 /**
  *
  * @export
@@ -18424,6 +18554,55 @@ export interface ReportingCategoryDto {
      */
     'updated_at': string;
 }
+/**
+ *
+ * @export
+ * @interface RequestSessionTokenBodyDto
+ */
+export interface RequestSessionTokenBodyDto {
+    /**
+     *
+     * @type {string}
+     * @memberof RequestSessionTokenBodyDto
+     */
+    'sessionId': string;
+    /**
+     * Which device is requesting the token.
+     * @type {string}
+     * @memberof RequestSessionTokenBodyDto
+     */
+    'role': RoleEnum;
+    /**
+     * Requesting device id (posDeviceId or displayId).
+     * @type {string}
+     * @memberof RequestSessionTokenBodyDto
+     */
+    'deviceId': string;
+}
+export declare const RoleEnum: {
+    readonly Pos: "pos";
+    readonly Display: "display";
+};
+export type RoleEnum = typeof RoleEnum[keyof typeof RoleEnum];
+/**
+ *
+ * @export
+ * @interface RequestSessionTokenResponseDto
+ */
+export interface RequestSessionTokenResponseDto {
+    /**
+     * Ably TokenRequest scoped to the session channel.
+     * @type {object}
+     * @memberof RequestSessionTokenResponseDto
+     */
+    'ablyTokenRequest': object;
+    /**
+     *
+     * @type {string}
+     * @memberof RequestSessionTokenResponseDto
+     */
+    'sessionChannel': string;
+}
 /**
  *
  * @export
@@ -28304,6 +28483,165 @@ export declare class CoursesApi extends BaseAPI implements CoursesApiInterface {
      */
     getCourses(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CourseDto[], any, {}>>;
 }
+/**
+ * DisplayApi - axios parameter creator
+ * @export
+ */
+export declare const DisplayApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Register a customer display and mint a pairing token + code.
+     * @param {DisplayInitBodyDto} [displayInitBodyDto]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    init: (displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Pair a display with the POS using its code or QR nonce.
+     * @param {PairDisplayBodyDto} pairDisplayBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pair: (pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Mint a session-channel Ably token scoped to the device role.
+     * @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sessionToken: (requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DisplayApi - functional programming interface
+ * @export
+ */
+export declare const DisplayApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Register a customer display and mint a pairing token + code.
+     * @param {DisplayInitBodyDto} [displayInitBodyDto]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayInitResponseDto>>;
+    /**
+     *
+     * @summary Pair a display with the POS using its code or QR nonce.
+     * @param {PairDisplayBodyDto} pairDisplayBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PairDisplayResponseDto>>;
+    /**
+     *
+     * @summary Mint a session-channel Ably token scoped to the device role.
+     * @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestSessionTokenResponseDto>>;
+};
+/**
+ * DisplayApi - factory interface
+ * @export
+ */
+export declare const DisplayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Register a customer display and mint a pairing token + code.
+     * @param {DisplayInitBodyDto} [displayInitBodyDto]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    init(displayInitBodyDto?: DisplayInitBodyDto, options?: any): AxiosPromise<DisplayInitResponseDto>;
+    /**
+     *
+     * @summary Pair a display with the POS using its code or QR nonce.
+     * @param {PairDisplayBodyDto} pairDisplayBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: any): AxiosPromise<PairDisplayResponseDto>;
+    /**
+     *
+     * @summary Mint a session-channel Ably token scoped to the device role.
+     * @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: any): AxiosPromise<RequestSessionTokenResponseDto>;
+};
+/**
+ * DisplayApi - interface
+ * @export
+ * @interface DisplayApi
+ */
+export interface DisplayApiInterface {
+    /**
+     *
+     * @summary Register a customer display and mint a pairing token + code.
+     * @param {DisplayInitBodyDto} [displayInitBodyDto]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DisplayApiInterface
+     */
+    init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): AxiosPromise<DisplayInitResponseDto>;
+    /**
+     *
+     * @summary Pair a display with the POS using its code or QR nonce.
+     * @param {PairDisplayBodyDto} pairDisplayBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DisplayApiInterface
+     */
+    pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): AxiosPromise<PairDisplayResponseDto>;
+    /**
+     *
+     * @summary Mint a session-channel Ably token scoped to the device role.
+     * @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DisplayApiInterface
+     */
+    sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): AxiosPromise<RequestSessionTokenResponseDto>;
+}
+/**
+ * DisplayApi - object-oriented interface
+ * @export
+ * @class DisplayApi
+ * @extends {BaseAPI}
+ */
+export declare class DisplayApi extends BaseAPI implements DisplayApiInterface {
+    /**
+     *
+     * @summary Register a customer display and mint a pairing token + code.
+     * @param {DisplayInitBodyDto} [displayInitBodyDto]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DisplayApi
+     */
+    init(displayInitBodyDto?: DisplayInitBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisplayInitResponseDto, any, {}>>;
+    /**
+     *
+     * @summary Pair a display with the POS using its code or QR nonce.
+     * @param {PairDisplayBodyDto} pairDisplayBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DisplayApi
+     */
+    pair(pairDisplayBodyDto: PairDisplayBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PairDisplayResponseDto, any, {}>>;
+    /**
+     *
+     * @summary Mint a session-channel Ably token scoped to the device role.
+     * @param {RequestSessionTokenBodyDto} requestSessionTokenBodyDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DisplayApi
+     */
+    sessionToken(requestSessionTokenBodyDto: RequestSessionTokenBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestSessionTokenResponseDto, any, {}>>;
+}
 /**
  * EmployeesApi - axios parameter creator
  * @export