Skip to content

Commit

Permalink
[nightly] generate types against bigcommerce/api-specs@6994cba (#36)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
matthewvolk and github-actions[bot] authored Sep 8, 2023
1 parent 9859c5a commit c15cea0
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 15 deletions.
5 changes: 5 additions & 0 deletions .changeset/itchy-rockets-bake.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"bigrequest": patch
---

Fixes response type of GET category products sort order to be an array of objects rather than a single object (bigcommerce/api-specs#1430). Expose new `discounted_total_inc_tax` property in the GET order product and GET order products response (bigcommerce/api-specs#1457).
7 changes: 5 additions & 2 deletions packages/bigrequest/src/generated/categories_catalog.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,7 @@ export interface components {
};
};
responses: {
/** @description Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occured, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed. */
/** @description Multi-status. Multiple operations have taken place and the status for each operation can be viewed in the body of the response. Typically indicates that a partial failure has occurred, such as when a `POST` or `PUT` request is successful, but saving the URL or inventory data has failed. */
General207Status: {
content: {
"application/json": components["schemas"]["error_Base"];
Expand Down Expand Up @@ -1607,7 +1607,10 @@ export interface operations {
responses: {
200: {
content: {
"application/json": Record<string, never>;
"application/json": {
product_id?: number;
sort_order?: number;
}[];
};
};
/** @description The requested category was not found. */
Expand Down
29 changes: 18 additions & 11 deletions packages/bigrequest/src/generated/orders.v2.oas2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -590,20 +590,20 @@ export interface components {
*/
quantity?: number;
/**
* @description The product’s cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer) Read Only
* @example 0.0000
* @description The product’s cost price. This can be set using the Catalog API. (Float, Float-As-String, Integer)
* @example 50.0000
*/
base_cost_price?: string;
/**
* @description The product’s cost price including tax. (Float, Float-As-String, Integer)
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only
* @example 0.0000
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
* @example 50.0000
*/
cost_price_inc_tax?: string;
/**
* @description The products cost price excluding tax. (Float, Float-As-String, Integer)
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only
* @example 0.0000
* @description The product cost price excluding tax. (Float, Float-As-String, Integer)
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
* @example 50.0000
*/
cost_price_ex_tax?: string;
/**
Expand Down Expand Up @@ -728,6 +728,15 @@ export interface components {
* @example 52
*/
gift_certificate_id?: number | null;
/**
* @description Represent the correct total amount of the line item after deducting all the discounts and including the tax. This number can be used for accounting purpose.
*
* This makes it easier to have the "shopper paid" value for a line item and api user doesn't have to do any calculation to deduct discount on the client side.
*
* This field includes all types of discounts (automatic, coupon, manual) and therefore if you use this value, you don't need to deduct any more discounts at line item level or order level.
* @example 0.0000
*/
discounted_total_inc_tax?: string;
};
/**
* orderCount
Expand Down Expand Up @@ -1801,15 +1810,13 @@ export interface components {
product_options?: {
/**
* @description The product’s cost price including tax. (Float, Float-As-String, Integer)
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only.
* readOnly: true
* @example 0.0000
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes.
* @example 50.0000
*/
cost_price_inc_tax?: string;
/**
* @description The products cost price excluding tax. (Float, Float-As-String, Integer)
* The cost of your products to you; this is never shown to customers, but can be used for accounting purposes. Read Only.
* readOnly: true
* @example 0.0000
*/
price_ex_tax?: string;
Expand Down
6 changes: 6 additions & 0 deletions packages/bigrequest/src/generated/scripts.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ export interface paths {
* **Read Only Fields**
* * uuid
*
* **Limits**
* * 50 scripts per channel.
*
* **Notes**
* * If the `kind` is `src`:
* * Specify the `src` property.
Expand Down Expand Up @@ -459,6 +462,9 @@ export interface operations {
* **Read Only Fields**
* * uuid
*
* **Limits**
* * 50 scripts per channel.
*
* **Notes**
* * If the `kind` is `src`:
* * Specify the `src` property.
Expand Down
4 changes: 2 additions & 2 deletions packages/bigrequest/src/generated/themes.v3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export interface paths {
"/themes/jobs/{job_id}": {
/**
* Get a Theme Job
* @description Returns a theme *Job*. If job is completed, the result is included in the response.
* @description Returns a theme *Job*. When the job is complete, the results array provides a generated link to access the theme. The link is active for 60 seconds.
*/
get: operations["getJob"];
parameters: {
Expand Down Expand Up @@ -976,7 +976,7 @@ export interface operations {
};
/**
* Get a Theme Job
* @description Returns a theme *Job*. If job is completed, the result is included in the response.
* @description Returns a theme *Job*. When the job is complete, the results array provides a generated link to access the theme. The link is active for 60 seconds.
*/
getJob: {
parameters: {
Expand Down

0 comments on commit c15cea0

Please sign in to comment.