Skip to content

Commit 2061113

Browse files
authored
Merge pull request #71 from erincdustin/order_returns
Regen to API v1.0.238
2 parents 23c2d7c + 1171229 commit 2061113

75 files changed

Lines changed: 6266 additions & 17 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [4.8.8] - 2022-05-19
9+
### Added
10+
- SDK up to date with [API v1.0.238](https://ordercloud.io/release-notes/v1.0.238)
11+
- Introduces Order Returns and adds Message Sender templates
12+
- PriceScheduleID added to LineItems
813
## [4.7.8] - 2022-05-04
914
### Added
1015
- Added an optional `customRoles` array to the authentication methods to support authenticating with custom roles, in addition to standard ApiRoles.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnApprovedPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnApprovedEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnApprovedEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnCompletedPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnCompletedEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnCompletedEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnDeclinedPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnDeclinedEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnDeclinedEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnSubmittedForApprovalPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnSubmittedForApprovalEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnSubmittedForApprovalEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnSubmittedForYourApprovalHasBeenApprovedPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnSubmittedForYourApprovalHasBeenApprovedEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnSubmittedForYourApprovalHasBeenApprovedEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnSubmittedForYourApprovalHasBeenDeclinedPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnSubmittedForYourApprovalHasBeenDeclinedEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnSubmittedForYourApprovalHasBeenDeclinedEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnSubmittedForYourApprovalPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnSubmittedForYourApprovalEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnSubmittedForYourApprovalEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
import { LineItem } from './LineItem'
2+
import { MessageSenderPayload } from './MessageSenderPayload'
3+
import { Order } from './Order'
4+
import { OrderApproval } from './OrderApproval'
5+
import { Product } from './Product'
6+
import { OrderReturn } from './OrderReturn'
7+
8+
export type MessageSenderOrderReturnSubmittedPayload<
9+
TConfigData = any,
10+
TOrder extends Order = Order,
11+
TOrderApproval extends OrderApproval = OrderApproval,
12+
TLineItem extends LineItem = LineItem,
13+
TProduct extends Product = Product,
14+
TOrderReturn extends OrderReturn = OrderReturn
15+
> = MessageSenderPayload<
16+
TConfigData,
17+
MessageSenderOrderReturnSubmittedEventBody<
18+
TOrder,
19+
TOrderApproval,
20+
TLineItem,
21+
TProduct,
22+
TOrderReturn
23+
>
24+
>
25+
26+
export interface MessageSenderOrderReturnSubmittedEventBody<
27+
TOrder extends Order = Order,
28+
TOrderApproval extends OrderApproval = OrderApproval,
29+
TLineItem extends LineItem = LineItem,
30+
TProduct extends Product = Product,
31+
TOrderReturn extends OrderReturn = OrderReturn
32+
> {
33+
Order?: TOrder
34+
Approvals?: TOrderApproval[]
35+
LineItems?: TLineItem[]
36+
Products?: TProduct
37+
OrderReturn?: TOrderReturn
38+
}

codegen/templates/models/MessageSenderPayloads.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ import { MessageSenderOrderSubmittedForYourApprovalHasBeenDeclinedPayload } from
99
import { MessageSenderOrderSubmittedForYourApprovalPayload } from './MessageSenderOrderSubmittedForYourApprovalPayload'
1010
import { MessageSenderOrderSubmittedPayload } from './MessageSenderOrderSubmittedPayload'
1111
import { MessageSenderShipmentCreatedPayload } from './MessageSenderShipmentCreatedPayload'
12+
import { MessageSenderOrderReturnDeclinedPayload } from './MessageSenderOrderReturnDeclinedPayload'
13+
import { MessageSenderOrderReturnSubmittedPayload } from './MessageSenderOrderReturnSubmittedPayload'
14+
import { MessageSenderOrderReturnSubmittedForYourApprovalPayload } from './MessageSenderOrderReturnSubmittedForYourApprovalPayload'
15+
import { MessageSenderOrderReturnApprovedPayload } from './MessageSenderOrderReturnApprovedPayload'
16+
import { MessageSenderOrderReturnSubmittedForYourApprovalHasBeenApprovedPayload } from './MessageSenderOrderReturnSubmittedForYourApprovalHasBeenApprovedPayload'
17+
import { MessageSenderOrderReturnSubmittedForYourApprovalHasBeenDeclinedPayload } from './MessageSenderOrderReturnSubmittedForYourApprovalHasBeenDeclinedPayload'
18+
import { MessageSenderOrderReturnCompletedPayload } from './MessageSenderOrderReturnCompletedPayload'
19+
import { MessageSenderOrderReturnSubmittedForApprovalPayload } from './MessageSenderOrderReturnSubmittedForApprovalPayload'
1220

1321
export type MessageSenderPayloads<
1422
TMessageType extends MessageType
@@ -25,4 +33,12 @@ interface PayloadMap {
2533
'OrderSubmittedForYourApprovalHasBeenApproved': MessageSenderOrderSubmittedForYourApprovalHasBeenApprovedPayload
2634
'OrderSubmittedForYourApprovalHasBeenDeclined': MessageSenderOrderSubmittedForYourApprovalHasBeenDeclinedPayload
2735
'ShipmentCreated': MessageSenderShipmentCreatedPayload
36+
'OrderReturnDeclined': MessageSenderOrderReturnDeclinedPayload
37+
'OrderReturnSubmitted': MessageSenderOrderReturnSubmittedPayload
38+
'OrderReturnSubmittedForYourApproval': MessageSenderOrderReturnSubmittedForYourApprovalPayload
39+
'OrderReturnSubmittedForApproval': MessageSenderOrderReturnSubmittedForApprovalPayload
40+
'OrderReturnApproved': MessageSenderOrderReturnApprovedPayload
41+
'OrderReturnSubmittedForYourApprovalHasBeenApproved': MessageSenderOrderReturnSubmittedForYourApprovalHasBeenApprovedPayload
42+
'OrderReturnSubmittedForYourApprovalHasBeenDeclined': MessageSenderOrderReturnSubmittedForYourApprovalHasBeenDeclinedPayload
43+
'OrderReturnCompleted': MessageSenderOrderReturnCompletedPayload
2844
}

0 commit comments

Comments
 (0)