Skip to content

Commit f3bc987

Browse files
committed
⏩ regen to API v1.0.426
1 parent 0c3fd8b commit f3bc987

10 files changed

Lines changed: 108 additions & 80 deletions

File tree

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/Resources.Me.html

Lines changed: 26 additions & 22 deletions
Large diffs are not rendered by default.

docs/classes/Resources.Shipments.html

Lines changed: 13 additions & 9 deletions
Large diffs are not rendered by default.

docs/interfaces/Resources.SortableMap.html

Lines changed: 56 additions & 42 deletions
Large diffs are not rendered by default.

docs/types/Resources.SortableEndpoint.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/variables/Me.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<h1>Variable Me</h1></div>
1818
<div class="tsd-signature">Me<span class="tsd-signature-symbol">:</span> <a href="../classes/Resources.Me.html" class="tsd-signature-type" data-tsd-kind="Class">Me</a></div><aside class="tsd-sources">
1919
<ul>
20-
<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Me.ts#L2011">api/Me.ts:2011</a></li></ul></aside></div>
20+
<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Me.ts#L2012">api/Me.ts:2012</a></li></ul></aside></div>
2121
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2222
<div class="tsd-navigation settings">
2323
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/variables/Shipments.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<h1>Variable Shipments</h1></div>
1818
<div class="tsd-signature">Shipments<span class="tsd-signature-symbol">:</span> <a href="../classes/Resources.Shipments.html" class="tsd-signature-type" data-tsd-kind="Class">Shipments</a></div><aside class="tsd-sources">
1919
<ul>
20-
<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Shipments.ts#L319">api/Shipments.ts:319</a></li></ul></aside></div>
20+
<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Shipments.ts#L320">api/Shipments.ts:320</a></li></ul></aside></div>
2121
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
2222
<div class="tsd-navigation settings">
2323
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

src/api/Me.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1565,14 +1565,15 @@ class Me {
15651565
*
15661566
* @param shipmentID ID of the shipment.
15671567
* @param listOptions.orderID ID of the order.
1568+
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
15681569
* @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
15691570
* @param listOptions.pageSize Number of results to return per page.
15701571
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
15711572
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
15721573
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
15731574
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
15741575
*/
1575-
public async ListShipmentItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { orderID?: string, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
1576+
public async ListShipmentItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { orderID?: string, sortBy?: Sortable<'Me.ListShipmentItems'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
15761577
const impersonating = this.impersonating;
15771578
this.impersonating = false;
15781579
return await http.get(`/me/shipments/${shipmentID}/items`, { ...requestOptions, impersonating, params: listOptions } )

src/api/Shipments.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,14 +172,15 @@ class Shipments {
172172
* Check out the {@link https://ordercloud.io/api-reference/orders-and-fulfillment/shipments/list-items|api docs} for more info
173173
*
174174
* @param shipmentID ID of the shipment.
175+
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
175176
* @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
176177
* @param listOptions.pageSize Number of results to return per page.
177178
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
178179
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
179180
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
180181
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
181182
*/
182-
public async ListItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
183+
public async ListItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { sortBy?: Sortable<'Shipments.ListItems'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
183184
const impersonating = this.impersonating;
184185
this.impersonating = false;
185186
return await http.get(`/shipments/${shipmentID}/items`, { ...requestOptions, impersonating, params: listOptions } )

src/models/Sortable.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ interface SortableMap {
5252
'Me.ListPromotions': ('Name' | 'ID' | 'Code' | 'StartDate' | 'ExpirationDate' | 'EligibleExpression' | 'ValueExpression' | 'CanCombine' | 'AutoApply' | 'Active' | 'Priority' | '!Name' | '!ID' | '!Code' | '!StartDate' | '!ExpirationDate' | '!EligibleExpression' | '!ValueExpression' | '!CanCombine' | '!AutoApply' | '!Active' | '!Priority')[]
5353
'Me.ListBuyerSellers': ('Name' | 'ID' | '!Name' | '!ID')[]
5454
'Me.ListShipments': ('DateShipped' | 'OwnerID' | 'ID' | 'BuyerID' | 'Shipper' | 'DateDelivered' | 'Cost' | '!DateShipped' | '!OwnerID' | '!ID' | '!BuyerID' | '!Shipper' | '!DateDelivered' | '!Cost')[]
55+
'Me.ListShipmentItems': ('OrderID' | 'LineItemID' | '!OrderID' | '!LineItemID')[]
5556
'Me.ListSpendingAccounts': ('Name' | 'ID' | '!Name' | '!ID')[]
5657
'Me.ListSubscriptions': ('NextOrderDate' | 'LastOrderDate' | 'DateCreated' | 'ID' | 'Interval' | 'EndDate' | 'FromCompanyID' | 'FromUserID' | 'ToCompanyID' | '!NextOrderDate' | '!LastOrderDate' | '!DateCreated' | '!ID' | '!Interval' | '!EndDate' | '!FromCompanyID' | '!FromUserID' | '!ToCompanyID')[]
5758
'Me.ListSubscriptionItems': ('DateAdded' | 'ID' | 'ProductID' | '!DateAdded' | '!ID' | '!ProductID')[]
@@ -81,6 +82,7 @@ interface SortableMap {
8182
'Promotions.List': ('Name' | 'ID' | 'Code' | 'StartDate' | 'ExpirationDate' | 'EligibleExpression' | 'ValueExpression' | 'CanCombine' | 'AutoApply' | 'Active' | 'Priority' | '!Name' | '!ID' | '!Code' | '!StartDate' | '!ExpirationDate' | '!EligibleExpression' | '!ValueExpression' | '!CanCombine' | '!AutoApply' | '!Active' | '!Priority')[]
8283
'SecurityProfiles.List': ('ID' | 'Name' | '!ID' | '!Name')[]
8384
'Shipments.List': ('DateShipped' | 'OwnerID' | 'ID' | 'BuyerID' | 'Shipper' | 'DateDelivered' | 'Cost' | '!DateShipped' | '!OwnerID' | '!ID' | '!BuyerID' | '!Shipper' | '!DateDelivered' | '!Cost')[]
85+
'Shipments.ListItems': ('OrderID' | 'LineItemID' | '!OrderID' | '!LineItemID')[]
8486
'Specs.List': ('ListOrder' | 'Name' | 'ID' | '!ListOrder' | '!Name' | '!ID')[]
8587
'Specs.ListOptions': ('ListOrder' | 'ID' | '!ListOrder' | '!ID')[]
8688
'Specs.ListProductAssignments': ('SpecID' | 'ProductID' | 'DefaultOptionID' | 'DefaultValue' | '!SpecID' | '!ProductID' | '!DefaultOptionID' | '!DefaultValue')[]
@@ -147,6 +149,7 @@ type SortableEndpoint = 'AdminAddresses.List' |
147149
'Me.ListPromotions' |
148150
'Me.ListBuyerSellers' |
149151
'Me.ListShipments' |
152+
'Me.ListShipmentItems' |
150153
'Me.ListSpendingAccounts' |
151154
'Me.ListSubscriptions' |
152155
'Me.ListSubscriptionItems' |
@@ -176,6 +179,7 @@ type SortableEndpoint = 'AdminAddresses.List' |
176179
'Promotions.List' |
177180
'SecurityProfiles.List' |
178181
'Shipments.List' |
182+
'Shipments.ListItems' |
179183
'Specs.List' |
180184
'Specs.ListOptions' |
181185
'Specs.ListProductAssignments' |

0 commit comments

Comments
 (0)