@redotech/redo-api-schema 2.2.77 → 2.2.81
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/lib/openapi.d.ts +88 -0
- package/lib/openapi.yaml +77 -0
- package/package.json +1 -1
package/lib/openapi.d.ts
CHANGED
|
@@ -17,6 +17,13 @@ export interface paths {
|
|
|
17
17
|
*/
|
|
18
18
|
get: operations["Invoice csv get"];
|
|
19
19
|
};
|
|
20
|
+
"/invoices/pending/items.csv": {
|
|
21
|
+
/**
|
|
22
|
+
* Get pending invoice
|
|
23
|
+
* @description Get an invoice as a CSV.
|
|
24
|
+
*/
|
|
25
|
+
get: operations["Invoice pending csv get"];
|
|
26
|
+
};
|
|
20
27
|
"/returns/{returnId}": {
|
|
21
28
|
/**
|
|
22
29
|
* Get return
|
|
@@ -63,6 +70,20 @@ export interface paths {
|
|
|
63
70
|
};
|
|
64
71
|
};
|
|
65
72
|
};
|
|
73
|
+
"/stores/{storeId}/admin": {
|
|
74
|
+
/**
|
|
75
|
+
* Navigate to merchant admin
|
|
76
|
+
* @description Navigate to the merchant admin page.
|
|
77
|
+
*/
|
|
78
|
+
get: operations["Merchant admin navigate"];
|
|
79
|
+
};
|
|
80
|
+
"/stores/{storeId}/coverage-info": {
|
|
81
|
+
/**
|
|
82
|
+
* Navigate to coverage info
|
|
83
|
+
* @description Navigate to the coverage info page.
|
|
84
|
+
*/
|
|
85
|
+
get: operations["Customer portal navigate"];
|
|
86
|
+
};
|
|
66
87
|
"/stores/{storeId}/coverage-products": {
|
|
67
88
|
/**
|
|
68
89
|
* Get coverage products
|
|
@@ -70,6 +91,13 @@ export interface paths {
|
|
|
70
91
|
*/
|
|
71
92
|
post: operations["Coverage products"];
|
|
72
93
|
};
|
|
94
|
+
"/stores/{storeId}/customer-portal": {
|
|
95
|
+
/**
|
|
96
|
+
* Navigate to customer portal
|
|
97
|
+
* @description Navigate to the customer portal.
|
|
98
|
+
*/
|
|
99
|
+
get: operations["Customer portal navigate"];
|
|
100
|
+
};
|
|
73
101
|
"/stores/{storeId}/invoices": {
|
|
74
102
|
/**
|
|
75
103
|
* Get invoice
|
|
@@ -880,6 +908,26 @@ export interface operations {
|
|
|
880
908
|
};
|
|
881
909
|
};
|
|
882
910
|
};
|
|
911
|
+
/**
|
|
912
|
+
* Get pending invoice
|
|
913
|
+
* @description Get an invoice as a CSV.
|
|
914
|
+
*/
|
|
915
|
+
"Invoice pending csv get": {
|
|
916
|
+
responses: {
|
|
917
|
+
/** @description Success */
|
|
918
|
+
200: {
|
|
919
|
+
content: {
|
|
920
|
+
"text/csv": string;
|
|
921
|
+
};
|
|
922
|
+
};
|
|
923
|
+
/** @description Error */
|
|
924
|
+
default: {
|
|
925
|
+
content: {
|
|
926
|
+
"application/problem+json": components["schemas"]["error.schema"];
|
|
927
|
+
};
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
};
|
|
883
931
|
/**
|
|
884
932
|
* Get return
|
|
885
933
|
* @description Get return.
|
|
@@ -1024,6 +1072,46 @@ export interface operations {
|
|
|
1024
1072
|
};
|
|
1025
1073
|
};
|
|
1026
1074
|
};
|
|
1075
|
+
/**
|
|
1076
|
+
* Navigate to merchant admin
|
|
1077
|
+
* @description Navigate to the merchant admin page.
|
|
1078
|
+
*/
|
|
1079
|
+
"Merchant admin navigate": {
|
|
1080
|
+
parameters: {
|
|
1081
|
+
path: {
|
|
1082
|
+
storeId: components["parameters"]["store-id.param"];
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
responses: {
|
|
1086
|
+
/** @description Redirect */
|
|
1087
|
+
302: {
|
|
1088
|
+
content: never;
|
|
1089
|
+
};
|
|
1090
|
+
};
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* Navigate to customer portal
|
|
1094
|
+
* @description Navigate to the customer portal.
|
|
1095
|
+
*/
|
|
1096
|
+
"Customer portal navigate": {
|
|
1097
|
+
parameters: {
|
|
1098
|
+
query?: {
|
|
1099
|
+
/** @description HMAC-SHA256 JWT of {"iss":"<partnerId>","sub":"<storeId>/<customerId>"} */
|
|
1100
|
+
token?: string;
|
|
1101
|
+
/** @description Order ID */
|
|
1102
|
+
order_id?: string;
|
|
1103
|
+
};
|
|
1104
|
+
path: {
|
|
1105
|
+
storeId: components["parameters"]["store-id.param"];
|
|
1106
|
+
};
|
|
1107
|
+
};
|
|
1108
|
+
responses: {
|
|
1109
|
+
/** @description Redirect */
|
|
1110
|
+
302: {
|
|
1111
|
+
content: never;
|
|
1112
|
+
};
|
|
1113
|
+
};
|
|
1114
|
+
};
|
|
1027
1115
|
/**
|
|
1028
1116
|
* Get coverage products
|
|
1029
1117
|
* @description Get available coverage products.
|
package/lib/openapi.yaml
CHANGED
|
@@ -916,6 +916,31 @@ info:
|
|
|
916
916
|
version: 2.2.1
|
|
917
917
|
openapi: 3.1.0
|
|
918
918
|
paths:
|
|
919
|
+
/invoices/pending/items.csv:
|
|
920
|
+
description: Return invoice CSV file.
|
|
921
|
+
get:
|
|
922
|
+
description: Get an invoice as a CSV.
|
|
923
|
+
operationId: Invoice pending csv get
|
|
924
|
+
responses:
|
|
925
|
+
'200':
|
|
926
|
+
content:
|
|
927
|
+
text/csv:
|
|
928
|
+
schema:
|
|
929
|
+
format: binary
|
|
930
|
+
type: string
|
|
931
|
+
description: Success
|
|
932
|
+
default:
|
|
933
|
+
content:
|
|
934
|
+
application/problem+json:
|
|
935
|
+
schema:
|
|
936
|
+
$ref: '#/components/schemas/error.schema'
|
|
937
|
+
description: Error
|
|
938
|
+
security:
|
|
939
|
+
- Bearer: []
|
|
940
|
+
summary: Get pending invoice
|
|
941
|
+
tags:
|
|
942
|
+
- Invoice
|
|
943
|
+
summary: Pending invoice
|
|
919
944
|
/invoices/{invoiceId}/items.csv:
|
|
920
945
|
description: Return invoice CSV file.
|
|
921
946
|
get:
|
|
@@ -1100,6 +1125,34 @@ paths:
|
|
|
1100
1125
|
tags:
|
|
1101
1126
|
- Returns
|
|
1102
1127
|
summary: Return status
|
|
1128
|
+
/stores/{storeId}/admin:
|
|
1129
|
+
description: Navigate to the merchant admin page.
|
|
1130
|
+
get:
|
|
1131
|
+
description: Navigate to the merchant admin page.
|
|
1132
|
+
operationId: Merchant admin navigate
|
|
1133
|
+
parameters:
|
|
1134
|
+
- $ref: '#/components/parameters/store-id.param'
|
|
1135
|
+
responses:
|
|
1136
|
+
'302':
|
|
1137
|
+
description: Redirect
|
|
1138
|
+
summary: Navigate to merchant admin
|
|
1139
|
+
tags:
|
|
1140
|
+
- Merchant admin
|
|
1141
|
+
summary: Merchant admin
|
|
1142
|
+
/stores/{storeId}/coverage-info:
|
|
1143
|
+
description: Navigate to the coverage info page.
|
|
1144
|
+
get:
|
|
1145
|
+
description: Navigate to the coverage info page.
|
|
1146
|
+
operationId: Customer portal navigate
|
|
1147
|
+
parameters:
|
|
1148
|
+
- $ref: '#/components/parameters/store-id.param'
|
|
1149
|
+
responses:
|
|
1150
|
+
'302':
|
|
1151
|
+
description: Redirect
|
|
1152
|
+
summary: Navigate to coverage info
|
|
1153
|
+
tags:
|
|
1154
|
+
- Coverage info
|
|
1155
|
+
summary: Coverage info
|
|
1103
1156
|
/stores/{storeId}/coverage-products:
|
|
1104
1157
|
description: Available coverage products.
|
|
1105
1158
|
post:
|
|
@@ -1146,6 +1199,30 @@ paths:
|
|
|
1146
1199
|
tags:
|
|
1147
1200
|
- Coverage Products
|
|
1148
1201
|
summary: Coverage products
|
|
1202
|
+
/stores/{storeId}/customer-portal:
|
|
1203
|
+
description: Navigate to the customer portal.
|
|
1204
|
+
get:
|
|
1205
|
+
description: Navigate to the customer portal.
|
|
1206
|
+
operationId: Customer portal navigate
|
|
1207
|
+
parameters:
|
|
1208
|
+
- $ref: '#/components/parameters/store-id.param'
|
|
1209
|
+
- description: HMAC-SHA256 JWT of {"iss":"<partnerId>","sub":"<storeId>/<customerId>"}
|
|
1210
|
+
in: query
|
|
1211
|
+
name: token
|
|
1212
|
+
schema:
|
|
1213
|
+
type: string
|
|
1214
|
+
- description: Order ID
|
|
1215
|
+
in: query
|
|
1216
|
+
name: order_id
|
|
1217
|
+
schema:
|
|
1218
|
+
type: string
|
|
1219
|
+
responses:
|
|
1220
|
+
'302':
|
|
1221
|
+
description: Redirect
|
|
1222
|
+
summary: Navigate to customer portal
|
|
1223
|
+
tags:
|
|
1224
|
+
- Customer portal
|
|
1225
|
+
summary: Customer portal
|
|
1149
1226
|
/stores/{storeId}/invoices:
|
|
1150
1227
|
description: Return a list of invoices.
|
|
1151
1228
|
get:
|
package/package.json
CHANGED