@kohost/api-client 7.25.0 → 7.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,186 +0,0 @@
1
- import defs from "./definitions.js";
2
- import type { FromSchema } from "json-schema-to-ts";
3
- export declare const orderSchema: {
4
- readonly $schema: "http://json-schema.org/draft-07/schema";
5
- readonly $id: "order.json";
6
- readonly title: "Order";
7
- readonly description: "A purchase order for products or services.";
8
- readonly type: "object";
9
- readonly required: readonly ["type", "status"];
10
- readonly additionalProperties: false;
11
- readonly properties: {
12
- readonly id: {
13
- readonly $ref: "definitions.json#/definitions/id";
14
- };
15
- readonly propertyId: {
16
- readonly type: "string";
17
- readonly description: "ID of the property this entity belongs to. Optional — used as a per-document filter inside the org-scoped database.";
18
- };
19
- readonly type: {
20
- readonly type: "string";
21
- readonly default: "order";
22
- readonly enum: readonly ["order"];
23
- };
24
- readonly orderNumber: {
25
- readonly type: "string";
26
- };
27
- readonly status: {
28
- readonly type: "string";
29
- readonly enum: readonly ["draft", "pendingPayment", "processing", "outForDelivery", "completed", "paymentFailed", "cancelled", "refunded"];
30
- };
31
- readonly userId: {
32
- readonly $ref: "definitions.json#/definitions/id";
33
- readonly description: "User id of purchaser";
34
- };
35
- readonly reservationId: {
36
- readonly $ref: "definitions.json#/definitions/id";
37
- readonly description: "Reservation id if the order is for a reservation";
38
- };
39
- readonly date: {
40
- readonly $ref: "definitions.json#/definitions/date";
41
- };
42
- readonly items: {
43
- readonly type: "array";
44
- readonly default: readonly [];
45
- readonly items: {
46
- readonly type: "object";
47
- readonly required: readonly ["name", "price"];
48
- readonly properties: {
49
- readonly additionalProperties: false;
50
- readonly name: {
51
- readonly type: "string";
52
- };
53
- readonly sku: {
54
- readonly type: "string";
55
- };
56
- readonly quantity: {
57
- readonly type: "number";
58
- readonly default: 1;
59
- };
60
- readonly price: {
61
- readonly type: "number";
62
- };
63
- readonly taxClass: {
64
- readonly type: "string";
65
- };
66
- readonly deliveryClass: {
67
- readonly type: "string";
68
- };
69
- readonly productId: {
70
- readonly type: "string";
71
- };
72
- };
73
- };
74
- };
75
- readonly taxes: {
76
- readonly type: "array";
77
- readonly default: readonly [];
78
- readonly items: {
79
- readonly type: "object";
80
- readonly required: readonly ["name", "rate"];
81
- readonly properties: {
82
- readonly additionalProperties: false;
83
- readonly name: {
84
- readonly type: "string";
85
- };
86
- readonly class: {
87
- readonly type: "string";
88
- };
89
- readonly rateType: {
90
- readonly type: "string";
91
- readonly enum: readonly ["percentage", "flat"];
92
- readonly default: "percentage";
93
- };
94
- readonly rate: {
95
- readonly type: "number";
96
- };
97
- readonly total: {
98
- readonly type: "number";
99
- };
100
- };
101
- };
102
- };
103
- readonly fees: {
104
- readonly type: "array";
105
- readonly default: readonly [];
106
- readonly items: {
107
- readonly type: "object";
108
- readonly required: readonly ["name", "price"];
109
- readonly properties: {
110
- readonly additionalProperties: false;
111
- readonly name: {
112
- readonly type: "string";
113
- };
114
- readonly price: {
115
- readonly type: "number";
116
- };
117
- };
118
- };
119
- };
120
- readonly delivery: {
121
- readonly type: "array";
122
- readonly default: readonly [];
123
- readonly items: {
124
- readonly type: "object";
125
- readonly required: readonly ["name", "rate"];
126
- readonly properties: {
127
- readonly additionalProperties: false;
128
- readonly name: {
129
- readonly type: "string";
130
- };
131
- readonly class: {
132
- readonly type: "string";
133
- };
134
- readonly rateType: {
135
- readonly type: "string";
136
- readonly enum: readonly ["percentage", "flat"];
137
- readonly default: "percentage";
138
- };
139
- readonly rate: {
140
- readonly type: "number";
141
- };
142
- readonly total: {
143
- readonly type: "number";
144
- };
145
- };
146
- };
147
- };
148
- readonly payments: {
149
- readonly type: "array";
150
- readonly default: readonly [];
151
- readonly items: {
152
- readonly type: "object";
153
- readonly properties: {
154
- readonly method: {
155
- readonly type: "string";
156
- readonly enum: readonly ["folio", "invoice", "amex", "visa", "masterCard", "maestro", "discover", "diners", "jcb", "applePay", "alipay", "chinaUnionPay", "vpay"];
157
- };
158
- readonly name: {
159
- readonly type: "string";
160
- };
161
- readonly date: {
162
- readonly $ref: "definitions.json#/definitions/date";
163
- };
164
- readonly amount: {
165
- readonly type: "number";
166
- };
167
- readonly transactionReference: {
168
- readonly type: "string";
169
- };
170
- };
171
- };
172
- };
173
- readonly createdAt: {
174
- readonly $ref: "definitions.json#/definitions/date";
175
- };
176
- readonly updatedAt: {
177
- readonly $ref: "definitions.json#/definitions/date";
178
- };
179
- readonly deletedAt: {
180
- readonly $ref: "definitions.json#/definitions/date";
181
- };
182
- };
183
- };
184
- export type OrderSchema = FromSchema<typeof orderSchema, {
185
- references: [typeof defs];
186
- }>;
@@ -1,27 +0,0 @@
1
- export interface DescribeConciergeBillsSummaryCommandConfig {
2
- data?: Record<string, unknown> | unknown[] | null;
3
- headers?: Record<string, string> | null;
4
- query?: Record<string, unknown> | null;
5
- }
6
- export interface DescribeConciergeBillsSummaryCommandRequestConfig {
7
- method: "get";
8
- url: string;
9
- data: Record<string, unknown> | unknown[] | null;
10
- params: Record<string, unknown> | null;
11
- headers: Record<string, string> | null;
12
- [key: string]: unknown;
13
- }
14
- /**
15
- * Revenue, vendor cost, profit and margin billed through OneBill over a sentAt window, across the KFC-enabled organizations or one of them.
16
- */
17
- export declare class DescribeConciergeBillsSummaryCommand {
18
- url: string;
19
- data: Record<string, unknown> | unknown[] | null;
20
- query: Record<string, unknown> | null;
21
- headers: Record<string, string> | null;
22
- config: DescribeConciergeBillsSummaryCommandRequestConfig;
23
- static params: readonly [];
24
- static url: string;
25
- static method: "get";
26
- constructor(commandConfig: DescribeConciergeBillsSummaryCommandConfig, options?: Record<string, unknown>);
27
- }
@@ -1,27 +0,0 @@
1
- export interface ListConciergeWorkspaceBillLinesCommandConfig {
2
- data?: Record<string, unknown> | unknown[] | null;
3
- headers?: Record<string, string> | null;
4
- query?: Record<string, unknown> | null;
5
- }
6
- export interface ListConciergeWorkspaceBillLinesCommandRequestConfig {
7
- method: "get";
8
- url: string;
9
- data: Record<string, unknown> | unknown[] | null;
10
- params: Record<string, unknown> | null;
11
- headers: Record<string, string> | null;
12
- [key: string]: unknown;
13
- }
14
- /**
15
- * OneBill transactions view: every line on a sent or paid bill across every KFC-enabled organization, newest send first, paged and searchable, with the vendor-cost snapshot and resolved organization and vendor names.
16
- */
17
- export declare class ListConciergeWorkspaceBillLinesCommand {
18
- url: string;
19
- data: Record<string, unknown> | unknown[] | null;
20
- query: Record<string, unknown> | null;
21
- headers: Record<string, string> | null;
22
- config: ListConciergeWorkspaceBillLinesCommandRequestConfig;
23
- static params: readonly [];
24
- static url: string;
25
- static method: "get";
26
- constructor(commandConfig: ListConciergeWorkspaceBillLinesCommandConfig, options?: Record<string, unknown>);
27
- }