@redotech/redo-api-schema 2.2.315 → 2.2.323
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 +74 -2
- package/lib/openapi.yaml +162 -0
- package/package.json +1 -1
package/lib/openapi.d.ts
CHANGED
|
@@ -692,6 +692,11 @@ export interface components {
|
|
|
692
692
|
* @description Return read.
|
|
693
693
|
*/
|
|
694
694
|
"return-read.schema": {
|
|
695
|
+
/**
|
|
696
|
+
* Compensation Methods
|
|
697
|
+
* @description Array of compensation methods available for this return
|
|
698
|
+
*/
|
|
699
|
+
compensationMethods?: ("refund" | "store_credit" | "exchange")[];
|
|
695
700
|
/**
|
|
696
701
|
* Created at
|
|
697
702
|
* Format: date-time
|
|
@@ -787,7 +792,58 @@ export interface components {
|
|
|
787
792
|
*/
|
|
788
793
|
internalCreatedByName?: string;
|
|
789
794
|
/** @description Return items */
|
|
790
|
-
items: {
|
|
795
|
+
items: ({
|
|
796
|
+
/** @description Assessment records for this return item. Only applicable for warranties. */
|
|
797
|
+
assessments?: ({
|
|
798
|
+
/** @description User assigned to this assessment */
|
|
799
|
+
assignedUser: {
|
|
800
|
+
email: string;
|
|
801
|
+
firstName: string;
|
|
802
|
+
id: string;
|
|
803
|
+
lastName: string;
|
|
804
|
+
name: string;
|
|
805
|
+
};
|
|
806
|
+
/** @description Assessment responses */
|
|
807
|
+
responses: ({
|
|
808
|
+
/** @constant */
|
|
809
|
+
type: "short_text";
|
|
810
|
+
/** @description Short text response value */
|
|
811
|
+
value: string;
|
|
812
|
+
} | {
|
|
813
|
+
/** @constant */
|
|
814
|
+
type: "long_text";
|
|
815
|
+
/** @description Long text response value */
|
|
816
|
+
value: string;
|
|
817
|
+
} | {
|
|
818
|
+
/** @constant */
|
|
819
|
+
type: "select";
|
|
820
|
+
/** @description Select response values (array of selected options) */
|
|
821
|
+
value: string[];
|
|
822
|
+
} | {
|
|
823
|
+
/** @constant */
|
|
824
|
+
type: "number";
|
|
825
|
+
/** @description Number response value */
|
|
826
|
+
value: number;
|
|
827
|
+
} | {
|
|
828
|
+
/** @constant */
|
|
829
|
+
type: "boolean";
|
|
830
|
+
/** @description Boolean response value */
|
|
831
|
+
value: boolean;
|
|
832
|
+
} | {
|
|
833
|
+
/** @constant */
|
|
834
|
+
type: "file_upload";
|
|
835
|
+
/** @description File upload response values (array of file URLs or identifiers) */
|
|
836
|
+
value: string[];
|
|
837
|
+
} | {
|
|
838
|
+
/** @constant */
|
|
839
|
+
type: "date";
|
|
840
|
+
/**
|
|
841
|
+
* Format: date-time
|
|
842
|
+
* @description Date response value
|
|
843
|
+
*/
|
|
844
|
+
value: string;
|
|
845
|
+
})[];
|
|
846
|
+
})[];
|
|
791
847
|
/** @description Customer's comment about the return */
|
|
792
848
|
customerComment?: string;
|
|
793
849
|
/**
|
|
@@ -812,6 +868,13 @@ export interface components {
|
|
|
812
868
|
* @description Return item ID.
|
|
813
869
|
*/
|
|
814
870
|
id: string;
|
|
871
|
+
/** @description Multiple choice questions and answers for this return item */
|
|
872
|
+
multipleChoiceQuestions?: {
|
|
873
|
+
/** @description The selected answer */
|
|
874
|
+
answer: string;
|
|
875
|
+
/** @description The question text */
|
|
876
|
+
question: string;
|
|
877
|
+
}[];
|
|
815
878
|
/**
|
|
816
879
|
* Order item
|
|
817
880
|
* @description Order line item
|
|
@@ -828,6 +891,8 @@ export interface components {
|
|
|
828
891
|
*/
|
|
829
892
|
line_item_id?: string;
|
|
830
893
|
};
|
|
894
|
+
/** @description Product adjustment details */
|
|
895
|
+
productAdjustment?: string;
|
|
831
896
|
/** @description Product ID */
|
|
832
897
|
productId?: string;
|
|
833
898
|
/** @description Quantity of items being returned */
|
|
@@ -836,6 +901,8 @@ export interface components {
|
|
|
836
901
|
reason: string;
|
|
837
902
|
/** @description Return reason code */
|
|
838
903
|
reasonCode?: string;
|
|
904
|
+
/** @description Array of return reason codes */
|
|
905
|
+
reasonCodes?: string[];
|
|
839
906
|
/** @description Array of return reasons */
|
|
840
907
|
reasons?: string[];
|
|
841
908
|
/** @description Refund details */
|
|
@@ -851,7 +918,7 @@ export interface components {
|
|
|
851
918
|
status?: string;
|
|
852
919
|
/** @description Product variant ID */
|
|
853
920
|
variantId?: string;
|
|
854
|
-
}[];
|
|
921
|
+
})[];
|
|
855
922
|
/**
|
|
856
923
|
* Notes
|
|
857
924
|
* @description Teammembers generated notes and comments on the return
|
|
@@ -967,6 +1034,11 @@ export interface components {
|
|
|
967
1034
|
* @description Carrier code
|
|
968
1035
|
*/
|
|
969
1036
|
carrier?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Postage Label
|
|
1039
|
+
* @description Postage label URL
|
|
1040
|
+
*/
|
|
1041
|
+
postageLabel?: string;
|
|
970
1042
|
/**
|
|
971
1043
|
* Status
|
|
972
1044
|
* @description Status of shipment
|
package/lib/openapi.yaml
CHANGED
|
@@ -674,6 +674,16 @@ components:
|
|
|
674
674
|
return-read.schema:
|
|
675
675
|
description: Return read.
|
|
676
676
|
properties:
|
|
677
|
+
compensationMethods:
|
|
678
|
+
description: Array of compensation methods available for this return
|
|
679
|
+
items:
|
|
680
|
+
enum:
|
|
681
|
+
- refund
|
|
682
|
+
- store_credit
|
|
683
|
+
- exchange
|
|
684
|
+
type: string
|
|
685
|
+
title: Compensation Methods
|
|
686
|
+
type: array
|
|
677
687
|
createdAt:
|
|
678
688
|
description: Time of creation.
|
|
679
689
|
format: date-time
|
|
@@ -799,6 +809,131 @@ components:
|
|
|
799
809
|
description: Return items
|
|
800
810
|
items:
|
|
801
811
|
properties:
|
|
812
|
+
assessments:
|
|
813
|
+
description: Assessment records for this return item. Only applicable for warranties.
|
|
814
|
+
items:
|
|
815
|
+
properties:
|
|
816
|
+
assignedUser:
|
|
817
|
+
description: User assigned to this assessment
|
|
818
|
+
properties:
|
|
819
|
+
email:
|
|
820
|
+
type: string
|
|
821
|
+
firstName:
|
|
822
|
+
type: string
|
|
823
|
+
id:
|
|
824
|
+
type: string
|
|
825
|
+
lastName:
|
|
826
|
+
type: string
|
|
827
|
+
name:
|
|
828
|
+
type: string
|
|
829
|
+
required:
|
|
830
|
+
- id
|
|
831
|
+
- name
|
|
832
|
+
- firstName
|
|
833
|
+
- lastName
|
|
834
|
+
- email
|
|
835
|
+
type: object
|
|
836
|
+
responses:
|
|
837
|
+
description: Assessment responses
|
|
838
|
+
items:
|
|
839
|
+
discriminator:
|
|
840
|
+
propertyName: type
|
|
841
|
+
oneOf:
|
|
842
|
+
- properties:
|
|
843
|
+
type:
|
|
844
|
+
const: short_text
|
|
845
|
+
type: string
|
|
846
|
+
value:
|
|
847
|
+
description: Short text response value
|
|
848
|
+
type: string
|
|
849
|
+
required:
|
|
850
|
+
- type
|
|
851
|
+
- value
|
|
852
|
+
title: Short Text Response
|
|
853
|
+
type: object
|
|
854
|
+
- properties:
|
|
855
|
+
type:
|
|
856
|
+
const: long_text
|
|
857
|
+
type: string
|
|
858
|
+
value:
|
|
859
|
+
description: Long text response value
|
|
860
|
+
type: string
|
|
861
|
+
required:
|
|
862
|
+
- type
|
|
863
|
+
- value
|
|
864
|
+
title: Long Text Response
|
|
865
|
+
type: object
|
|
866
|
+
- properties:
|
|
867
|
+
type:
|
|
868
|
+
const: select
|
|
869
|
+
type: string
|
|
870
|
+
value:
|
|
871
|
+
description: Select response values (array of selected options)
|
|
872
|
+
items:
|
|
873
|
+
type: string
|
|
874
|
+
type: array
|
|
875
|
+
required:
|
|
876
|
+
- type
|
|
877
|
+
- value
|
|
878
|
+
title: Select Response
|
|
879
|
+
type: object
|
|
880
|
+
- properties:
|
|
881
|
+
type:
|
|
882
|
+
const: number
|
|
883
|
+
type: string
|
|
884
|
+
value:
|
|
885
|
+
description: Number response value
|
|
886
|
+
type: number
|
|
887
|
+
required:
|
|
888
|
+
- type
|
|
889
|
+
- value
|
|
890
|
+
title: Number Response
|
|
891
|
+
type: object
|
|
892
|
+
- properties:
|
|
893
|
+
type:
|
|
894
|
+
const: boolean
|
|
895
|
+
type: string
|
|
896
|
+
value:
|
|
897
|
+
description: Boolean response value
|
|
898
|
+
type: boolean
|
|
899
|
+
required:
|
|
900
|
+
- type
|
|
901
|
+
- value
|
|
902
|
+
title: Boolean Response
|
|
903
|
+
type: object
|
|
904
|
+
- properties:
|
|
905
|
+
type:
|
|
906
|
+
const: file_upload
|
|
907
|
+
type: string
|
|
908
|
+
value:
|
|
909
|
+
description: File upload response values (array of file URLs or identifiers)
|
|
910
|
+
items:
|
|
911
|
+
type: string
|
|
912
|
+
type: array
|
|
913
|
+
required:
|
|
914
|
+
- type
|
|
915
|
+
- value
|
|
916
|
+
title: File Upload Response
|
|
917
|
+
type: object
|
|
918
|
+
- properties:
|
|
919
|
+
type:
|
|
920
|
+
const: date
|
|
921
|
+
type: string
|
|
922
|
+
value:
|
|
923
|
+
description: Date response value
|
|
924
|
+
format: date-time
|
|
925
|
+
type: string
|
|
926
|
+
required:
|
|
927
|
+
- type
|
|
928
|
+
- value
|
|
929
|
+
title: Date Response
|
|
930
|
+
type: object
|
|
931
|
+
type: array
|
|
932
|
+
required:
|
|
933
|
+
- assignedUser
|
|
934
|
+
- responses
|
|
935
|
+
type: object
|
|
936
|
+
type: array
|
|
802
937
|
customerComment:
|
|
803
938
|
description: Customer's comment about the return
|
|
804
939
|
type: string
|
|
@@ -830,6 +965,21 @@ components:
|
|
|
830
965
|
description: Return item ID.
|
|
831
966
|
title: ID
|
|
832
967
|
type: string
|
|
968
|
+
multipleChoiceQuestions:
|
|
969
|
+
description: Multiple choice questions and answers for this return item
|
|
970
|
+
items:
|
|
971
|
+
properties:
|
|
972
|
+
answer:
|
|
973
|
+
description: The selected answer
|
|
974
|
+
type: string
|
|
975
|
+
question:
|
|
976
|
+
description: The question text
|
|
977
|
+
type: string
|
|
978
|
+
required:
|
|
979
|
+
- question
|
|
980
|
+
- answer
|
|
981
|
+
type: object
|
|
982
|
+
type: array
|
|
833
983
|
orderItem:
|
|
834
984
|
description: Order line item
|
|
835
985
|
properties:
|
|
@@ -845,6 +995,9 @@ components:
|
|
|
845
995
|
- id
|
|
846
996
|
title: Order item
|
|
847
997
|
type: object
|
|
998
|
+
productAdjustment:
|
|
999
|
+
description: Product adjustment details
|
|
1000
|
+
type: string
|
|
848
1001
|
productId:
|
|
849
1002
|
description: Product ID
|
|
850
1003
|
type: string
|
|
@@ -860,6 +1013,11 @@ components:
|
|
|
860
1013
|
reasonCode:
|
|
861
1014
|
description: Return reason code
|
|
862
1015
|
type: string
|
|
1016
|
+
reasonCodes:
|
|
1017
|
+
description: Array of return reason codes
|
|
1018
|
+
items:
|
|
1019
|
+
type: string
|
|
1020
|
+
type: array
|
|
863
1021
|
reasons:
|
|
864
1022
|
description: Array of return reasons
|
|
865
1023
|
items:
|
|
@@ -1037,6 +1195,10 @@ components:
|
|
|
1037
1195
|
description: Carrier code
|
|
1038
1196
|
title: Carrier
|
|
1039
1197
|
type: string
|
|
1198
|
+
postageLabel:
|
|
1199
|
+
description: Postage label URL
|
|
1200
|
+
title: Postage Label
|
|
1201
|
+
type: string
|
|
1040
1202
|
status:
|
|
1041
1203
|
description: Status of shipment
|
|
1042
1204
|
enum:
|
package/package.json
CHANGED