Skip to content

Remove x-internal from tax documentation #940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion reference/tax.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -223,4 +223,3 @@ components:
type: string
description: The list of subdivision codes where the tax provider connection is active. ISO 3166-2.
example: ['AU-NSW', 'US-OH']
x-internal: false
1 change: 0 additions & 1 deletion reference/tax_classes.v2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@ components:
name: Shipping
created_at: 1973-01-20T21:34:57.903+00:00
updated_at: 1990-12-30T00:29:23.515+00:00
x-internal: false
securitySchemes:
X-Auth-Token:
name: X-Auth-Token
Expand Down
12 changes: 0 additions & 12 deletions reference/tax_provider.yml
Original file line number Diff line number Diff line change
Expand Up @@ -898,7 +898,6 @@ components:
type: object
description: An **ItemRequest** represents required information relating to completing tax calculations for a specific line item.
title: ItemRequest
x-internal: false
properties:
id:
type: string
Expand Down Expand Up @@ -962,7 +961,6 @@ components:
required:
- code
- value
x-internal: false
request-document:
type: object
description: 'Each **DocumentRequest** represents an order or part of an order of items fulfilled from a single origin address to a single destination address. In addition to shipping and billing details, a document request includes the collection of items in the shipment, with tax-relevant information for each item. Multi-address orders, in which items ship to or from multiple addresses, require at least one **DocumentRequest** per combination of sender-recipient addresses. These are similar to "consignments" or "shipments" in other BigCommerce APIs.'
Expand Down Expand Up @@ -1027,7 +1025,6 @@ components:
- shipping
- handling
- items
x-internal: false
request-quote:
type: object
description: 'Each **QuoteRequest** represents an order. In addition to transaction details, it contains a `documents` array of one or more **DocumentRequest** objects, which represent distinct combinations of origin and fulfillment addresses and the tax-relevant contents of those consignments. This is similar to an "order" in other BigCommerce APIs.'
Expand Down Expand Up @@ -1076,7 +1073,6 @@ components:
- customer
- transaction_date
- documents
x-internal: false
request-adjust:
description: An **AdjustRequest** contains the same data as a standard **QuoteRequest** with added detail of the adjustment operation.
allOf:
Expand All @@ -1087,7 +1083,6 @@ components:
description: 'Specifies the reason for the adjustment operation, for auditing purposes. May be a custom, user-entered description.'
- $ref: '#/components/schemas/request-quote'
title: AdjustRequest
x-internal: false
Address:
type: object
description: 'Requests may have partial Address data. For example, the BigCommerce Cart page has the "Estimate Shipping & Tax" feature which is only expected to supply Country, Region and Postal Code.'
Expand Down Expand Up @@ -1131,7 +1126,6 @@ components:
enum:
- RESIDENTIAL
- COMMERCIAL
x-internal: false
TaxClass:
type: object
properties:
Expand All @@ -1148,7 +1142,6 @@ components:
- code
- class_id
- name
x-internal: false
response-quote:
type: object
properties:
Expand All @@ -1164,7 +1157,6 @@ components:
- id
- documents
title: Quote
x-internal: false
response-document:
type: object
title: Document
Expand Down Expand Up @@ -1223,7 +1215,6 @@ components:
- items
- shipping
- handling
x-internal: false
response-item:
type: object
description: |-
Expand All @@ -1240,7 +1231,6 @@ components:
required:
- id
- price
x-internal: false
response-taxprice:
type: object
properties:
Expand Down Expand Up @@ -1269,7 +1259,6 @@ components:
- tax_rate
- sales_tax_summary
title: TaxPrice
x-internal: false
SalesTax:
type: object
properties:
Expand Down Expand Up @@ -1300,7 +1289,6 @@ components:
- name
- rate
- amount
x-internal: false
item_type:
type: string
description: |-
Expand Down