@chift/chift-nodejs 1.0.15 → 1.0.16
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.
- package/.eslintcache +1 -1
- package/CHANGELOG.md +4 -1
- package/dist/src/modules/api.d.ts +60 -0
- package/dist/src/modules/consumer.d.ts +12 -1
- package/dist/src/modules/consumers.d.ts +55 -0
- package/dist/src/modules/integrations.d.ts +5 -0
- package/dist/src/modules/sync.d.ts +44 -0
- package/dist/src/types/public-api/schema.d.ts +69 -25
- package/package.json +1 -1
- package/src/modules/consumer.ts +3 -1
- package/src/types/public-api/schema.d.ts +69 -25
- package/src/types/public-api/schema.ts +69 -25
|
@@ -863,9 +863,15 @@ export interface components {
|
|
|
863
863
|
schemas: {
|
|
864
864
|
/** AccountBalance */
|
|
865
865
|
AccountBalance: {
|
|
866
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* Account Number
|
|
868
|
+
* @description Number of the account
|
|
869
|
+
*/
|
|
867
870
|
account_number: string;
|
|
868
|
-
/**
|
|
871
|
+
/**
|
|
872
|
+
* Account Name
|
|
873
|
+
* @description Display name of the account
|
|
874
|
+
*/
|
|
869
875
|
account_name?: string;
|
|
870
876
|
/** Debit */
|
|
871
877
|
debit: number;
|
|
@@ -3154,6 +3160,12 @@ export interface components {
|
|
|
3154
3160
|
logo_url: string;
|
|
3155
3161
|
/** Icon Url */
|
|
3156
3162
|
icon_url: string;
|
|
3163
|
+
/**
|
|
3164
|
+
* Post Connections
|
|
3165
|
+
* @description List of post-connections that can be activated for this integration.
|
|
3166
|
+
* @default []
|
|
3167
|
+
*/
|
|
3168
|
+
post_connections?: components['schemas']['app__routers__integrations__PostConnectionItem'][];
|
|
3157
3169
|
/**
|
|
3158
3170
|
* Credentials
|
|
3159
3171
|
* @description List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.
|
|
@@ -4783,6 +4795,11 @@ export interface components {
|
|
|
4783
4795
|
* @description Technical id of the transaction in the eCommerce
|
|
4784
4796
|
*/
|
|
4785
4797
|
id: string;
|
|
4798
|
+
/**
|
|
4799
|
+
* Created On
|
|
4800
|
+
* Format: date-time
|
|
4801
|
+
*/
|
|
4802
|
+
created_on?: string;
|
|
4786
4803
|
/**
|
|
4787
4804
|
* Payment Method Id
|
|
4788
4805
|
* @description Technical id of the payment method in the eCommerce
|
|
@@ -4931,9 +4948,15 @@ export interface components {
|
|
|
4931
4948
|
total: number;
|
|
4932
4949
|
/** Tax Amount */
|
|
4933
4950
|
tax_amount: number;
|
|
4934
|
-
/**
|
|
4951
|
+
/**
|
|
4952
|
+
* Total Discount
|
|
4953
|
+
* @default 0
|
|
4954
|
+
*/
|
|
4935
4955
|
total_discount?: number;
|
|
4936
|
-
/**
|
|
4956
|
+
/**
|
|
4957
|
+
* Total Refund
|
|
4958
|
+
* @default 0
|
|
4959
|
+
*/
|
|
4937
4960
|
total_refund?: number;
|
|
4938
4961
|
/**
|
|
4939
4962
|
* Total Tip
|
|
@@ -4952,6 +4975,8 @@ export interface components {
|
|
|
4952
4975
|
location_id?: string;
|
|
4953
4976
|
/** Taxes */
|
|
4954
4977
|
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4978
|
+
/** Guests */
|
|
4979
|
+
guests?: number;
|
|
4955
4980
|
/** Items */
|
|
4956
4981
|
items: components['schemas']['PMSOrderLineItem'][];
|
|
4957
4982
|
/**
|
|
@@ -5170,9 +5195,15 @@ export interface components {
|
|
|
5170
5195
|
total: number;
|
|
5171
5196
|
/** Tax Amount */
|
|
5172
5197
|
tax_amount: number;
|
|
5173
|
-
/**
|
|
5198
|
+
/**
|
|
5199
|
+
* Total Discount
|
|
5200
|
+
* @default 0
|
|
5201
|
+
*/
|
|
5174
5202
|
total_discount?: number;
|
|
5175
|
-
/**
|
|
5203
|
+
/**
|
|
5204
|
+
* Total Refund
|
|
5205
|
+
* @default 0
|
|
5206
|
+
*/
|
|
5176
5207
|
total_refund?: number;
|
|
5177
5208
|
/**
|
|
5178
5209
|
* Total Tip
|
|
@@ -5191,6 +5222,8 @@ export interface components {
|
|
|
5191
5222
|
location_id?: string;
|
|
5192
5223
|
/** Taxes */
|
|
5193
5224
|
taxes?: components['schemas']['TotalTaxItem'][];
|
|
5225
|
+
/** Guests */
|
|
5226
|
+
guests?: number;
|
|
5194
5227
|
/** Payments */
|
|
5195
5228
|
payments: components['schemas']['POSPaymentItem'][];
|
|
5196
5229
|
/** Items */
|
|
@@ -5394,24 +5427,6 @@ export interface components {
|
|
|
5394
5427
|
/** Country */
|
|
5395
5428
|
country?: string;
|
|
5396
5429
|
};
|
|
5397
|
-
/** PostConnectionItem */
|
|
5398
|
-
PostConnectionItem: {
|
|
5399
|
-
/**
|
|
5400
|
-
* Integrationid
|
|
5401
|
-
* @description Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
5402
|
-
*/
|
|
5403
|
-
integrationid?: number;
|
|
5404
|
-
/**
|
|
5405
|
-
* Name
|
|
5406
|
-
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
5407
|
-
*/
|
|
5408
|
-
name?: string;
|
|
5409
|
-
/**
|
|
5410
|
-
* Credentials
|
|
5411
|
-
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
5412
|
-
*/
|
|
5413
|
-
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
5414
|
-
};
|
|
5415
5430
|
/** PostConsumerItem */
|
|
5416
5431
|
PostConsumerItem: {
|
|
5417
5432
|
/** Name */
|
|
@@ -6590,6 +6605,24 @@ export interface components {
|
|
|
6590
6605
|
/** Value */
|
|
6591
6606
|
value: string;
|
|
6592
6607
|
};
|
|
6608
|
+
/** PostConnectionItem */
|
|
6609
|
+
app__routers__connections__PostConnectionItem: {
|
|
6610
|
+
/**
|
|
6611
|
+
* Integrationid
|
|
6612
|
+
* @description Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
6613
|
+
*/
|
|
6614
|
+
integrationid?: number;
|
|
6615
|
+
/**
|
|
6616
|
+
* Name
|
|
6617
|
+
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
6618
|
+
*/
|
|
6619
|
+
name?: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* Credentials
|
|
6622
|
+
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
6623
|
+
*/
|
|
6624
|
+
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
6625
|
+
};
|
|
6593
6626
|
/**
|
|
6594
6627
|
* Status
|
|
6595
6628
|
* @description An enumeration.
|
|
@@ -6612,6 +6645,15 @@ export interface components {
|
|
|
6612
6645
|
*/
|
|
6613
6646
|
optional?: boolean;
|
|
6614
6647
|
};
|
|
6648
|
+
/** PostConnectionItem */
|
|
6649
|
+
app__routers__integrations__PostConnectionItem: {
|
|
6650
|
+
/** Title */
|
|
6651
|
+
title: string;
|
|
6652
|
+
/** Optional */
|
|
6653
|
+
optional: boolean;
|
|
6654
|
+
/** Resource */
|
|
6655
|
+
resource: string;
|
|
6656
|
+
};
|
|
6615
6657
|
/**
|
|
6616
6658
|
* Status
|
|
6617
6659
|
* @description An enumeration.
|
|
@@ -7060,7 +7102,7 @@ export interface operations {
|
|
|
7060
7102
|
};
|
|
7061
7103
|
requestBody?: {
|
|
7062
7104
|
content: {
|
|
7063
|
-
'application/json': components['schemas']['
|
|
7105
|
+
'application/json': components['schemas']['app__routers__connections__PostConnectionItem'];
|
|
7064
7106
|
};
|
|
7065
7107
|
};
|
|
7066
7108
|
responses: {
|
|
@@ -10754,6 +10796,8 @@ export interface operations {
|
|
|
10754
10796
|
include_detailed_refunds?: components['schemas']['BoolParam'];
|
|
10755
10797
|
/** @description Include detailed information about categories */
|
|
10756
10798
|
include_product_categories?: components['schemas']['BoolParam'];
|
|
10799
|
+
/** @description Include detailed information about customer */
|
|
10800
|
+
include_customer_details?: components['schemas']['BoolParam'];
|
|
10757
10801
|
page?: number;
|
|
10758
10802
|
size?: number;
|
|
10759
10803
|
};
|
|
@@ -863,9 +863,15 @@ export interface components {
|
|
|
863
863
|
schemas: {
|
|
864
864
|
/** AccountBalance */
|
|
865
865
|
AccountBalance: {
|
|
866
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* Account Number
|
|
868
|
+
* @description Number of the account
|
|
869
|
+
*/
|
|
867
870
|
account_number: string;
|
|
868
|
-
/**
|
|
871
|
+
/**
|
|
872
|
+
* Account Name
|
|
873
|
+
* @description Display name of the account
|
|
874
|
+
*/
|
|
869
875
|
account_name?: string;
|
|
870
876
|
/** Debit */
|
|
871
877
|
debit: number;
|
|
@@ -3154,6 +3160,12 @@ export interface components {
|
|
|
3154
3160
|
logo_url: string;
|
|
3155
3161
|
/** Icon Url */
|
|
3156
3162
|
icon_url: string;
|
|
3163
|
+
/**
|
|
3164
|
+
* Post Connections
|
|
3165
|
+
* @description List of post-connections that can be activated for this integration.
|
|
3166
|
+
* @default []
|
|
3167
|
+
*/
|
|
3168
|
+
post_connections?: components['schemas']['app__routers__integrations__PostConnectionItem'][];
|
|
3157
3169
|
/**
|
|
3158
3170
|
* Credentials
|
|
3159
3171
|
* @description List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.
|
|
@@ -4783,6 +4795,11 @@ export interface components {
|
|
|
4783
4795
|
* @description Technical id of the transaction in the eCommerce
|
|
4784
4796
|
*/
|
|
4785
4797
|
id: string;
|
|
4798
|
+
/**
|
|
4799
|
+
* Created On
|
|
4800
|
+
* Format: date-time
|
|
4801
|
+
*/
|
|
4802
|
+
created_on?: string;
|
|
4786
4803
|
/**
|
|
4787
4804
|
* Payment Method Id
|
|
4788
4805
|
* @description Technical id of the payment method in the eCommerce
|
|
@@ -4931,9 +4948,15 @@ export interface components {
|
|
|
4931
4948
|
total: number;
|
|
4932
4949
|
/** Tax Amount */
|
|
4933
4950
|
tax_amount: number;
|
|
4934
|
-
/**
|
|
4951
|
+
/**
|
|
4952
|
+
* Total Discount
|
|
4953
|
+
* @default 0
|
|
4954
|
+
*/
|
|
4935
4955
|
total_discount?: number;
|
|
4936
|
-
/**
|
|
4956
|
+
/**
|
|
4957
|
+
* Total Refund
|
|
4958
|
+
* @default 0
|
|
4959
|
+
*/
|
|
4937
4960
|
total_refund?: number;
|
|
4938
4961
|
/**
|
|
4939
4962
|
* Total Tip
|
|
@@ -4952,6 +4975,8 @@ export interface components {
|
|
|
4952
4975
|
location_id?: string;
|
|
4953
4976
|
/** Taxes */
|
|
4954
4977
|
taxes?: components['schemas']['TotalTaxItem'][];
|
|
4978
|
+
/** Guests */
|
|
4979
|
+
guests?: number;
|
|
4955
4980
|
/** Items */
|
|
4956
4981
|
items: components['schemas']['PMSOrderLineItem'][];
|
|
4957
4982
|
/**
|
|
@@ -5170,9 +5195,15 @@ export interface components {
|
|
|
5170
5195
|
total: number;
|
|
5171
5196
|
/** Tax Amount */
|
|
5172
5197
|
tax_amount: number;
|
|
5173
|
-
/**
|
|
5198
|
+
/**
|
|
5199
|
+
* Total Discount
|
|
5200
|
+
* @default 0
|
|
5201
|
+
*/
|
|
5174
5202
|
total_discount?: number;
|
|
5175
|
-
/**
|
|
5203
|
+
/**
|
|
5204
|
+
* Total Refund
|
|
5205
|
+
* @default 0
|
|
5206
|
+
*/
|
|
5176
5207
|
total_refund?: number;
|
|
5177
5208
|
/**
|
|
5178
5209
|
* Total Tip
|
|
@@ -5191,6 +5222,8 @@ export interface components {
|
|
|
5191
5222
|
location_id?: string;
|
|
5192
5223
|
/** Taxes */
|
|
5193
5224
|
taxes?: components['schemas']['TotalTaxItem'][];
|
|
5225
|
+
/** Guests */
|
|
5226
|
+
guests?: number;
|
|
5194
5227
|
/** Payments */
|
|
5195
5228
|
payments: components['schemas']['POSPaymentItem'][];
|
|
5196
5229
|
/** Items */
|
|
@@ -5394,24 +5427,6 @@ export interface components {
|
|
|
5394
5427
|
/** Country */
|
|
5395
5428
|
country?: string;
|
|
5396
5429
|
};
|
|
5397
|
-
/** PostConnectionItem */
|
|
5398
|
-
PostConnectionItem: {
|
|
5399
|
-
/**
|
|
5400
|
-
* Integrationid
|
|
5401
|
-
* @description Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
5402
|
-
*/
|
|
5403
|
-
integrationid?: number;
|
|
5404
|
-
/**
|
|
5405
|
-
* Name
|
|
5406
|
-
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
5407
|
-
*/
|
|
5408
|
-
name?: string;
|
|
5409
|
-
/**
|
|
5410
|
-
* Credentials
|
|
5411
|
-
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
5412
|
-
*/
|
|
5413
|
-
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
5414
|
-
};
|
|
5415
5430
|
/** PostConsumerItem */
|
|
5416
5431
|
PostConsumerItem: {
|
|
5417
5432
|
/** Name */
|
|
@@ -6590,6 +6605,24 @@ export interface components {
|
|
|
6590
6605
|
/** Value */
|
|
6591
6606
|
value: string;
|
|
6592
6607
|
};
|
|
6608
|
+
/** PostConnectionItem */
|
|
6609
|
+
app__routers__connections__PostConnectionItem: {
|
|
6610
|
+
/**
|
|
6611
|
+
* Integrationid
|
|
6612
|
+
* @description Can be used to specify the integration code of a specific connector. If specified, the url will will point directly to the connection page of the connector and will redirect on save to the redirect url of the consumer if specified.
|
|
6613
|
+
*/
|
|
6614
|
+
integrationid?: number;
|
|
6615
|
+
/**
|
|
6616
|
+
* Name
|
|
6617
|
+
* @description Can be used to specify the name of the connection. Must be used in combination with an integrationid.
|
|
6618
|
+
*/
|
|
6619
|
+
name?: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* Credentials
|
|
6622
|
+
* @description Can be used to specify the credentials of your connection. Must be used in combination with an integrationid and a name. Please use the getIntegrations route to see the available credentials for each integration
|
|
6623
|
+
*/
|
|
6624
|
+
credentials?: components['schemas']['app__routers__connections__CredentialItem'][];
|
|
6625
|
+
};
|
|
6593
6626
|
/**
|
|
6594
6627
|
* Status
|
|
6595
6628
|
* @description An enumeration.
|
|
@@ -6612,6 +6645,15 @@ export interface components {
|
|
|
6612
6645
|
*/
|
|
6613
6646
|
optional?: boolean;
|
|
6614
6647
|
};
|
|
6648
|
+
/** PostConnectionItem */
|
|
6649
|
+
app__routers__integrations__PostConnectionItem: {
|
|
6650
|
+
/** Title */
|
|
6651
|
+
title: string;
|
|
6652
|
+
/** Optional */
|
|
6653
|
+
optional: boolean;
|
|
6654
|
+
/** Resource */
|
|
6655
|
+
resource: string;
|
|
6656
|
+
};
|
|
6615
6657
|
/**
|
|
6616
6658
|
* Status
|
|
6617
6659
|
* @description An enumeration.
|
|
@@ -7060,7 +7102,7 @@ export interface operations {
|
|
|
7060
7102
|
};
|
|
7061
7103
|
requestBody?: {
|
|
7062
7104
|
content: {
|
|
7063
|
-
'application/json': components['schemas']['
|
|
7105
|
+
'application/json': components['schemas']['app__routers__connections__PostConnectionItem'];
|
|
7064
7106
|
};
|
|
7065
7107
|
};
|
|
7066
7108
|
responses: {
|
|
@@ -10754,6 +10796,8 @@ export interface operations {
|
|
|
10754
10796
|
include_detailed_refunds?: components['schemas']['BoolParam'];
|
|
10755
10797
|
/** @description Include detailed information about categories */
|
|
10756
10798
|
include_product_categories?: components['schemas']['BoolParam'];
|
|
10799
|
+
/** @description Include detailed information about customer */
|
|
10800
|
+
include_customer_details?: components['schemas']['BoolParam'];
|
|
10757
10801
|
page?: number;
|
|
10758
10802
|
size?: number;
|
|
10759
10803
|
};
|