Skip to content

Commit 892e48f

Browse files
author
Crhistian
committed
✨ add models for message senders, integration events , and oidc #67 
1 parent f08b235 commit 892e48f

69 files changed

Lines changed: 5512 additions & 11 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.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -420,14 +420,14 @@ The sdk ships with various helpers and utilities that you may find useful. We al
420420
| Utility | Description |
421421
|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
422422
| [`ListPage<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/listpage) | Takes in a type for the item in the list. For example `ListPage<Order>` will be the type for an order list page. |
423-
| [`ListPageWithFacets<T>`]( https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/listpagewithfacets ) | Similar to `ListPage` but for [premium search](https://ordercloud.io/knowledge-base/introducing-premium-search) models. For example `ListPageWithFacets<Product>` will be the type for a product list page. |
423+
| [`ListPageWithFacets<T>`]( https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/listpagewithfacets ) | Similar to `ListPage` but for [premium search](https://ordercloud.io/knowledge-base/introducing-premium-search) models. For example `ListPageWithFacets<Product>` will be the type for a product list page. |
424424
| [`Searchable<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#searchable) | Takes in a [`SearchableEndpoint`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#searchableendpoint) and returns the type for a valid `searchOn` field on list calls. For example `Searchable<'Orders.List'>`. |
425425
| [`Sortable<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#sortable) | Takes in a [`SortableEndpoint`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#sortableendpoint) and returns the type for a valid `sortBy` field on list calls. For example `Sortable<'Orders.List'>`. |
426426
| [`Filters<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#filters) | Takes in an ordercloud model and returns the type for a valid `filter` field on list calls. For example `Filters<Product>`. This also works for any custom models that extend an OrderCloud model, for example `Filters<MyProduct>`. |
427427
| [`PartialDeep<T>`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#partialdeep) | Similar to Typescript's [`Partial<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialt) except works on nested properties as well. |
428428
| [`RequiredDeep<T>`]( https://ordercloud-api.github.io/ordercloud-javascript-sdk#requireddeep ) | Similar to Typescript's [`Required<T>`](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredt) except works on nested properties as well. |
429429
| [`DecodedToken`](https://ordercloud-api.github.io/ordercloud-javascript-sdk/interfaces/decodedtoken) | A type representing a decoded OrderCloud token | |
430-
430+
| [`MessageSenderPayloads`](https://ordercloud-api.github.io/ordercloud-javascript-sdk#messagesenderpayloads) | Takes in a type argument for the message type and resolves to the type for the message sender payload |
431431
## 📄 License
432432

433433
OrderCloud's Javascript SDK is an open-sourced software licensed under the [MIT license](./LICENSE).

‎codegen/templates/models/Environment.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export type Environment = 'Sandbox' | 'Staging' | 'Production'

‎codegen/templates/models/MessageSenderForgottenPasswordPayload.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { MessageSenderPayload } from './MessageSenderPayload'
2+
3+
export type MessageSenderForgottenPasswordPayload<
4+
TConfigData = any
5+
> = MessageSenderPayload<TConfigData, MessageSenderForgottenPasswordEventBody>
6+
7+
export interface MessageSenderForgottenPasswordEventBody {
8+
Username?: string
9+
PasswordRenewalUrl?: string
10+
PasswordRenewalVerificationCode?: string
11+
PasswordRenewalAccessToken?: string
12+
}

‎codegen/templates/models/MessageSenderMessageType.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
export type MessageSenderMessageType =
2+
| 'NewUserInvitation'
3+
| 'ForgottenPassword'
4+
| 'OrderSubmitted'
5+
| 'OrderSubmittedForApproval'
6+
| 'OrderApproved'
7+
| 'OrderDeclined'
8+
| 'OrderSubmittedForYourApproval'
9+
| 'OrderSubmittedForYourApprovalHasBeenApproved'
10+
| 'OrderSubmittedForYourApprovalHasBeenDeclined'
11+
| 'ShipmentCreated'

‎codegen/templates/models/MessageSenderNewUserInvitationPayload.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { MessageSenderPayload } from './MessageSenderPayload'
2+
3+
export type MessageSenderNewUserInvitationPayload<
4+
TConfigData = any
5+
> = MessageSenderPayload<TConfigData, MessageSenderNewUserInvitationEventBody>
6+
7+
export interface MessageSenderNewUserInvitationEventBody {
8+
Username?: string
9+
PasswordRenewalUrl?: string
10+
PasswordRenewalVerificationCode?: string
11+
PasswordRenewalAccessToken?: string
12+
}

‎codegen/templates/models/MessageSenderOrderApprovedPayload.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
7+
export type MessageSenderOrderApprovedPayload<
8+
TConfigData = any,
9+
TOrder extends Order = Order,
10+
TOrderApproval extends OrderApproval = OrderApproval,
11+
TLineItem extends LineItem = LineItem,
12+
TProduct extends Product = Product
13+
> = MessageSenderPayload<
14+
TConfigData,
15+
MessageSenderOrderApprovedEventBody<
16+
TOrder,
17+
TOrderApproval,
18+
TLineItem,
19+
TProduct
20+
>
21+
>
22+
23+
export interface MessageSenderOrderApprovedEventBody<
24+
TOrder extends Order = Order,
25+
TOrderApproval extends OrderApproval = OrderApproval,
26+
TLineItem extends LineItem = LineItem,
27+
TProduct extends Product = Product
28+
> {
29+
Order?: TOrder
30+
Approvals?: TOrderApproval[]
31+
LineItems?: TLineItem[]
32+
Products?: TProduct
33+
}

‎codegen/templates/models/MessageSenderOrderDeclinedPayload.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
7+
export type MessageSenderOrderDeclinedPayload<
8+
TConfigData = any,
9+
TOrder extends Order = Order,
10+
TOrderApproval extends OrderApproval = OrderApproval,
11+
TLineItem extends LineItem = LineItem,
12+
TProduct extends Product = Product
13+
> = MessageSenderPayload<
14+
TConfigData,
15+
MessageSenderOrderDeclinedEventBody<
16+
TOrder,
17+
TOrderApproval,
18+
TLineItem,
19+
TProduct
20+
>
21+
>
22+
23+
export interface MessageSenderOrderDeclinedEventBody<
24+
TOrder extends Order = Order,
25+
TOrderApproval extends OrderApproval = OrderApproval,
26+
TLineItem extends LineItem = LineItem,
27+
TProduct extends Product = Product
28+
> {
29+
Order?: TOrder
30+
Approvals?: TOrderApproval[]
31+
LineItems?: TLineItem[]
32+
Products?: TProduct
33+
}

‎codegen/templates/models/MessageSenderOrderSubmittedForApprovalPayload.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
7+
export type MessageSenderOrderSubmittedForApprovalPayload<
8+
TConfigData = any,
9+
TOrder extends Order = Order,
10+
TOrderApproval extends OrderApproval = OrderApproval,
11+
TLineItem extends LineItem = LineItem,
12+
TProduct extends Product = Product
13+
> = MessageSenderPayload<
14+
TConfigData,
15+
MessageSenderOrderSubmittedForApprovalEventBody<
16+
TOrder,
17+
TOrderApproval,
18+
TLineItem,
19+
TProduct
20+
>
21+
>
22+
23+
export interface MessageSenderOrderSubmittedForApprovalEventBody<
24+
TOrder extends Order = Order,
25+
TOrderApproval extends OrderApproval = OrderApproval,
26+
TLineItem extends LineItem = LineItem,
27+
TProduct extends Product = Product
28+
> {
29+
Order?: TOrder
30+
Approvals?: TOrderApproval[]
31+
LineItems?: TLineItem[]
32+
Products?: TProduct
33+
}

‎codegen/templates/models/MessageSenderOrderSubmittedForYourApprovalHasBeenApprovedPayload.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
7+
export type MessageSenderOrderSubmittedForYourApprovalHasBeenApprovedPayload<
8+
TConfigData = any,
9+
TOrder extends Order = Order,
10+
TOrderApproval extends OrderApproval = OrderApproval,
11+
TLineItem extends LineItem = LineItem,
12+
TProduct extends Product = Product
13+
> = MessageSenderPayload<
14+
TConfigData,
15+
MessageSenderOrderSubmittedForYourApprovalHasBeenApprovedEventBody<
16+
TOrder,
17+
TOrderApproval,
18+
TLineItem,
19+
TProduct
20+
>
21+
>
22+
23+
export interface MessageSenderOrderSubmittedForYourApprovalHasBeenApprovedEventBody<
24+
TOrder extends Order = Order,
25+
TOrderApproval extends OrderApproval = OrderApproval,
26+
TLineItem extends LineItem = LineItem,
27+
TProduct extends Product = Product
28+
> {
29+
Order?: TOrder
30+
Approvals?: TOrderApproval[]
31+
LineItems?: TLineItem[]
32+
Products?: TProduct
33+
}

‎codegen/templates/models/MessageSenderOrderSubmittedForYourApprovalHasBeenDeclinedPayload.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
7+
export type MessageSenderOrderSubmittedForYourApprovalHasBeenDeclinedPayload<
8+
TConfigData = any,
9+
TOrder extends Order = Order,
10+
TOrderApproval extends OrderApproval = OrderApproval,
11+
TLineItem extends LineItem = LineItem,
12+
TProduct extends Product = Product
13+
> = MessageSenderPayload<
14+
TConfigData,
15+
MessageSenderOrderSubmittedForYourApprovalHasBeenDeclinedEventBody<
16+
TOrder,
17+
TOrderApproval,
18+
TLineItem,
19+
TProduct
20+
>
21+
>
22+
23+
export interface MessageSenderOrderSubmittedForYourApprovalHasBeenDeclinedEventBody<
24+
TOrder extends Order = Order,
25+
TOrderApproval extends OrderApproval = OrderApproval,
26+
TLineItem extends LineItem = LineItem,
27+
TProduct extends Product = Product
28+
> {
29+
Order?: TOrder
30+
Approvals?: TOrderApproval[]
31+
LineItems?: TLineItem[]
32+
Products?: TProduct
33+
}

0 commit comments

Comments
 (0)