diff --git a/.changeset/seven-keys-beg.md b/.changeset/seven-keys-beg.md new file mode 100644 index 0000000000..eaac4a7743 --- /dev/null +++ b/.changeset/seven-keys-beg.md @@ -0,0 +1,5 @@ +--- +"@medusajs/client-types": patch +--- + +feat(codegen): commit generated client types to codebase diff --git a/.github/workflows/codegen-test.yml b/.github/workflows/codegen-test.yml new file mode 100644 index 0000000000..3de782f160 --- /dev/null +++ b/.github/workflows/codegen-test.yml @@ -0,0 +1,40 @@ +name: OAS Codegen Build Check - BETA +on: + pull_request: + paths-ignore: + - "docs/**" + - "www/**" + +jobs: + codegen-test: + runs-on: ubuntu-latest + env: + TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} + TURBO_TEAM: ${{ secrets.TURBO_TEAM }} + steps: + - name: Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.9.1 + with: + access_token: ${{ github.token }} + + - name: Checkout + uses: actions/checkout@v2.3.5 + with: + fetch-depth: 0 + + - name: Setup Node.js environment + uses: actions/setup-node@v2.4.1 + with: + node-version: "14" + cache: "yarn" + + - name: Install dependencies + uses: ./.github/actions/cache-deps + with: + extension: codegen + + - name: Build Packages - Force + run: yarn build --force --no-cache + + - name: Assert latest codegen build committed + run: ./scripts/assert-codegen-build-committed-actions.sh diff --git a/packages/generated/client-types/.gitignore b/packages/generated/client-types/.gitignore index a6326ced16..0771922dd1 100644 --- a/packages/generated/client-types/.gitignore +++ b/packages/generated/client-types/.gitignore @@ -1,3 +1,2 @@ node_modules -/dist -/src/lib \ No newline at end of file +/dist \ No newline at end of file diff --git a/packages/generated/client-types/src/lib/core/ModelUtils.ts b/packages/generated/client-types/src/lib/core/ModelUtils.ts new file mode 100644 index 0000000000..eccb43a060 --- /dev/null +++ b/packages/generated/client-types/src/lib/core/ModelUtils.ts @@ -0,0 +1,121 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +/** + * Typing utilities from https://github.com/sindresorhus/type-fest + */ + +/** + * private methods for exportable dependencies + */ +// https://github.com/sindresorhus/type-fest/blob/main/source/except.d.ts +type Filter = IsEqual extends true + ? never + : KeyType extends ExcludeType + ? never + : KeyType + +// https://github.com/sindresorhus/type-fest/blob/main/source/enforce-optional.d.ts +type RequiredFilter = undefined extends Type[Key] + ? Type[Key] extends undefined + ? Key + : never + : Key + +type OptionalFilter = undefined extends Type[Key] + ? Type[Key] extends undefined + ? never + : Key + : never + +// https://github.com/sindresorhus/type-fest/blob/main/source/merge.d.ts +type SimpleMerge = { + [Key in keyof Destination | keyof Source]: Key extends keyof Source + ? Source[Key] + : Key extends keyof Destination + ? Destination[Key] + : never +} + +/** + * optional exportable dependencies + */ +export type Simplify = { [KeyType in keyof T]: T[KeyType] } & {} + +export type IsEqual = (() => G extends A ? 1 : 2) extends < + G +>() => G extends B ? 1 : 2 + ? true + : false + +export type Except = { + [KeyType in keyof ObjectType as Filter< + KeyType, + KeysType + >]: ObjectType[KeyType] +} + +export type OmitIndexSignature = { + [KeyType in keyof ObjectType as {} extends Record + ? never + : KeyType]: ObjectType[KeyType] +} + +export type PickIndexSignature = { + [KeyType in keyof ObjectType as {} extends Record + ? KeyType + : never]: ObjectType[KeyType] +} + +export type EnforceOptional = Simplify< + { + [Key in keyof ObjectType as RequiredFilter< + ObjectType, + Key + >]: ObjectType[Key] + } & { + [Key in keyof ObjectType as OptionalFilter]?: Exclude< + ObjectType[Key], + undefined + > + } +> + +/** + * SetRequired + */ +export type SetRequired = Simplify< + // Pick just the keys that are optional from the base type. + Except & + // Pick the keys that should be required from the base type and make them required. + Required> +> + +/** + * SetNonNullable + */ +export type SetNonNullable< + BaseType, + Keys extends keyof BaseType = keyof BaseType +> = { + [Key in keyof BaseType]: Key extends Keys + ? NonNullable + : BaseType[Key] +} + +/** + * Merge + */ +export type Merge = EnforceOptional< + SimpleMerge, PickIndexSignature> & + SimpleMerge, OmitIndexSignature> +> + +/** + * SetRelation + * Alias combining SetRequire and SetNonNullable. + */ +export type SetRelation = SetRequired< + SetNonNullable, + Keys +> diff --git a/packages/generated/client-types/src/lib/index.ts b/packages/generated/client-types/src/lib/index.ts new file mode 100644 index 0000000000..7a317e340b --- /dev/null +++ b/packages/generated/client-types/src/lib/index.ts @@ -0,0 +1,5 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ + +export * from "./models" diff --git a/packages/generated/client-types/src/lib/models/Address.ts b/packages/generated/client-types/src/lib/models/Address.ts new file mode 100644 index 0000000000..6348254225 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Address.ts @@ -0,0 +1,85 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Country } from "./Country" +import type { Customer } from "./Customer" + +/** + * An address. + */ +export interface Address { + /** + * ID of the address + */ + id: string + /** + * ID of the customer this address belongs to + */ + customer_id: string | null + /** + * Available if the relation `customer` is expanded. + */ + customer?: Customer | null + /** + * Company name + */ + company: string | null + /** + * First name + */ + first_name: string | null + /** + * Last name + */ + last_name: string | null + /** + * Address line 1 + */ + address_1: string | null + /** + * Address line 2 + */ + address_2: string | null + /** + * City + */ + city: string | null + /** + * The 2 character ISO code of the country in lower case + */ + country_code: string | null + /** + * A country object. Available if the relation `country` is expanded. + */ + country?: Country | null + /** + * Province + */ + province: string | null + /** + * Postal Code + */ + postal_code: string | null + /** + * Phone Number + */ + phone: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/AddressCreatePayload.ts b/packages/generated/client-types/src/lib/models/AddressCreatePayload.ts new file mode 100644 index 0000000000..ce956de05e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AddressCreatePayload.ts @@ -0,0 +1,51 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Address fields used when creating an address. + */ +export interface AddressCreatePayload { + /** + * First name + */ + first_name: string + /** + * Last name + */ + last_name: string + /** + * Phone Number + */ + phone?: string + company?: string + /** + * Address line 1 + */ + address_1: string + /** + * Address line 2 + */ + address_2?: string + /** + * City + */ + city: string + /** + * The 2 character ISO code of the country in lower case + */ + country_code: string + /** + * Province + */ + province?: string + /** + * Postal Code + */ + postal_code: string + /** + * An optional key-value map with additional details + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AddressPayload.ts b/packages/generated/client-types/src/lib/models/AddressPayload.ts new file mode 100644 index 0000000000..cad0473d3f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AddressPayload.ts @@ -0,0 +1,51 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Address fields used when creating/updating an address. + */ +export interface AddressPayload { + /** + * First name + */ + first_name?: string + /** + * Last name + */ + last_name?: string + /** + * Phone Number + */ + phone?: string + company?: string + /** + * Address line 1 + */ + address_1?: string + /** + * Address line 2 + */ + address_2?: string + /** + * City + */ + city?: string + /** + * The 2 character ISO code of the country in lower case + */ + country_code?: string + /** + * Province + */ + province?: string + /** + * Postal Code + */ + postal_code?: string + /** + * An optional key-value map with additional details + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminAppsListRes.ts b/packages/generated/client-types/src/lib/models/AdminAppsListRes.ts new file mode 100644 index 0000000000..ccfedb1ee6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminAppsListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { OAuth } from "./OAuth" + +export interface AdminAppsListRes { + apps: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminAppsRes.ts b/packages/generated/client-types/src/lib/models/AdminAppsRes.ts new file mode 100644 index 0000000000..e783308835 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminAppsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { OAuth } from "./OAuth" + +export interface AdminAppsRes { + apps: OAuth +} diff --git a/packages/generated/client-types/src/lib/models/AdminAuthRes.ts b/packages/generated/client-types/src/lib/models/AdminAuthRes.ts new file mode 100644 index 0000000000..12f20cb09e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminAuthRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { User } from "./User" + +export interface AdminAuthRes { + user: User +} diff --git a/packages/generated/client-types/src/lib/models/AdminBatchJobListRes.ts b/packages/generated/client-types/src/lib/models/AdminBatchJobListRes.ts new file mode 100644 index 0000000000..e6578e8f86 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminBatchJobListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { BatchJob } from "./BatchJob" + +export interface AdminBatchJobListRes { + batch_jobs: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminBatchJobRes.ts b/packages/generated/client-types/src/lib/models/AdminBatchJobRes.ts new file mode 100644 index 0000000000..cdbe6fd8a6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminBatchJobRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { BatchJob } from "./BatchJob" + +export interface AdminBatchJobRes { + batch_job: BatchJob +} diff --git a/packages/generated/client-types/src/lib/models/AdminCollectionsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminCollectionsDeleteRes.ts new file mode 100644 index 0000000000..e759cdd753 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCollectionsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminCollectionsDeleteRes { + /** + * The ID of the deleted Collection + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the collection was deleted successfully or not. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminCollectionsListRes.ts b/packages/generated/client-types/src/lib/models/AdminCollectionsListRes.ts new file mode 100644 index 0000000000..bbf89400e0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCollectionsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCollection } from "./ProductCollection" + +export interface AdminCollectionsListRes { + collections: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminCollectionsRes.ts b/packages/generated/client-types/src/lib/models/AdminCollectionsRes.ts new file mode 100644 index 0000000000..8888e1a9b9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCollectionsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCollection } from "./ProductCollection" + +export interface AdminCollectionsRes { + collection: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/AdminCreateUserRequest.ts b/packages/generated/client-types/src/lib/models/AdminCreateUserRequest.ts new file mode 100644 index 0000000000..1fdd7561da --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCreateUserRequest.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminCreateUserRequest { + /** + * The Users email. + */ + email: string + /** + * The name of the User. + */ + first_name?: string + /** + * The name of the User. + */ + last_name?: string + /** + * Userrole assigned to the user. + */ + role?: "admin" | "member" | "developer" + /** + * The Users password. + */ + password: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminCurrenciesListRes.ts b/packages/generated/client-types/src/lib/models/AdminCurrenciesListRes.ts new file mode 100644 index 0000000000..dd9ee0a5bd --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCurrenciesListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Currency } from "./Currency" + +export interface AdminCurrenciesListRes { + currencies: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminCurrenciesRes.ts b/packages/generated/client-types/src/lib/models/AdminCurrenciesRes.ts new file mode 100644 index 0000000000..5b4aa5d913 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCurrenciesRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Currency } from "./Currency" + +export interface AdminCurrenciesRes { + currency: Currency +} diff --git a/packages/generated/client-types/src/lib/models/AdminCustomerGroupsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminCustomerGroupsDeleteRes.ts new file mode 100644 index 0000000000..8fabf7d2e7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCustomerGroupsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminCustomerGroupsDeleteRes { + /** + * The ID of the deleted customer group. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the customer group was deleted successfully or not. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminCustomerGroupsListRes.ts b/packages/generated/client-types/src/lib/models/AdminCustomerGroupsListRes.ts new file mode 100644 index 0000000000..0810772d49 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCustomerGroupsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { CustomerGroup } from "./CustomerGroup" + +export interface AdminCustomerGroupsListRes { + customer_groups: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminCustomerGroupsRes.ts b/packages/generated/client-types/src/lib/models/AdminCustomerGroupsRes.ts new file mode 100644 index 0000000000..42a3f1a63f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCustomerGroupsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { CustomerGroup } from "./CustomerGroup" + +export interface AdminCustomerGroupsRes { + customer_group: CustomerGroup +} diff --git a/packages/generated/client-types/src/lib/models/AdminCustomersListRes.ts b/packages/generated/client-types/src/lib/models/AdminCustomersListRes.ts new file mode 100644 index 0000000000..9fb32a36f5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCustomersListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" + +export interface AdminCustomersListRes { + customers: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminCustomersRes.ts b/packages/generated/client-types/src/lib/models/AdminCustomersRes.ts new file mode 100644 index 0000000000..5bdfbab740 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminCustomersRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" + +export interface AdminCustomersRes { + customer: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts new file mode 100644 index 0000000000..4ca6aceff9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteCustomerGroupsGroupCustomerBatchReq { + /** + * The ids of the customers to remove + */ + customer_ids: Array<{ + /** + * ID of the customer + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.ts new file mode 100644 index 0000000000..6da57dd19e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteDiscountsDiscountConditionsConditionBatchReq { + /** + * The resources to be deleted from the discount condition + */ + resources: Array<{ + /** + * The id of the item + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteDiscountsDiscountConditionsConditionParams.ts b/packages/generated/client-types/src/lib/models/AdminDeleteDiscountsDiscountConditionsConditionParams.ts new file mode 100644 index 0000000000..b62e5d42e9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteDiscountsDiscountConditionsConditionParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteDiscountsDiscountConditionsConditionParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts b/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts new file mode 100644 index 0000000000..93e9e7a362 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeletePriceListPricesPricesReq { + /** + * The price id's of the Money Amounts to delete. + */ + price_ids?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchParams.ts b/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchParams.ts new file mode 100644 index 0000000000..f7ca72d6c5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteProductCategoriesCategoryProductsBatchParams { + /** + * (Comma separated) Category fields to be expanded in the response. + */ + expand?: string + /** + * (Comma separated) Category fields to be retrieved in the response. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts new file mode 100644 index 0000000000..ae5cf7a88d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteProductCategoriesCategoryProductsBatchReq { + /** + * The IDs of the products to delete from the Product Category. + */ + product_ids: Array<{ + /** + * The ID of a product + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts new file mode 100644 index 0000000000..56e8b680cc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteProductsFromCollectionReq { + /** + * An array of Product IDs to remove from the Product Collection. + */ + product_ids: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionRes.ts b/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionRes.ts new file mode 100644 index 0000000000..025c5a46ac --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteProductsFromCollectionRes { + /** + * The ID of the collection + */ + id: string + /** + * The type of object the removal was executed on + */ + object: string + /** + * The IDs of the products removed from the collection + */ + removed_products: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts new file mode 100644 index 0000000000..bc2e57a16f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeletePublishableApiKeySalesChannelsBatchReq { + /** + * The IDs of the sales channels to delete from the publishable api key + */ + sales_channel_ids: Array<{ + /** + * The ID of the sales channel + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts new file mode 100644 index 0000000000..15e2fb3d30 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteSalesChannelsChannelProductsBatchReq { + /** + * The IDs of the products to delete from the Sales Channel. + */ + product_ids: Array<{ + /** + * The ID of a product + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelStockLocationsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelStockLocationsReq.ts new file mode 100644 index 0000000000..76d43b745d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelStockLocationsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteSalesChannelsChannelStockLocationsReq { + /** + * The ID of the stock location + */ + location_id: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteShippingProfileRes.ts b/packages/generated/client-types/src/lib/models/AdminDeleteShippingProfileRes.ts new file mode 100644 index 0000000000..59a21eac18 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteShippingProfileRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteShippingProfileRes { + /** + * The ID of the deleted Shipping Profile. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductTypesParams.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductTypesParams.ts new file mode 100644 index 0000000000..abb8eb9b4e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductTypesParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteTaxRatesTaxRateProductTypesParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductTypesReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductTypesReq.ts new file mode 100644 index 0000000000..7f9e7519e8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductTypesReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteTaxRatesTaxRateProductTypesReq { + /** + * The IDs of the types of products to remove association with this tax rate + */ + product_types: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsParams.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsParams.ts new file mode 100644 index 0000000000..2848c7686c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteTaxRatesTaxRateProductsParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts new file mode 100644 index 0000000000..e7ce8b1464 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteTaxRatesTaxRateProductsReq { + /** + * The IDs of the products to remove association with this tax rate + */ + products: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsParams.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsParams.ts new file mode 100644 index 0000000000..c248705f8a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteTaxRatesTaxRateShippingOptionsParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts new file mode 100644 index 0000000000..0fb215cb48 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteTaxRatesTaxRateShippingOptionsReq { + /** + * The IDs of the shipping options to remove association with this tax rate + */ + shipping_options: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts b/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts new file mode 100644 index 0000000000..72bc3bdf47 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteUploadsReq { + /** + * key of the file to delete + */ + file_key: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteUploadsRes.ts b/packages/generated/client-types/src/lib/models/AdminDeleteUploadsRes.ts new file mode 100644 index 0000000000..03964dd0a0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteUploadsRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteUploadsRes { + /** + * The file key of the upload deleted + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminDeleteUserRes.ts b/packages/generated/client-types/src/lib/models/AdminDeleteUserRes.ts new file mode 100644 index 0000000000..86546fd87c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDeleteUserRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDeleteUserRes { + /** + * The ID of the deleted user. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminDiscountConditionsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminDiscountConditionsDeleteRes.ts new file mode 100644 index 0000000000..54fd92dd43 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDiscountConditionsDeleteRes.ts @@ -0,0 +1,25 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Discount } from "./Discount" + +export interface AdminDiscountConditionsDeleteRes { + /** + * The ID of the deleted DiscountCondition + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the discount condition was deleted successfully or not. + */ + deleted: boolean + /** + * The Discount to which the condition used to belong + */ + discount: Discount +} diff --git a/packages/generated/client-types/src/lib/models/AdminDiscountConditionsRes.ts b/packages/generated/client-types/src/lib/models/AdminDiscountConditionsRes.ts new file mode 100644 index 0000000000..6f602ca72d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDiscountConditionsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountCondition } from "./DiscountCondition" + +export interface AdminDiscountConditionsRes { + discount_condition: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/AdminDiscountsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminDiscountsDeleteRes.ts new file mode 100644 index 0000000000..c87c7bdbf0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDiscountsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDiscountsDeleteRes { + /** + * The ID of the deleted Discount + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the discount was deleted successfully or not. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminDiscountsListRes.ts b/packages/generated/client-types/src/lib/models/AdminDiscountsListRes.ts new file mode 100644 index 0000000000..0a3640362f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDiscountsListRes.ts @@ -0,0 +1,30 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Discount } from "./Discount" +import type { DiscountRule } from "./DiscountRule" + +export interface AdminDiscountsListRes { + discounts: Array< + Merge< + SetRelation, + { + rule: SetRelation + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminDiscountsRes.ts b/packages/generated/client-types/src/lib/models/AdminDiscountsRes.ts new file mode 100644 index 0000000000..7e6ae42801 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDiscountsRes.ts @@ -0,0 +1,20 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Discount } from "./Discount" +import type { DiscountRule } from "./DiscountRule" +import type { Region } from "./Region" + +export interface AdminDiscountsRes { + discount: Merge< + SetRelation, + { + regions: Array< + SetRelation + > + rule: SetRelation + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminDraftOrdersDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminDraftOrdersDeleteRes.ts new file mode 100644 index 0000000000..30552960fb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDraftOrdersDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminDraftOrdersDeleteRes { + /** + * The ID of the deleted Draft Order. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the draft order was deleted successfully or not. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminDraftOrdersListRes.ts b/packages/generated/client-types/src/lib/models/AdminDraftOrdersListRes.ts new file mode 100644 index 0000000000..4f312f6e1e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDraftOrdersListRes.ts @@ -0,0 +1,36 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { DraftOrder } from "./DraftOrder" +import type { LineItem } from "./LineItem" + +export interface AdminDraftOrdersListRes { + draft_orders: Array< + Merge< + SetRelation, + { + cart: Merge< + SetRelation, + { + items: Array> + } + > + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminDraftOrdersRes.ts b/packages/generated/client-types/src/lib/models/AdminDraftOrdersRes.ts new file mode 100644 index 0000000000..6c8d1fe048 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminDraftOrdersRes.ts @@ -0,0 +1,77 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { Discount } from "./Discount" +import type { DraftOrder } from "./DraftOrder" +import type { LineItem } from "./LineItem" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" +import type { ShippingMethod } from "./ShippingMethod" + +export interface AdminDraftOrdersRes { + draft_order: Merge< + SetRelation, + { + cart: Merge< + SetRelation< + Cart, + | "items" + | "billing_address" + | "customer" + | "discounts" + | "payment" + | "payment_sessions" + | "region" + | "shipping_address" + | "shipping_methods" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "item_tax_total" + | "refundable_amount" + | "refunded_total" + | "shipping_tax_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + | "gift_cards" + >, + { + items: Array< + Merge< + SetRelation< + LineItem, + | "adjustments" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "tax_lines" + | "variant" + >, + { + variant: SetRelation + } + > + > + discounts: Array> + region: SetRelation< + Region, + "payment_providers" | "tax_rates" | "fulfillment_providers" + > + shipping_methods: Array< + SetRelation + > + } + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminExtendedStoresRes.ts b/packages/generated/client-types/src/lib/models/AdminExtendedStoresRes.ts new file mode 100644 index 0000000000..0a23998ff0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminExtendedStoresRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ExtendedStoreDTO } from "./ExtendedStoreDTO" + +export interface AdminExtendedStoresRes { + store: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetBatchParams.ts b/packages/generated/client-types/src/lib/models/AdminGetBatchParams.ts new file mode 100644 index 0000000000..cd927e758f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetBatchParams.ts @@ -0,0 +1,182 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetBatchParams { + /** + * The number of batch jobs to return. + */ + limit?: number + /** + * The number of batch jobs to skip before results. + */ + offset?: number + /** + * Filter by the batch ID + */ + id?: string | Array + /** + * Filter by the batch type + */ + type?: Array + /** + * Date comparison for when resulting collections was confirmed, i.e. less than, greater than etc. + */ + confirmed_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections was pre processed, i.e. less than, greater than etc. + */ + pre_processed_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections was completed, i.e. less than, greater than etc. + */ + completed_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections was failed, i.e. less than, greater than etc. + */ + failed_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections was canceled, i.e. less than, greater than etc. + */ + canceled_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Field used to order retrieved batch jobs + */ + order?: string + /** + * (Comma separated) Which fields should be expanded in each order of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each order of the result. + */ + fields?: string + /** + * Date comparison for when resulting collections was created, i.e. less than, greater than etc. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections was updated, i.e. less than, greater than etc. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetCollectionsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetCollectionsParams.ts new file mode 100644 index 0000000000..ea9c10e4a6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetCollectionsParams.ts @@ -0,0 +1,94 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetCollectionsParams { + /** + * The number of collections to return. + */ + limit?: number + /** + * The number of collections to skip before the results. + */ + offset?: number + /** + * The title of collections to return. + */ + title?: string + /** + * The handle of collections to return. + */ + handle?: string + /** + * a search term to search titles and handles. + */ + q?: string + /** + * The discount condition id on which to filter the product collections. + */ + discount_condition_id?: string + /** + * Date comparison for when resulting collections were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were deleted. + */ + deleted_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetCurrenciesParams.ts b/packages/generated/client-types/src/lib/models/AdminGetCurrenciesParams.ts new file mode 100644 index 0000000000..2f7d092580 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetCurrenciesParams.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetCurrenciesParams { + /** + * Code of the currency to search for. + */ + code?: string + /** + * Search for tax inclusive currencies. + */ + includes_tax?: boolean + /** + * order to retrieve products in. + */ + order?: string + /** + * How many products to skip in the result. + */ + offset?: number + /** + * Limit the number of products returned. + */ + limit?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetCustomerGroupsGroupParams.ts b/packages/generated/client-types/src/lib/models/AdminGetCustomerGroupsGroupParams.ts new file mode 100644 index 0000000000..c1f86ee484 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetCustomerGroupsGroupParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetCustomerGroupsGroupParams { + /** + * (Comma separated) Which fields should be expanded in the customer group. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in the customer group. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetCustomerGroupsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetCustomerGroupsParams.ts new file mode 100644 index 0000000000..1deec360c9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetCustomerGroupsParams.ts @@ -0,0 +1,101 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetCustomerGroupsParams { + /** + * Query used for searching customer group names. + */ + q?: string + /** + * How many groups to skip in the result. + */ + offset?: number + /** + * the field used to order the customer groups. + */ + order?: string + /** + * The discount condition id on which to filter the customer groups. + */ + discount_condition_id?: string + /** + * Filter by the customer group ID + */ + id?: + | string + | Array + | { + /** + * filter by IDs less than this ID + */ + lt?: string + /** + * filter by IDs greater than this ID + */ + gt?: string + /** + * filter by IDs less than or equal to this ID + */ + lte?: string + /** + * filter by IDs greater than or equal to this ID + */ + gte?: string + } + /** + * Filter by the customer group name + */ + name?: Array + /** + * Date comparison for when resulting customer groups were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting customer groups were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Limit the number of customer groups returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each customer groups of the result. + */ + expand?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetCustomersParams.ts b/packages/generated/client-types/src/lib/models/AdminGetCustomersParams.ts new file mode 100644 index 0000000000..3519953c4f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetCustomersParams.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetCustomersParams { + /** + * The number of items to return. + */ + limit?: number + /** + * The items to skip before result. + */ + offset?: number + /** + * (Comma separated) Which fields should be expanded in each customer. + */ + expand?: string + /** + * a search term to search email, first_name, and last_name. + */ + q?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetDiscountParams.ts b/packages/generated/client-types/src/lib/models/AdminGetDiscountParams.ts new file mode 100644 index 0000000000..9b53b95705 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetDiscountParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetDiscountParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetDiscountsDiscountCodeParams.ts b/packages/generated/client-types/src/lib/models/AdminGetDiscountsDiscountCodeParams.ts new file mode 100644 index 0000000000..95bb527fec --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetDiscountsDiscountCodeParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetDiscountsDiscountCodeParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetDiscountsDiscountConditionsConditionParams.ts b/packages/generated/client-types/src/lib/models/AdminGetDiscountsDiscountConditionsConditionParams.ts new file mode 100644 index 0000000000..8c323dfb00 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetDiscountsDiscountConditionsConditionParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetDiscountsDiscountConditionsConditionParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetDiscountsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetDiscountsParams.ts new file mode 100644 index 0000000000..af1843ec84 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetDiscountsParams.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetDiscountsParams { + /** + * Search query applied on the code field. + */ + q?: string + /** + * Discount Rules filters to apply on the search + */ + rule?: { + /** + * The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers. + */ + type?: "fixed" | "percentage" | "free_shipping" + /** + * The value that the discount represents; this will depend on the type of the discount + */ + allocation?: "total" | "item" + } + /** + * Return only dynamic discounts. + */ + is_dynamic?: boolean + /** + * Return only disabled discounts. + */ + is_disabled?: boolean + /** + * The number of items in the response + */ + limit?: number + /** + * The offset of items in response + */ + offset?: number + /** + * Comma separated list of relations to include in the results. + */ + expand?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetDraftOrdersParams.ts b/packages/generated/client-types/src/lib/models/AdminGetDraftOrdersParams.ts new file mode 100644 index 0000000000..1b8f307772 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetDraftOrdersParams.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetDraftOrdersParams { + /** + * The number of items to skip before the results. + */ + offset?: number + /** + * Limit the number of items returned. + */ + limit?: number + /** + * a search term to search emails in carts associated with draft orders and display IDs of draft orders + */ + q?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetGiftCardsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetGiftCardsParams.ts new file mode 100644 index 0000000000..27e55700aa --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetGiftCardsParams.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetGiftCardsParams { + /** + * The number of items to skip before the results. + */ + offset?: number + /** + * Limit the number of items returned. + */ + limit?: number + /** + * a search term to search by code or display ID + */ + q?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetGroupsGroupCustomersParams.ts b/packages/generated/client-types/src/lib/models/AdminGetGroupsGroupCustomersParams.ts new file mode 100644 index 0000000000..187bddb845 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetGroupsGroupCustomersParams.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetGroupsGroupCustomersParams { + /** + * The number of items to return. + */ + limit?: number + /** + * The items to skip before result. + */ + offset?: number + /** + * (Comma separated) Which fields should be expanded in each customer. + */ + expand?: string + /** + * a search term to search email, first_name, and last_name. + */ + q?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsItemLocationLevelsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsItemLocationLevelsParams.ts new file mode 100644 index 0000000000..b34dafab41 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsItemLocationLevelsParams.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetInventoryItemsItemLocationLevelsParams { + /** + * How many stock locations levels to skip in the result. + */ + offset?: number + /** + * Limit the number of stock locations levels returned. + */ + limit?: number + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsItemParams.ts b/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsItemParams.ts new file mode 100644 index 0000000000..06c07c4887 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsItemParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetInventoryItemsItemParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsParams.ts new file mode 100644 index 0000000000..2d16f2abe5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetInventoryItemsParams.ts @@ -0,0 +1,75 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetInventoryItemsParams { + /** + * How many inventory items to skip in the result. + */ + offset?: number + /** + * Limit the number of inventory items returned. + */ + limit?: number + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string + /** + * Query used for searching product inventory items and their properties. + */ + q?: string + /** + * Locations ids to search for. + */ + location_id?: Array + /** + * id to search for. + */ + id?: string + /** + * sku to search for. + */ + sku?: string + /** + * origin_country to search for. + */ + origin_country?: string + /** + * mid_code to search for. + */ + mid_code?: string + /** + * material to search for. + */ + material?: string + /** + * hs_code to search for. + */ + hs_code?: string + /** + * weight to search for. + */ + weight?: string + /** + * length to search for. + */ + length?: string + /** + * height to search for. + */ + height?: string + /** + * width to search for. + */ + width?: string + /** + * requires_shipping to search for. + */ + requires_shipping?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetNotesParams.ts b/packages/generated/client-types/src/lib/models/AdminGetNotesParams.ts new file mode 100644 index 0000000000..7f0a7ba661 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetNotesParams.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetNotesParams { + /** + * The number of notes to get + */ + limit?: number + /** + * The offset at which to get notes + */ + offset?: number + /** + * The ID which the notes belongs to + */ + resource_id?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetNotificationsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetNotificationsParams.ts new file mode 100644 index 0000000000..b76904bf41 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetNotificationsParams.ts @@ -0,0 +1,43 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetNotificationsParams { + /** + * The number of notifications to skip before starting to collect the notifications set + */ + offset?: number + /** + * The number of notifications to return + */ + limit?: number + /** + * Comma separated fields to include in the result set + */ + fields?: string + /** + * Comma separated fields to populate + */ + expand?: string + /** + * The name of the event that the notification was sent for. + */ + event_name?: string + /** + * The type of resource that the Notification refers to. + */ + resource_type?: string + /** + * The ID of the resource that the Notification refers to. + */ + resource_id?: string + /** + * The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id + */ + to?: string + /** + * A boolean indicating whether the result set should include resent notifications or not + */ + include_resends?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetOrdersOrderParams.ts b/packages/generated/client-types/src/lib/models/AdminGetOrdersOrderParams.ts new file mode 100644 index 0000000000..2be23e0894 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetOrdersOrderParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetOrdersOrderParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetOrdersParams.ts b/packages/generated/client-types/src/lib/models/AdminGetOrdersParams.ts new file mode 100644 index 0000000000..217ac93471 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetOrdersParams.ts @@ -0,0 +1,158 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetOrdersParams { + /** + * Query used for searching orders by shipping address first name, orders' email, and orders' display ID + */ + q?: string + /** + * ID of the order to search for. + */ + id?: string + /** + * Status to search for + */ + status?: Array< + "pending" | "completed" | "archived" | "canceled" | "requires_action" + > + /** + * Fulfillment status to search for. + */ + fulfillment_status?: Array< + | "not_fulfilled" + | "fulfilled" + | "partially_fulfilled" + | "shipped" + | "partially_shipped" + | "canceled" + | "returned" + | "partially_returned" + | "requires_action" + > + /** + * Payment status to search for. + */ + payment_status?: Array< + | "captured" + | "awaiting" + | "not_paid" + | "refunded" + | "partially_refunded" + | "canceled" + | "requires_action" + > + /** + * Display ID to search for. + */ + display_id?: string + /** + * to search for. + */ + cart_id?: string + /** + * to search for. + */ + customer_id?: string + /** + * to search for. + */ + email?: string + /** + * Regions to search orders by + */ + region_id?: string | Array + /** + * Currency code to search for + */ + currency_code?: string + /** + * to search for. + */ + tax_rate?: string + /** + * Date comparison for when resulting orders were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting orders were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting orders were canceled. + */ + canceled_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Filter by Sales Channels + */ + sales_channel_id?: Array + /** + * How many orders to skip before the results. + */ + offset?: number + /** + * Limit the number of orders returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each order of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each order of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetPaymentCollectionsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetPaymentCollectionsParams.ts new file mode 100644 index 0000000000..adc0782d75 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetPaymentCollectionsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetPaymentCollectionsParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetPriceListPaginationParams.ts b/packages/generated/client-types/src/lib/models/AdminGetPriceListPaginationParams.ts new file mode 100644 index 0000000000..2e179f8c4a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetPriceListPaginationParams.ts @@ -0,0 +1,110 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetPriceListPaginationParams { + /** + * The number of items to get + */ + limit?: number + /** + * The offset at which to get items + */ + offset?: number + /** + * (Comma separated) Which fields should be expanded in each item of the result. + */ + expand?: string + /** + * field to order results by. + */ + order?: string + /** + * ID to search for. + */ + id?: string + /** + * query to search in price list description, price list name, and customer group name fields. + */ + q?: string + /** + * Status to search for. + */ + status?: Array<"active" | "draft"> + /** + * price list name to search for. + */ + name?: string + /** + * Customer Group IDs to search for. + */ + customer_groups?: Array + /** + * Type to search for. + */ + type?: Array<"sale" | "override"> + /** + * Date comparison for when resulting price lists were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting price lists were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting price lists were deleted. + */ + deleted_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetPriceListsPriceListProductsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetPriceListsPriceListProductsParams.ts new file mode 100644 index 0000000000..664bf18d9e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetPriceListsPriceListProductsParams.ts @@ -0,0 +1,130 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetPriceListsPriceListProductsParams { + /** + * Query used for searching product title and description, variant title and sku, and collection title. + */ + q?: string + /** + * ID of the product to search for. + */ + id?: string + /** + * Product status to search for + */ + status?: Array<"draft" | "proposed" | "published" | "rejected"> + /** + * Collection IDs to search for + */ + collection_id?: Array + /** + * Tag IDs to search for + */ + tags?: Array + /** + * product title to search for. + */ + title?: string + /** + * product description to search for. + */ + description?: string + /** + * product handle to search for. + */ + handle?: string + /** + * Search for giftcards using is_giftcard=true. + */ + is_giftcard?: string + /** + * to search for. + */ + type?: string + /** + * field to sort results by. + */ + order?: string + /** + * Date comparison for when resulting products were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting products were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting products were deleted. + */ + deleted_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * How many products to skip in the result. + */ + offset?: number + /** + * Limit the number of products returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each product of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each product of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetProductCategoriesParams.ts b/packages/generated/client-types/src/lib/models/AdminGetProductCategoriesParams.ts new file mode 100644 index 0000000000..dbea731398 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetProductCategoriesParams.ts @@ -0,0 +1,43 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetProductCategoriesParams { + /** + * Query used for searching product category names orhandles. + */ + q?: string + /** + * Search for only internal categories. + */ + is_internal?: boolean + /** + * Search for only active categories + */ + is_active?: boolean + /** + * Include all nested descendants of category + */ + include_descendants_tree?: boolean + /** + * Returns categories scoped by parent + */ + parent_category_id?: string + /** + * How many product categories to skip in the result. + */ + offset?: number + /** + * Limit the number of product categories returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in the product category. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in the product category. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetProductCategoryParams.ts b/packages/generated/client-types/src/lib/models/AdminGetProductCategoryParams.ts new file mode 100644 index 0000000000..ef5f10292e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetProductCategoryParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetProductCategoryParams { + /** + * (Comma separated) Which fields should be expanded in the results. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetProductTagsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetProductTagsParams.ts new file mode 100644 index 0000000000..a385a5da1f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetProductTagsParams.ts @@ -0,0 +1,77 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetProductTagsParams { + /** + * The number of tags to return. + */ + limit?: number + /** + * The number of items to skip before the results. + */ + offset?: number + /** + * The field to sort items by. + */ + order?: string + /** + * The discount condition id on which to filter the tags. + */ + discount_condition_id?: string + /** + * The tag values to search for + */ + value?: Array + /** + * A query string to search values for + */ + q?: string + /** + * The tag IDs to search for + */ + id?: Array + /** + * Date comparison for when resulting product tags were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting product tags were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetProductTypesParams.ts b/packages/generated/client-types/src/lib/models/AdminGetProductTypesParams.ts new file mode 100644 index 0000000000..79f1375429 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetProductTypesParams.ts @@ -0,0 +1,77 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetProductTypesParams { + /** + * The number of types to return. + */ + limit?: number + /** + * The number of items to skip before the results. + */ + offset?: number + /** + * The field to sort items by. + */ + order?: string + /** + * The discount condition id on which to filter the product types. + */ + discount_condition_id?: string + /** + * The type values to search for + */ + value?: Array + /** + * The type IDs to search for + */ + id?: Array + /** + * A query string to search values for + */ + q?: string + /** + * Date comparison for when resulting product types were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting product types were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetProductsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetProductsParams.ts new file mode 100644 index 0000000000..3e3aef9aa5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetProductsParams.ts @@ -0,0 +1,150 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetProductsParams { + /** + * Query used for searching product title and description, variant title and sku, and collection title. + */ + q?: string + /** + * The discount condition id on which to filter the product. + */ + discount_condition_id?: string + /** + * Filter by product IDs. + */ + id?: string | Array + /** + * Status to search for + */ + status?: Array<"draft" | "proposed" | "published" | "rejected"> + /** + * Collection ids to search for. + */ + collection_id?: Array + /** + * Tag IDs to search for + */ + tags?: Array + /** + * Price List IDs to search for + */ + price_list_id?: Array + /** + * Sales Channel IDs to filter products by + */ + sales_channel_id?: Array + /** + * Type IDs to filter products by + */ + type_id?: Array + /** + * Category IDs to filter products by + */ + category_id?: Array + /** + * Include category children when filtering by category_id + */ + include_category_children?: boolean + /** + * title to search for. + */ + title?: string + /** + * description to search for. + */ + description?: string + /** + * handle to search for. + */ + handle?: string + /** + * Search for giftcards using is_giftcard=true. + */ + is_giftcard?: boolean + /** + * Date comparison for when resulting products were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting products were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting products were deleted. + */ + deleted_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * How many products to skip in the result. + */ + offset?: number + /** + * Limit the number of products returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each product of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each product of the result. + */ + fields?: string + /** + * the field used to order the products. + */ + order?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetProductsVariantsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetProductsVariantsParams.ts new file mode 100644 index 0000000000..fbe85ebedf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetProductsVariantsParams.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetProductsVariantsParams { + /** + * Comma separated string of the column to select. + */ + fields?: string + /** + * Comma separated string of the relations to include. + */ + expand?: string + /** + * How many items to skip before the results. + */ + offset?: number + /** + * Limit the number of items returned. + */ + limit?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetRegionsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetRegionsParams.ts new file mode 100644 index 0000000000..e1f66ea21a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetRegionsParams.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetRegionsParams { + /** + * limit the number of regions in response + */ + limit?: number + /** + * Offset of regions in response (used for pagination) + */ + offset?: number + /** + * Date comparison for when resulting region was created, i.e. less than, greater than etc. + */ + created_at?: Record + /** + * Date comparison for when resulting region was updated, i.e. less than, greater than etc. + */ + updated_at?: Record + /** + * Date comparison for when resulting region was deleted, i.e. less than, greater than etc. + */ + deleted_at?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetRegionsRegionFulfillmentOptionsRes.ts b/packages/generated/client-types/src/lib/models/AdminGetRegionsRegionFulfillmentOptionsRes.ts new file mode 100644 index 0000000000..2176a8ef5e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetRegionsRegionFulfillmentOptionsRes.ts @@ -0,0 +1,17 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetRegionsRegionFulfillmentOptionsRes { + fulfillment_options: Array<{ + /** + * ID of the fulfillment provider + */ + provider_id: string + /** + * fulfillment provider options + */ + options: Array> + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetReservationsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetReservationsParams.ts new file mode 100644 index 0000000000..81fda12ae9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetReservationsParams.ts @@ -0,0 +1,56 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetReservationsParams { + /** + * Location ids to search for. + */ + location_id?: Array + /** + * Inventory Item ids to search for. + */ + inventory_item_id?: Array + /** + * Line Item ids to search for. + */ + line_item_id?: Array + /** + * Filter by reservation quantity + */ + quantity?: { + /** + * filter by reservation quantity less than this number + */ + lt?: number + /** + * filter by reservation quantity greater than this number + */ + gt?: number + /** + * filter by reservation quantity less than or equal to this number + */ + lte?: number + /** + * filter by reservation quantity greater than or equal to this number + */ + gte?: number + } + /** + * How many Reservations to skip in the result. + */ + offset?: number + /** + * Limit the number of Reservations returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in the product category. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in the product category. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetReturnsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetReturnsParams.ts new file mode 100644 index 0000000000..98e7834202 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetReturnsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetReturnsParams { + /** + * The upper limit for the amount of responses returned. + */ + limit?: number + /** + * The offset of the list returned. + */ + offset?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetSalesChannelsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetSalesChannelsParams.ts new file mode 100644 index 0000000000..116085e0fe --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetSalesChannelsParams.ts @@ -0,0 +1,106 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetSalesChannelsParams { + /** + * ID of the sales channel + */ + id?: string + /** + * Name of the sales channel + */ + name?: string + /** + * Description of the sales channel + */ + description?: string + /** + * Query used for searching sales channels' names and descriptions. + */ + q?: string + /** + * The field to order the results by. + */ + order?: string + /** + * Date comparison for when resulting collections were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were deleted. + */ + deleted_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * How many sales channels to skip in the result. + */ + offset?: number + /** + * Limit the number of sales channels returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each sales channel of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each sales channel of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetShippingOptionsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetShippingOptionsParams.ts new file mode 100644 index 0000000000..22468180f1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetShippingOptionsParams.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetShippingOptionsParams { + /** + * Region ID to fetch options from + */ + region_id?: string + /** + * Flag for fetching return options only + */ + is_return?: boolean + /** + * Flag for fetching admin specific options + */ + admin_only?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetStockLocationsLocationParams.ts b/packages/generated/client-types/src/lib/models/AdminGetStockLocationsLocationParams.ts new file mode 100644 index 0000000000..95d1e9e933 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetStockLocationsLocationParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetStockLocationsLocationParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetStockLocationsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetStockLocationsParams.ts new file mode 100644 index 0000000000..54e85e34b4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetStockLocationsParams.ts @@ -0,0 +1,98 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetStockLocationsParams { + /** + * ID of the stock location + */ + id?: string + /** + * Name of the stock location + */ + name?: string + /** + * The field to order the results by. + */ + order?: string + /** + * Date comparison for when resulting collections were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were deleted. + */ + deleted_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * How many stock locations to skip in the result. + */ + offset?: number + /** + * Limit the number of stock locations returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each stock location of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each stock location of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetSwapsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetSwapsParams.ts new file mode 100644 index 0000000000..36e1f3b4d9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetSwapsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetSwapsParams { + /** + * The upper limit for the amount of responses returned. + */ + limit?: number + /** + * The offset of the list returned. + */ + offset?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetTaxRatesParams.ts b/packages/generated/client-types/src/lib/models/AdminGetTaxRatesParams.ts new file mode 100644 index 0000000000..72bab1a626 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetTaxRatesParams.ts @@ -0,0 +1,58 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetTaxRatesParams { + /** + * Name of tax rate to retrieve + */ + name?: string + /** + * Filter by Region ID + */ + region_id?: string | Array + /** + * code to search for. + */ + code?: string + /** + * Filter by Rate + */ + rate?: + | number + | { + /** + * filter by rates less than this number + */ + lt?: number + /** + * filter by rates greater than this number + */ + gt?: number + /** + * filter by rates less than or equal to this number + */ + lte?: number + /** + * filter by rates greater than or equal to this number + */ + gte?: number + } + /** + * How many tax rates to skip before retrieving the result. + */ + offset?: number + /** + * Limit the number of tax rates returned. + */ + limit?: number + /** + * Which fields should be included in each item. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved for each item. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetTaxRatesTaxRateParams.ts b/packages/generated/client-types/src/lib/models/AdminGetTaxRatesTaxRateParams.ts new file mode 100644 index 0000000000..ad4294445c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetTaxRatesTaxRateParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetTaxRatesTaxRateParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetVariantParams.ts b/packages/generated/client-types/src/lib/models/AdminGetVariantParams.ts new file mode 100644 index 0000000000..d21af3e97a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetVariantParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetVariantParams { + /** + * (Comma separated) Which fields should be expanded the order of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included the order of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetVariantsParams.ts b/packages/generated/client-types/src/lib/models/AdminGetVariantsParams.ts new file mode 100644 index 0000000000..3d9839540a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetVariantsParams.ts @@ -0,0 +1,74 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGetVariantsParams { + /** + * A Product Variant id to filter by. + */ + id?: string + /** + * A comma separated list of Product Variant ids to filter by. + */ + ids?: string + /** + * A comma separated list of Product Variant relations to load. + */ + expand?: string + /** + * A comma separated list of Product Variant fields to include. + */ + fields?: string + /** + * How many product variants to skip in the result. + */ + offset?: number + /** + * Maximum number of Product Variants to return. + */ + limit?: number + /** + * The id of the cart to use for price selection. + */ + cart_id?: string + /** + * The id of the region to use for price selection. + */ + region_id?: string + /** + * The currency code to use for price selection. + */ + currency_code?: string + /** + * The id of the customer to use for price selection. + */ + customer_id?: string + /** + * product variant title to search for. + */ + title?: string | Array + /** + * Filter by available inventory quantity + */ + inventory_quantity?: + | number + | { + /** + * filter by inventory quantity less than this number + */ + lt?: number + /** + * filter by inventory quantity greater than this number + */ + gt?: number + /** + * filter by inventory quantity less than or equal to this number + */ + lte?: number + /** + * filter by inventory quantity greater than or equal to this number + */ + gte?: number + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminGetVariantsVariantInventoryRes.ts b/packages/generated/client-types/src/lib/models/AdminGetVariantsVariantInventoryRes.ts new file mode 100644 index 0000000000..5a3a0de385 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGetVariantsVariantInventoryRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { VariantInventory } from "./VariantInventory" + +export interface AdminGetVariantsVariantInventoryRes { + variant?: VariantInventory +} diff --git a/packages/generated/client-types/src/lib/models/AdminGiftCardsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminGiftCardsDeleteRes.ts new file mode 100644 index 0000000000..ef72aafe86 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGiftCardsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminGiftCardsDeleteRes { + /** + * The ID of the deleted Gift Card + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the gift card was deleted successfully or not. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminGiftCardsListRes.ts b/packages/generated/client-types/src/lib/models/AdminGiftCardsListRes.ts new file mode 100644 index 0000000000..ad04c9d194 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGiftCardsListRes.ts @@ -0,0 +1,33 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { GiftCard } from "./GiftCard" +import type { Region } from "./Region" + +export interface AdminGiftCardsListRes { + gift_cards: Array< + Merge< + SetRelation, + { + region: SetRelation< + Region, + "fulfillment_providers" | "payment_providers" + > + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminGiftCardsRes.ts b/packages/generated/client-types/src/lib/models/AdminGiftCardsRes.ts new file mode 100644 index 0000000000..09b0e20d0e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminGiftCardsRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { GiftCard } from "./GiftCard" +import type { Region } from "./Region" + +export interface AdminGiftCardsRes { + gift_card: Merge< + SetRelation, + { + region: SetRelation + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminInventoryItemsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminInventoryItemsDeleteRes.ts new file mode 100644 index 0000000000..c2e2a94ab6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminInventoryItemsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminInventoryItemsDeleteRes { + /** + * The ID of the deleted Inventory Item. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Inventory Item was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminInventoryItemsListRes.ts b/packages/generated/client-types/src/lib/models/AdminInventoryItemsListRes.ts new file mode 100644 index 0000000000..7680e9c95c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminInventoryItemsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { InventoryItemDTO } from "./InventoryItemDTO" + +export interface AdminInventoryItemsListRes { + inventory_items: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.ts b/packages/generated/client-types/src/lib/models/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.ts new file mode 100644 index 0000000000..907bdb079e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.ts @@ -0,0 +1,29 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { InventoryItemDTO } from "./InventoryItemDTO" +import type { InventoryLevelDTO } from "./InventoryLevelDTO" +import type { ProductVariant } from "./ProductVariant" + +export interface AdminInventoryItemsListWithVariantsAndLocationLevelsRes { + inventory_items: Array< + InventoryItemDTO & { + location_levels?: Array + variants?: Array + } + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminInventoryItemsLocationLevelsRes.ts b/packages/generated/client-types/src/lib/models/AdminInventoryItemsLocationLevelsRes.ts new file mode 100644 index 0000000000..b213f78294 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminInventoryItemsLocationLevelsRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { InventoryLevelDTO } from "./InventoryLevelDTO" + +export interface AdminInventoryItemsLocationLevelsRes { + inventory_item: { + /** + * The id of the location + */ + id: any + /** + * List of stock levels at a given location + */ + location_levels: Array + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminInventoryItemsRes.ts b/packages/generated/client-types/src/lib/models/AdminInventoryItemsRes.ts new file mode 100644 index 0000000000..db1b66b658 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminInventoryItemsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { InventoryItemDTO } from "./InventoryItemDTO" + +export interface AdminInventoryItemsRes { + inventory_item: InventoryItemDTO +} diff --git a/packages/generated/client-types/src/lib/models/AdminInviteDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminInviteDeleteRes.ts new file mode 100644 index 0000000000..ef99f45d10 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminInviteDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminInviteDeleteRes { + /** + * The ID of the deleted Invite. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Invite was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminListInvitesRes.ts b/packages/generated/client-types/src/lib/models/AdminListInvitesRes.ts new file mode 100644 index 0000000000..bb7dd0f389 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminListInvitesRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Invite } from "./Invite" + +export interface AdminListInvitesRes { + invites: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminNotesDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminNotesDeleteRes.ts new file mode 100644 index 0000000000..0657f6cb32 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminNotesDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminNotesDeleteRes { + /** + * The ID of the deleted Note. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Note was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminNotesListRes.ts b/packages/generated/client-types/src/lib/models/AdminNotesListRes.ts new file mode 100644 index 0000000000..8266de998a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminNotesListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Note } from "./Note" + +export interface AdminNotesListRes { + notes: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminNotesRes.ts b/packages/generated/client-types/src/lib/models/AdminNotesRes.ts new file mode 100644 index 0000000000..5f9340b04c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminNotesRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Note } from "./Note" + +export interface AdminNotesRes { + note: Note +} diff --git a/packages/generated/client-types/src/lib/models/AdminNotificationsListRes.ts b/packages/generated/client-types/src/lib/models/AdminNotificationsListRes.ts new file mode 100644 index 0000000000..4f045be97f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminNotificationsListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Notification } from "./Notification" + +export interface AdminNotificationsListRes { + notifications: Array> +} diff --git a/packages/generated/client-types/src/lib/models/AdminNotificationsRes.ts b/packages/generated/client-types/src/lib/models/AdminNotificationsRes.ts new file mode 100644 index 0000000000..98dd0662c3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminNotificationsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Notification } from "./Notification" + +export interface AdminNotificationsRes { + notification: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrderEditDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminOrderEditDeleteRes.ts new file mode 100644 index 0000000000..db17213ce7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrderEditDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminOrderEditDeleteRes { + /** + * The ID of the deleted Order Edit. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Order Edit was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrderEditItemChangeDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminOrderEditItemChangeDeleteRes.ts new file mode 100644 index 0000000000..68f1ea808c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrderEditItemChangeDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminOrderEditItemChangeDeleteRes { + /** + * The ID of the deleted Order Edit Item Change. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Order Edit Item Change was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrderEditsListRes.ts b/packages/generated/client-types/src/lib/models/AdminOrderEditsListRes.ts new file mode 100644 index 0000000000..63ae56cc53 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrderEditsListRes.ts @@ -0,0 +1,68 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" +import type { OrderEdit } from "./OrderEdit" +import type { OrderItemChange } from "./OrderItemChange" + +export interface AdminOrderEditsListRes { + order_edits: Array< + Merge< + SetRelation< + OrderEdit, + | "changes" + | "items" + | "payment_collection" + | "difference_due" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + >, + { + changes: Array< + Merge< + SetRelation, + { + line_item: SetRelation + original_line_item: SetRelation + } + > + > + items: Array< + SetRelation< + LineItem, + | "adjustments" + | "tax_lines" + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + > + > + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrderEditsRes.ts b/packages/generated/client-types/src/lib/models/AdminOrderEditsRes.ts new file mode 100644 index 0000000000..67b0ab9912 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrderEditsRes.ts @@ -0,0 +1,54 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" +import type { OrderEdit } from "./OrderEdit" +import type { OrderItemChange } from "./OrderItemChange" + +export interface AdminOrderEditsRes { + order_edit: Merge< + SetRelation< + OrderEdit, + | "changes" + | "items" + | "payment_collection" + | "difference_due" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + >, + { + changes: Array< + Merge< + SetRelation, + { + line_item: SetRelation + original_line_item: SetRelation + } + > + > + items: Array< + SetRelation< + LineItem, + | "adjustments" + | "tax_lines" + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + > + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrdersListRes.ts b/packages/generated/client-types/src/lib/models/AdminOrdersListRes.ts new file mode 100644 index 0000000000..e48039db3b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrdersListRes.ts @@ -0,0 +1,172 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimItem } from "./ClaimItem" +import type { ClaimOrder } from "./ClaimOrder" +import type { Discount } from "./Discount" +import type { Fulfillment } from "./Fulfillment" +import type { GiftCardTransaction } from "./GiftCardTransaction" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" +import type { Return } from "./Return" +import type { ReturnItem } from "./ReturnItem" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +export interface AdminOrdersListRes { + orders: Array< + Merge< + SetRelation< + Order, + | "billing_address" + | "claims" + | "customer" + | "discounts" + | "fulfillments" + | "gift_card_transactions" + | "gift_cards" + | "items" + | "payments" + | "refunds" + | "region" + | "returns" + | "shipping_address" + | "shipping_methods" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "paid_total" + | "refundable_amount" + | "refunded_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + | "swaps" + >, + { + claims: Array< + Merge< + SetRelation< + ClaimOrder, + | "additional_items" + | "claim_items" + | "fulfillments" + | "return_order" + | "shipping_address" + | "shipping_methods" + >, + { + additional_items: Array< + SetRelation< + LineItem, + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + claim_items: Array> + fulfillments: Array> + return_order: Merge< + SetRelation, + { + shipping_method: SetRelation + } + > + } + > + > + discounts: Array> + fulfillments: Array< + SetRelation + > + gift_card_transactions: Array< + SetRelation + > + items: Array< + Merge< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + | "variant" + >, + { + variant: SetRelation + } + > + > + region: SetRelation< + Region, + "fulfillment_providers" | "payment_providers" + > + returns: Array< + Merge< + SetRelation, + { + items: Array> + shipping_method: SetRelation + } + > + > + shipping_methods: Array< + SetRelation + > + swaps: Array< + Merge< + SetRelation, + { + additional_items: Array< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + } + > + > + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrdersOrderLineItemReservationReq.ts b/packages/generated/client-types/src/lib/models/AdminOrdersOrderLineItemReservationReq.ts new file mode 100644 index 0000000000..ae709f7d82 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrdersOrderLineItemReservationReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminOrdersOrderLineItemReservationReq { + /** + * The id of the location of the reservation + */ + location_id: string + /** + * The quantity to reserve + */ + quantity?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminOrdersRes.ts b/packages/generated/client-types/src/lib/models/AdminOrdersRes.ts new file mode 100644 index 0000000000..95af1c0bcb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminOrdersRes.ts @@ -0,0 +1,153 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimItem } from "./ClaimItem" +import type { ClaimOrder } from "./ClaimOrder" +import type { Discount } from "./Discount" +import type { Fulfillment } from "./Fulfillment" +import type { GiftCardTransaction } from "./GiftCardTransaction" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" +import type { Return } from "./Return" +import type { ReturnItem } from "./ReturnItem" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +export interface AdminOrdersRes { + order: Merge< + SetRelation< + Order, + | "billing_address" + | "claims" + | "customer" + | "discounts" + | "fulfillments" + | "gift_card_transactions" + | "gift_cards" + | "items" + | "payments" + | "refunds" + | "region" + | "returns" + | "shipping_address" + | "shipping_methods" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "paid_total" + | "refundable_amount" + | "refunded_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + | "swaps" + >, + { + claims: Array< + Merge< + SetRelation< + ClaimOrder, + | "additional_items" + | "claim_items" + | "fulfillments" + | "return_order" + | "shipping_address" + | "shipping_methods" + >, + { + additional_items: Array< + SetRelation< + LineItem, + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + claim_items: Array> + fulfillments: Array> + return_order: Merge< + SetRelation, + { + shipping_method: SetRelation + } + > + } + > + > + discounts: Array> + fulfillments: Array> + gift_card_transactions: Array< + SetRelation + > + items: Array< + Merge< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + | "variant" + >, + { + variant: SetRelation + } + > + > + region: SetRelation + returns: Array< + Merge< + SetRelation, + { + items: Array> + shipping_method: SetRelation + } + > + > + shipping_methods: Array< + SetRelation + > + swaps: Array< + Merge< + SetRelation, + { + additional_items: Array< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + } + > + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminPaymentCollectionDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminPaymentCollectionDeleteRes.ts new file mode 100644 index 0000000000..4235f5c016 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPaymentCollectionDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPaymentCollectionDeleteRes { + /** + * The ID of the deleted Payment Collection. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Payment Collection was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts b/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts new file mode 100644 index 0000000000..e958305dd3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PaymentCollection } from "./PaymentCollection" +import type { Region } from "./Region" + +export interface AdminPaymentCollectionsRes { + payment_collection: Merge< + SetRelation, + { + region: SetRelation + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminPaymentProvidersList.ts b/packages/generated/client-types/src/lib/models/AdminPaymentProvidersList.ts new file mode 100644 index 0000000000..579ed3cfae --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPaymentProvidersList.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PaymentProvider } from "./PaymentProvider" + +export interface AdminPaymentProvidersList { + payment_providers: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPaymentRes.ts b/packages/generated/client-types/src/lib/models/AdminPaymentRes.ts new file mode 100644 index 0000000000..8108bc4365 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPaymentRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Payment } from "./Payment" + +export interface AdminPaymentRes { + payment: Payment +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostAppsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostAppsReq.ts new file mode 100644 index 0000000000..30a1753831 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostAppsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostAppsReq { + /** + * Name of the application for the token to be generated for. + */ + application_name: string + /** + * State of the application. + */ + state: string + /** + * The code for the generated token. + */ + code: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts b/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts new file mode 100644 index 0000000000..236f078c1f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostAuthReq { + /** + * The User's email. + */ + email: string + /** + * The User's password. + */ + password: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts new file mode 100644 index 0000000000..c4ca690185 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostBatchesReq { + /** + * The type of batch job to start. + */ + type: string + /** + * Additional infomration regarding the batch to be used for processing. + */ + context: Record + /** + * Set a batch job in dry_run mode to get some information on what will be done without applying any modifications. + */ + dry_run?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts new file mode 100644 index 0000000000..dcb88e6f74 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCollectionsCollectionReq { + /** + * The title to identify the Collection by. + */ + title?: string + /** + * An optional handle to be used in slugs, if none is provided we will kebab-case the title. + */ + handle?: string + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts new file mode 100644 index 0000000000..d72d5e1c87 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCollectionsReq { + /** + * The title to identify the Collection by. + */ + title: string + /** + * An optional handle to be used in slugs, if none is provided we will kebab-case the title. + */ + handle?: string + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts new file mode 100644 index 0000000000..5cce163d95 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCurrenciesCurrencyReq { + /** + * [EXPERIMENTAL] Tax included in prices of currency. + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts new file mode 100644 index 0000000000..156b348634 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCustomerGroupsGroupCustomersBatchReq { + /** + * The ids of the customers to add + */ + customer_ids: Array<{ + /** + * ID of the customer + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts new file mode 100644 index 0000000000..c82f91792d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCustomerGroupsGroupReq { + /** + * Name of the customer group + */ + name?: string + /** + * Metadata for the customer. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts new file mode 100644 index 0000000000..57ad452d1a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCustomerGroupsReq { + /** + * Name of the customer group + */ + name: string + /** + * Metadata for the customer. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts new file mode 100644 index 0000000000..33706bf5f1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts @@ -0,0 +1,40 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCustomersCustomerReq { + /** + * The Customer's email. + */ + email?: string + /** + * The Customer's first name. + */ + first_name?: string + /** + * The Customer's last name. + */ + last_name?: string + /** + * The Customer's phone number. + */ + phone?: string + /** + * The Customer's password. + */ + password?: string + /** + * A list of customer groups to which the customer belongs. + */ + groups?: Array<{ + /** + * The ID of a customer group + */ + id: string + }> + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts new file mode 100644 index 0000000000..eb63fd55ea --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostCustomersReq { + /** + * The customer's email. + */ + email: string + /** + * The customer's first name. + */ + first_name: string + /** + * The customer's last name. + */ + last_name: string + /** + * The customer's password. + */ + password: string + /** + * The customer's phone number. + */ + phone?: string + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditions.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditions.ts new file mode 100644 index 0000000000..a1a55cdcdd --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditions.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountConditions { + /** + * Operator of the condition + */ + operator: "in" | "not_in" + /** + * list of product IDs if the condition is applied on products. + */ + products?: Array + /** + * list of product type IDs if the condition is applied on product types. + */ + product_types?: Array + /** + * list of product collection IDs if the condition is applied on product collections. + */ + product_collections?: Array + /** + * list of product tag IDs if the condition is applied on product tags. + */ + product_tags?: Array + /** + * list of customer group IDs if the condition is applied on customer groups. + */ + customer_groups?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsCondition.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsCondition.ts new file mode 100644 index 0000000000..2cb0eb0861 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsCondition.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountConditionsCondition { + /** + * list of product IDs if the condition is applied on products. + */ + products?: Array + /** + * list of product type IDs if the condition is applied on product types. + */ + product_types?: Array + /** + * list of product collection IDs if the condition is applied on product collections. + */ + product_collections?: Array + /** + * list of product tag IDs if the condition is applied on product tags. + */ + product_tags?: Array + /** + * list of customer group IDs if the condition is applied on customer groups. + */ + customer_groups?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchParams.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchParams.ts new file mode 100644 index 0000000000..ca2f266413 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountConditionsConditionBatchParams { + /** + * (Comma separated) Which relations should be expanded in each discount of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each discount of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts new file mode 100644 index 0000000000..06f1ad97f6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountConditionsConditionBatchReq { + /** + * The resources to be added to the discount condition + */ + resources: Array<{ + /** + * The id of the item + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionParams.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionParams.ts new file mode 100644 index 0000000000..f2d903588f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountConditionsConditionParams { + /** + * (Comma separated) Which fields should be expanded in each item of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each item of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsParams.ts new file mode 100644 index 0000000000..3993b90062 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountConditionsParams { + /** + * (Comma separated) Which fields should be expanded in each product of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each product of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts new file mode 100644 index 0000000000..0ba8640b2d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountDynamicCodesReq { + /** + * A unique code that will be used to redeem the Discount + */ + code: string + /** + * Maximum times the discount can be used + */ + usage_limit?: number + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountParams.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountParams.ts new file mode 100644 index 0000000000..65f67d43c2 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountParams { + /** + * (Comma separated) Which fields should be expanded in each item of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each item of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts new file mode 100644 index 0000000000..77ef1554ac --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts @@ -0,0 +1,93 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsDiscountReq { + /** + * A unique code that will be used to redeem the Discount + */ + code?: string + /** + * The Discount Rule that defines how Discounts are calculated + */ + rule?: { + /** + * The ID of the Rule + */ + id: string + /** + * A short description of the discount + */ + description?: string + /** + * The value that the discount represents; this will depend on the type of the discount + */ + value?: number + /** + * The scope that the discount should apply to. + */ + allocation?: "total" | "item" + /** + * A set of conditions that can be used to limit when the discount can be used. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided. + */ + conditions?: Array<{ + /** + * The ID of the Rule + */ + id?: string + /** + * Operator of the condition + */ + operator: "in" | "not_in" + /** + * list of product IDs if the condition is applied on products. + */ + products?: Array + /** + * list of product type IDs if the condition is applied on product types. + */ + product_types?: Array + /** + * list of product collection IDs if the condition is applied on product collections. + */ + product_collections?: Array + /** + * list of product tag IDs if the condition is applied on product tags. + */ + product_tags?: Array + /** + * list of customer group IDs if the condition is applied on customer groups. + */ + customer_groups?: Array + }> + } + /** + * Whether the Discount code is disabled on creation. You will have to enable it later to make it available to Customers. + */ + is_disabled?: boolean + /** + * The time at which the Discount should be available. + */ + starts_at?: string + /** + * The time at which the Discount should no longer be available. + */ + ends_at?: string + /** + * Duration the discount runs between + */ + valid_duration?: string + /** + * Maximum times the discount can be used + */ + usage_limit?: number + /** + * A list of Region ids representing the Regions in which the Discount can be used. + */ + regions?: Array + /** + * An object containing metadata of the discount + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsParams.ts new file mode 100644 index 0000000000..b75dd298e7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsParams { + /** + * (Comma separated) Which fields should be expanded in the results. + */ + expand?: string + /** + * (Comma separated) Which fields should be retrieved in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts new file mode 100644 index 0000000000..255b940d4d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts @@ -0,0 +1,93 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDiscountsReq { + /** + * A unique code that will be used to redeem the Discount + */ + code: string + /** + * Whether the Discount should have multiple instances of itself, each with a different code. This can be useful for automatically generated codes that all have to follow a common set of rules. + */ + is_dynamic?: boolean + /** + * The Discount Rule that defines how Discounts are calculated + */ + rule: { + /** + * A short description of the discount + */ + description?: string + /** + * The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers. + */ + type: "fixed" | "percentage" | "free_shipping" + /** + * The value that the discount represents; this will depend on the type of the discount + */ + value: number + /** + * The scope that the discount should apply to. + */ + allocation: "total" | "item" + /** + * A set of conditions that can be used to limit when the discount can be used. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided. + */ + conditions?: Array<{ + /** + * Operator of the condition + */ + operator: "in" | "not_in" + /** + * list of product IDs if the condition is applied on products. + */ + products?: Array + /** + * list of product type IDs if the condition is applied on product types. + */ + product_types?: Array + /** + * list of product collection IDs if the condition is applied on product collections. + */ + product_collections?: Array + /** + * list of product tag IDs if the condition is applied on product tags. + */ + product_tags?: Array + /** + * list of customer group IDs if the condition is applied on customer groups. + */ + customer_groups?: Array + }> + } + /** + * Whether the Discount code is disabled on creation. You will have to enable it later to make it available to Customers. + */ + is_disabled?: boolean + /** + * The time at which the Discount should be available. + */ + starts_at?: string + /** + * The time at which the Discount should no longer be available. + */ + ends_at?: string + /** + * Duration the discount runs between + */ + valid_duration?: string + /** + * A list of Region ids representing the Regions in which the Discount can be used. + */ + regions: Array + /** + * Maximum times the discount can be used + */ + usage_limit?: number + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts new file mode 100644 index 0000000000..4f787328ab --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDraftOrdersDraftOrderLineItemsItemReq { + /** + * The potential custom price of the item. + */ + unit_price?: number + /** + * The potential custom title of the item. + */ + title?: string + /** + * The quantity of the Line Item. + */ + quantity?: number + /** + * The optional key-value map with additional details about the Line Item. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts new file mode 100644 index 0000000000..4cbbf062de --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostDraftOrdersDraftOrderLineItemsReq { + /** + * The ID of the Product Variant to generate the Line Item from. + */ + variant_id?: string + /** + * The potential custom price of the item. + */ + unit_price?: number + /** + * The potential custom title of the item. + */ + title?: string + /** + * The quantity of the Line Item. + */ + quantity: number + /** + * The optional key-value map with additional details about the Line Item. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.ts new file mode 100644 index 0000000000..e9d714eb59 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Order } from "./Order" + +export interface AdminPostDraftOrdersDraftOrderRegisterPaymentRes { + order: Order +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts new file mode 100644 index 0000000000..047869bf63 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts @@ -0,0 +1,46 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" + +export interface AdminPostDraftOrdersDraftOrderReq { + /** + * The ID of the Region to create the Draft Order in. + */ + region_id?: string + /** + * The 2 character ISO code for the Country. + */ + country_code?: string + /** + * An email to be used on the Draft Order. + */ + email?: string + /** + * The Address to be used for billing purposes. + */ + billing_address?: AddressPayload | string + /** + * The Address to be used for shipping. + */ + shipping_address?: AddressPayload | string + /** + * An array of Discount codes to add to the Draft Order. + */ + discounts?: Array<{ + /** + * The code that a Discount is identifed by. + */ + code: string + }> + /** + * An optional flag passed to the resulting order to determine use of notifications. + */ + no_notification_order?: boolean + /** + * The ID of the Customer to associate the Draft Order with. + */ + customer_id?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts new file mode 100644 index 0000000000..3c2d54deaf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts @@ -0,0 +1,92 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" + +export interface AdminPostDraftOrdersReq { + /** + * The status of the draft order + */ + status?: "open" | "completed" + /** + * The email of the customer of the draft order + */ + email: string + /** + * The Address to be used for billing purposes. + */ + billing_address?: AddressPayload | string + /** + * The Address to be used for shipping. + */ + shipping_address?: AddressPayload | string + /** + * The Line Items that have been received. + */ + items?: Array<{ + /** + * The ID of the Product Variant to generate the Line Item from. + */ + variant_id?: string + /** + * The potential custom price of the item. + */ + unit_price?: number + /** + * The potential custom title of the item. + */ + title?: string + /** + * The quantity of the Line Item. + */ + quantity: number + /** + * The optional key-value map with additional details about the Line Item. + */ + metadata?: Record + }> + /** + * The ID of the region for the draft order + */ + region_id: string + /** + * The discounts to add on the draft order + */ + discounts?: Array<{ + /** + * The code of the discount to apply + */ + code: string + }> + /** + * The ID of the customer to add on the draft order + */ + customer_id?: string + /** + * An optional flag passed to the resulting order to determine use of notifications. + */ + no_notification_order?: boolean + /** + * The shipping methods for the draft order + */ + shipping_methods: Array<{ + /** + * The ID of the shipping option in use + */ + option_id: string + /** + * The optional additional data needed for the shipping method + */ + data?: Record + /** + * The potential custom price of the shipping + */ + price?: number + }> + /** + * The optional key-value map with additional details about the Draft Order. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts new file mode 100644 index 0000000000..66acf91061 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostGiftCardsGiftCardReq { + /** + * The value (excluding VAT) that the Gift Card should represent. + */ + balance?: number + /** + * Whether the Gift Card is disabled on creation. You will have to enable it later to make it available to Customers. + */ + is_disabled?: boolean + /** + * The time at which the Gift Card should no longer be available. + */ + ends_at?: string + /** + * The ID of the Region in which the Gift Card can be used. + */ + region_id?: string + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts new file mode 100644 index 0000000000..ffb6ad6ee5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostGiftCardsReq { + /** + * The value (excluding VAT) that the Gift Card should represent. + */ + value?: number + /** + * Whether the Gift Card is disabled on creation. You will have to enable it later to make it available to Customers. + */ + is_disabled?: boolean + /** + * The time at which the Gift Card should no longer be available. + */ + ends_at?: string + /** + * The ID of the Region in which the Gift Card can be used. + */ + region_id: string + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsInventoryItemParams.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsInventoryItemParams.ts new file mode 100644 index 0000000000..ecb7b99d42 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsInventoryItemParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsInventoryItemParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsInventoryItemReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsInventoryItemReq.ts new file mode 100644 index 0000000000..db9248d414 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsInventoryItemReq.ts @@ -0,0 +1,43 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsInventoryItemReq { + /** + * The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + hs_code?: string + /** + * The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + origin_country?: string + /** + * The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + mid_code?: string + /** + * The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + material?: string + /** + * The weight of the Inventory Item. May be used in shipping rate calculations. + */ + weight?: number + /** + * The height of the Inventory Item. May be used in shipping rate calculations. + */ + height?: number + /** + * The width of the Inventory Item. May be used in shipping rate calculations. + */ + width?: number + /** + * The length of the Inventory Item. May be used in shipping rate calculations. + */ + length?: number + /** + * Whether the item requires shipping. + */ + requires_shipping?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsLevelParams.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsLevelParams.ts new file mode 100644 index 0000000000..65d834b8af --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsLevelParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsItemLocationLevelsLevelParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsLevelReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsLevelReq.ts new file mode 100644 index 0000000000..25a623936f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsLevelReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsItemLocationLevelsLevelReq { + /** + * the total stock quantity of an inventory item at the given location ID + */ + stocked_quantity?: number + /** + * the incoming stock quantity of an inventory item at the given location ID + */ + incoming_quantity?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsParams.ts new file mode 100644 index 0000000000..136b724c61 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsItemLocationLevelsParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts new file mode 100644 index 0000000000..ecd59f931c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsItemLocationLevelsReq { + /** + * the item location ID + */ + location_id: string + /** + * the stock quantity of an inventory item at the given location ID + */ + stocked_quantity: number + /** + * the incoming stock quantity of an inventory item at the given location ID + */ + incoming_quantity?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsParams.ts new file mode 100644 index 0000000000..e3c39151c1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts new file mode 100644 index 0000000000..5b295b4ba7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts @@ -0,0 +1,71 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInventoryItemsReq { + /** + * The unique SKU for the Product Variant. + */ + sku?: string + /** + * The EAN number of the item. + */ + ean?: string + /** + * The UPC number of the item. + */ + upc?: string + /** + * A generic GTIN field for the Product Variant. + */ + barcode?: string + /** + * The Harmonized System code for the Product Variant. + */ + hs_code?: string + /** + * The amount of stock kept for the Product Variant. + */ + inventory_quantity?: number + /** + * Whether the Product Variant can be purchased when out of stock. + */ + allow_backorder?: boolean + /** + * Whether Medusa should keep track of the inventory for this Product Variant. + */ + manage_inventory?: boolean + /** + * The wieght of the Product Variant. + */ + weight?: number + /** + * The length of the Product Variant. + */ + length?: number + /** + * The height of the Product Variant. + */ + height?: number + /** + * The width of the Product Variant. + */ + width?: number + /** + * The country of origin of the Product Variant. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product Variant. + */ + mid_code?: string + /** + * The material composition of the Product Variant. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInvitesInviteAcceptReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInvitesInviteAcceptReq.ts new file mode 100644 index 0000000000..4356d7c388 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInvitesInviteAcceptReq.ts @@ -0,0 +1,28 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInvitesInviteAcceptReq { + /** + * The invite token provided by the admin. + */ + token: string + /** + * The User to create. + */ + user: { + /** + * the first name of the User + */ + first_name: string + /** + * the last name of the User + */ + last_name: string + /** + * The desired password for the User + */ + password: string + } +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostInvitesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostInvitesReq.ts new file mode 100644 index 0000000000..0603931677 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostInvitesReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostInvitesReq { + /** + * The email for the user to be created. + */ + user: string + /** + * The role of the user to be created. + */ + role: "admin" | "member" | "developer" +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts b/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts new file mode 100644 index 0000000000..a10eaddfa5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostNotesNoteReq { + /** + * The updated description of the Note. + */ + value: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts new file mode 100644 index 0000000000..4f28baaf39 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostNotesReq { + /** + * The ID of the resource which the Note relates to. + */ + resource_id: string + /** + * The type of resource which the Note relates to. + */ + resource_type: string + /** + * The content of the Note to create. + */ + value: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts b/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts new file mode 100644 index 0000000000..46957337e9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostNotificationsNotificationResendReq { + /** + * A new address or user identifier that the Notification should be sent to + */ + to?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts new file mode 100644 index 0000000000..df10e55219 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrderEditsEditLineItemsLineItemReq { + /** + * The quantity to update + */ + quantity: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts new file mode 100644 index 0000000000..042bd1fe45 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrderEditsEditLineItemsReq { + /** + * The ID of the variant ID to add + */ + variant_id: string + /** + * The quantity to add + */ + quantity: number + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts new file mode 100644 index 0000000000..e81439f090 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrderEditsOrderEditReq { + /** + * An optional note to create or update for the order edit. + */ + internal_note?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts new file mode 100644 index 0000000000..57d3c93cdf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrderEditsReq { + /** + * The ID of the order to create the edit for. + */ + order_id: string + /** + * An optional note to create for the order edit. + */ + internal_note?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.ts new file mode 100644 index 0000000000..e166049775 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderClaimsClaimFulfillmentsReq { + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record + /** + * If set to true no notification will be send related to this Claim. + */ + no_notification?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimReq.ts new file mode 100644 index 0000000000..1020824e90 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimReq.ts @@ -0,0 +1,91 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderClaimsClaimReq { + /** + * The Claim Items that the Claim will consist of. + */ + claim_items?: Array<{ + /** + * The ID of the Claim Item. + */ + id: string + /** + * The ID of the Line Item that will be claimed. + */ + item_id?: string + /** + * The number of items that will be returned + */ + quantity?: number + /** + * Short text describing the Claim Item in further detail. + */ + note?: string + /** + * The reason for the Claim + */ + reason?: "missing_item" | "wrong_item" | "production_failure" | "other" + /** + * A list o tags to add to the Claim Item + */ + tags: Array<{ + /** + * Tag ID + */ + id?: string + /** + * Tag value + */ + value?: string + }> + /** + * A list of image URL's that will be associated with the Claim + */ + images: Array<{ + /** + * Image ID + */ + id?: string + /** + * Image URL + */ + url?: string + }> + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record + }> + /** + * The Shipping Methods to send the additional Line Items with. + */ + shipping_methods?: Array<{ + /** + * The ID of an existing Shipping Method + */ + id?: string + /** + * The ID of the Shipping Option to create a Shipping Method from + */ + option_id?: string + /** + * The price to charge for the Shipping Method + */ + price?: number + /** + * An optional set of key-value pairs to hold additional information. + */ + data?: Record + }> + /** + * If set to true no notification will be send related to this Swap. + */ + no_notification?: boolean + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimShipmentsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimShipmentsReq.ts new file mode 100644 index 0000000000..e057408585 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsClaimShipmentsReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderClaimsClaimShipmentsReq { + /** + * The ID of the Fulfillment. + */ + fulfillment_id: string + /** + * The tracking numbers for the shipment. + */ + tracking_numbers?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsReq.ts new file mode 100644 index 0000000000..49a1018bb8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderClaimsReq.ts @@ -0,0 +1,105 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" + +export interface AdminPostOrdersOrderClaimsReq { + /** + * The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items. + */ + type: "replace" | "refund" + /** + * The Claim Items that the Claim will consist of. + */ + claim_items: Array<{ + /** + * The ID of the Line Item that will be claimed. + */ + item_id: string + /** + * The number of items that will be returned + */ + quantity: number + /** + * Short text describing the Claim Item in further detail. + */ + note?: string + /** + * The reason for the Claim + */ + reason?: "missing_item" | "wrong_item" | "production_failure" | "other" + /** + * A list o tags to add to the Claim Item + */ + tags?: Array + /** + * A list of image URL's that will be associated with the Claim + */ + images?: any + }> + /** + * Optional details for the Return Shipping Method, if the items are to be sent back. + */ + return_shipping?: { + /** + * The ID of the Shipping Option to create the Shipping Method from. + */ + option_id?: string + /** + * The price to charge for the Shipping Method. + */ + price?: number + } + /** + * The new items to send to the Customer when the Claim type is Replace. + */ + additional_items?: Array<{ + /** + * The ID of the Product Variant to ship. + */ + variant_id: string + /** + * The quantity of the Product Variant to ship. + */ + quantity: number + }> + /** + * The Shipping Methods to send the additional Line Items with. + */ + shipping_methods?: Array<{ + /** + * The ID of an existing Shipping Method + */ + id?: string + /** + * The ID of the Shipping Option to create a Shipping Method from + */ + option_id?: string + /** + * The price to charge for the Shipping Method + */ + price?: number + /** + * An optional set of key-value pairs to hold additional information. + */ + data?: Record + }> + /** + * An optional shipping address to send the claim to. Defaults to the parent order's shipping address + */ + shipping_address?: AddressPayload + /** + * The amount to refund the Customer when the Claim type is `refund`. + */ + refund_amount?: number + /** + * If set to true no notification will be send related to this Claim. + */ + no_notification?: boolean + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderFulfillmentsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderFulfillmentsReq.ts new file mode 100644 index 0000000000..ab50f692c7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderFulfillmentsReq.ts @@ -0,0 +1,28 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderFulfillmentsReq { + /** + * The Line Items to include in the Fulfillment. + */ + items: Array<{ + /** + * The ID of Line Item to fulfill. + */ + item_id: string + /** + * The quantity of the Line Item to fulfill. + */ + quantity: number + }> + /** + * If set to true no notification will be send related to this Swap. + */ + no_notification?: boolean + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts new file mode 100644 index 0000000000..772f4c2107 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderRefundsReq { + /** + * The amount to refund. + */ + amount: number + /** + * The reason for the Refund. + */ + reason: string + /** + * A note with additional details about the Refund. + */ + note?: string + /** + * If set to true no notification will be send related to this Refund. + */ + no_notification?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts new file mode 100644 index 0000000000..6028d0e56e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts @@ -0,0 +1,81 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" +import type { Discount } from "./Discount" +import type { LineItem } from "./LineItem" + +export interface AdminPostOrdersOrderReq { + /** + * the email for the order + */ + email?: string + /** + * Billing address + */ + billing_address?: AddressPayload + /** + * Shipping address + */ + shipping_address?: AddressPayload + /** + * The Line Items for the order + */ + items?: Array + /** + * ID of the region where the order belongs + */ + region?: string + /** + * Discounts applied to the order + */ + discounts?: Array + /** + * ID of the customer + */ + customer_id?: string + /** + * payment method chosen for the order + */ + payment_method?: { + /** + * ID of the payment provider + */ + provider_id?: string + /** + * Data relevant for the given payment method + */ + data?: Record + } + /** + * The Shipping Method used for shipping the order. + */ + shipping_method?: { + /** + * The ID of the shipping provider. + */ + provider_id?: string + /** + * The ID of the shipping profile. + */ + profile_id?: string + /** + * The price of the shipping. + */ + price?: number + /** + * Data relevant to the specific shipping method. + */ + data?: Record + /** + * Items to ship + */ + items?: Array + } + /** + * A flag to indicate if no notifications should be emitted related to the updated order. + */ + no_notification?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts new file mode 100644 index 0000000000..42e6dcc9d1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts @@ -0,0 +1,57 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderReturnsReq { + /** + * The Line Items that will be returned. + */ + items: Array<{ + /** + * The ID of the Line Item. + */ + item_id: string + /** + * The ID of the Return Reason to use. + */ + reason_id?: string + /** + * An optional note with information about the Return. + */ + note?: string + /** + * The quantity of the Line Item. + */ + quantity: number + }> + /** + * The Shipping Method to be used to handle the return shipment. + */ + return_shipping?: { + /** + * The ID of the Shipping Option to create the Shipping Method from. + */ + option_id?: string + /** + * The price to charge for the Shipping Method. + */ + price?: number + } + /** + * An optional note with information about the Return. + */ + note?: string + /** + * A flag to indicate if the Return should be registerd as received immediately. + */ + receive_now?: boolean + /** + * A flag to indicate if no notifications should be emitted related to the requested Return. + */ + no_notification?: boolean + /** + * The amount to refund. + */ + refund?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts new file mode 100644 index 0000000000..143f9b8327 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderShipmentReq { + /** + * The ID of the Fulfillment. + */ + fulfillment_id: string + /** + * The tracking numbers for the shipment. + */ + tracking_numbers?: Array + /** + * If set to true no notification will be send related to this Shipment. + */ + no_notification?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShippingMethodsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShippingMethodsReq.ts new file mode 100644 index 0000000000..694698ac16 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShippingMethodsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderShippingMethodsReq { + /** + * The price (excluding VAT) that should be charged for the Shipping Method + */ + price: number + /** + * The ID of the Shipping Option to create the Shipping Method from. + */ + option_id: string + /** + * The data required for the Shipping Option to create a Shipping Method. This will depend on the Fulfillment Provider. + */ + date?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsParams.ts new file mode 100644 index 0000000000..429473a62e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderSwapsParams { + /** + * (Comma separated) Which fields should be expanded the order of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included the order of the result. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts new file mode 100644 index 0000000000..635f93cf2e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts @@ -0,0 +1,75 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderSwapsReq { + /** + * The Line Items to return as part of the Swap. + */ + return_items: Array<{ + /** + * The ID of the Line Item that will be claimed. + */ + item_id: string + /** + * The number of items that will be returned + */ + quantity: number + /** + * The ID of the Return Reason to use. + */ + reason_id?: string + /** + * An optional note with information about the Return. + */ + note?: string + }> + /** + * How the Swap will be returned. + */ + return_shipping?: { + /** + * The ID of the Shipping Option to create the Shipping Method from. + */ + option_id: string + /** + * The price to charge for the Shipping Method. + */ + price?: number + } + /** + * The new items to send to the Customer. + */ + additional_items?: Array<{ + /** + * The ID of the Product Variant to ship. + */ + variant_id: string + /** + * The quantity of the Product Variant to ship. + */ + quantity: number + }> + /** + * The custom shipping options to potentially create a Shipping Method from. + */ + custom_shipping_options?: Array<{ + /** + * The ID of the Shipping Option to override with a custom price. + */ + option_id: string + /** + * The custom price of the Shipping Option. + */ + price: number + }> + /** + * If set to true no notification will be send related to this Swap. + */ + no_notification?: boolean + /** + * If true, swaps can be completed with items out of stock + */ + allow_backorder?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.ts new file mode 100644 index 0000000000..cfe29e4256 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderSwapsSwapFulfillmentsReq { + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record + /** + * If set to true no notification will be send related to this Claim. + */ + no_notification?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsSwapShipmentsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsSwapShipmentsReq.ts new file mode 100644 index 0000000000..b99649a149 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsSwapShipmentsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostOrdersOrderSwapsSwapShipmentsReq { + /** + * The ID of the Fulfillment. + */ + fulfillment_id: string + /** + * The tracking numbers for the shipment. + */ + tracking_numbers?: Array + /** + * If set to true no notification will be sent related to this Claim. + */ + no_notification?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts new file mode 100644 index 0000000000..95ae412c43 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPaymentRefundsReq { + /** + * The amount to refund. + */ + amount: number + /** + * The reason for the Refund. + */ + reason: string + /** + * A note with additional details about the Refund. + */ + note?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts new file mode 100644 index 0000000000..992f29028c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPriceListPricesPricesReq { + /** + * The prices to update or add. + */ + prices?: Array<{ + /** + * The ID of the price. + */ + id?: string + /** + * The ID of the Region for which the price is used. Only required if currecny_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The ID of the Variant for which the price is used. + */ + variant_id: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + /** + * If true the prices will replace all existing prices associated with the Price List. + */ + override?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts new file mode 100644 index 0000000000..5c34c7a5d0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts @@ -0,0 +1,77 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPriceListsPriceListPriceListReq { + /** + * The name of the Price List + */ + name?: string + /** + * A description of the Price List. + */ + description?: string + /** + * The date with timezone that the Price List starts being valid. + */ + starts_at?: string + /** + * The date with timezone that the Price List ends being valid. + */ + ends_at?: string + /** + * The type of the Price List. + */ + type?: "sale" | "override" + /** + * The status of the Price List. + */ + status?: "active" | "draft" + /** + * The prices of the Price List. + */ + prices?: Array<{ + /** + * The ID of the price. + */ + id?: string + /** + * The ID of the Region for which the price is used. Only required if currecny_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The ID of the Variant for which the price is used. + */ + variant_id: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + /** + * A list of customer groups that the Price List applies to. + */ + customer_groups?: Array<{ + /** + * The ID of a customer group + */ + id: string + }> + /** + * [EXPERIMENTAL] Tax included in prices of price list + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts new file mode 100644 index 0000000000..0d9b3854b9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts @@ -0,0 +1,73 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPriceListsPriceListReq { + /** + * The name of the Price List + */ + name: string + /** + * A description of the Price List. + */ + description: string + /** + * The date with timezone that the Price List starts being valid. + */ + starts_at?: string + /** + * The date with timezone that the Price List ends being valid. + */ + ends_at?: string + /** + * The type of the Price List. + */ + type: "sale" | "override" + /** + * The status of the Price List. + */ + status?: "active" | "draft" + /** + * The prices of the Price List. + */ + prices: Array<{ + /** + * The ID of the Region for which the price is used. Only required if currecny_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The ID of the Variant for which the price is used. + */ + variant_id: string + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + /** + * A list of customer groups that the Price List applies to. + */ + customer_groups?: Array<{ + /** + * The ID of a customer group + */ + id: string + }> + /** + * [EXPERIMENTAL] Tax included in prices of price list + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryParams.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryParams.ts new file mode 100644 index 0000000000..3ef1efa353 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductCategoriesCategoryParams { + /** + * (Comma separated) Which fields should be expanded in each product category. + */ + expand?: string + /** + * (Comma separated) Which fields should be retrieved in each product category. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchParams.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchParams.ts new file mode 100644 index 0000000000..2f761d2a59 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductCategoriesCategoryProductsBatchParams { + /** + * (Comma separated) Category fields to be expanded in the response. + */ + expand?: string + /** + * (Comma separated) Category fields to be retrieved in the response. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts new file mode 100644 index 0000000000..3397dcecef --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductCategoriesCategoryProductsBatchReq { + /** + * The IDs of the products to add to the Product Category + */ + product_ids: Array<{ + /** + * The ID of the product + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts new file mode 100644 index 0000000000..7fed5aa83e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductCategoriesCategoryReq { + /** + * The name to identify the Product Category by. + */ + name?: string + /** + * A handle to be used in slugs. + */ + handle?: string + /** + * A flag to make product category an internal category for admins + */ + is_internal?: boolean + /** + * A flag to make product category visible/hidden in the store front + */ + is_active?: boolean + /** + * The ID of the parent product category + */ + parent_category_id?: string + /** + * The rank of the category in the tree node (starting from 0) + */ + rank?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesParams.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesParams.ts new file mode 100644 index 0000000000..4e1c9ba9e9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductCategoriesParams { + /** + * (Comma separated) Which fields should be expanded in the results. + */ + expand?: string + /** + * (Comma separated) Which fields should be retrieved in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts new file mode 100644 index 0000000000..18a7040ed9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductCategoriesReq { + /** + * The name to identify the Product Category by. + */ + name: string + /** + * An optional handle to be used in slugs, if none is provided we will kebab-case the title. + */ + handle?: string + /** + * A flag to make product category an internal category for admins + */ + is_internal?: boolean + /** + * A flag to make product category visible/hidden in the store front + */ + is_active?: boolean + /** + * The ID of the parent product category + */ + parent_category_id?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductMetadataReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductMetadataReq.ts new file mode 100644 index 0000000000..c654fd9f65 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductMetadataReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsProductMetadataReq { + /** + * The metadata key + */ + key: string + /** + * The metadata value + */ + value: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsOption.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsOption.ts new file mode 100644 index 0000000000..b83740dc98 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsOption.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsProductOptionsOption { + /** + * The title of the Product Option + */ + title: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts new file mode 100644 index 0000000000..e878fa3cdb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsProductOptionsReq { + /** + * The title the Product Option will be identified by i.e. "Size" + */ + title: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts new file mode 100644 index 0000000000..e60e5f8908 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts @@ -0,0 +1,227 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsProductReq { + /** + * The title of the Product + */ + title?: string + /** + * The subtitle of the Product + */ + subtitle?: string + /** + * A description of the Product. + */ + description?: string + /** + * A flag to indicate if discounts can be applied to the LineItems generated from this Product + */ + discountable?: boolean + /** + * Images of the Product. + */ + images?: Array + /** + * The thumbnail to use for the Product. + */ + thumbnail?: string + /** + * A unique handle to identify the Product by. + */ + handle?: string + /** + * The status of the product. + */ + status?: "draft" | "proposed" | "published" | "rejected" + /** + * The Product Type to associate the Product with. + */ + type?: { + /** + * The ID of the Product Type. + */ + id?: string + /** + * The value of the Product Type. + */ + value: string + } + /** + * The ID of the Collection the Product should belong to. + */ + collection_id?: string + /** + * Tags to associate the Product with. + */ + tags?: Array<{ + /** + * The ID of an existing Tag. + */ + id?: string + /** + * The value of the Tag, these will be upserted. + */ + value: string + }> + /** + * [EXPERIMENTAL] Sales channels to associate the Product with. + */ + sales_channels?: Array<{ + /** + * The ID of an existing Sales channel. + */ + id: string + }> + /** + * Categories to add the Product to. + */ + categories?: Array + /** + * A list of Product Variants to create with the Product. + */ + variants?: Array<{ + /** + * The ID of the Product Variant. + */ + id?: string + /** + * The title to identify the Product Variant by. + */ + title?: string + /** + * The unique SKU for the Product Variant. + */ + sku?: string + /** + * The EAN number of the item. + */ + ean?: string + /** + * The UPC number of the item. + */ + upc?: string + /** + * A generic GTIN field for the Product Variant. + */ + barcode?: string + /** + * The Harmonized System code for the Product Variant. + */ + hs_code?: string + /** + * The amount of stock kept for the Product Variant. + */ + inventory_quantity?: number + /** + * Whether the Product Variant can be purchased when out of stock. + */ + allow_backorder?: boolean + /** + * Whether Medusa should keep track of the inventory for this Product Variant. + */ + manage_inventory?: boolean + /** + * The wieght of the Product Variant. + */ + weight?: number + /** + * The length of the Product Variant. + */ + length?: number + /** + * The height of the Product Variant. + */ + height?: number + /** + * The width of the Product Variant. + */ + width?: number + /** + * The country of origin of the Product Variant. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product Variant. + */ + mid_code?: string + /** + * The material composition of the Product Variant. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + prices?: Array<{ + /** + * The ID of the Price. + */ + id?: string + /** + * The ID of the Region for which the price is used. Only required if currency_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + options?: Array<{ + /** + * The ID of the Option. + */ + option_id: string + /** + * The value to give for the Product Option at the same index in the Product's `options` field. + */ + value: string + }> + }> + /** + * The wieght of the Product. + */ + weight?: number + /** + * The length of the Product. + */ + length?: number + /** + * The height of the Product. + */ + height?: number + /** + * The width of the Product. + */ + width?: number + /** + * The country of origin of the Product. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product. + */ + mid_code?: string + /** + * The material composition of the Product. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts new file mode 100644 index 0000000000..e46f5d7cb7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts @@ -0,0 +1,111 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsProductVariantsReq { + /** + * The title to identify the Product Variant by. + */ + title: string + /** + * The unique SKU for the Product Variant. + */ + sku?: string + /** + * The EAN number of the item. + */ + ean?: string + /** + * The UPC number of the item. + */ + upc?: string + /** + * A generic GTIN field for the Product Variant. + */ + barcode?: string + /** + * The Harmonized System code for the Product Variant. + */ + hs_code?: string + /** + * The amount of stock kept for the Product Variant. + */ + inventory_quantity?: number + /** + * Whether the Product Variant can be purchased when out of stock. + */ + allow_backorder?: boolean + /** + * Whether Medusa should keep track of the inventory for this Product Variant. + */ + manage_inventory?: boolean + /** + * The wieght of the Product Variant. + */ + weight?: number + /** + * The length of the Product Variant. + */ + length?: number + /** + * The height of the Product Variant. + */ + height?: number + /** + * The width of the Product Variant. + */ + width?: number + /** + * The country of origin of the Product Variant. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product Variant. + */ + mid_code?: string + /** + * The material composition of the Product Variant. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + prices: Array<{ + /** + * The ID of the price. + */ + id?: string + /** + * The ID of the Region for which the price is used. Only required if currency_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + options: Array<{ + /** + * The ID of the Product Option to set the value for. + */ + option_id: string + /** + * The value to give for the Product Option. + */ + value: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsVariantReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsVariantReq.ts new file mode 100644 index 0000000000..80bc3be359 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsVariantReq.ts @@ -0,0 +1,111 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsProductVariantsVariantReq { + /** + * The title to identify the Product Variant by. + */ + title?: string + /** + * The unique SKU for the Product Variant. + */ + sku?: string + /** + * The EAN number of the item. + */ + ean?: string + /** + * The UPC number of the item. + */ + upc?: string + /** + * A generic GTIN field for the Product Variant. + */ + barcode?: string + /** + * The Harmonized System code for the Product Variant. + */ + hs_code?: string + /** + * The amount of stock kept for the Product Variant. + */ + inventory_quantity?: number + /** + * Whether the Product Variant can be purchased when out of stock. + */ + allow_backorder?: boolean + /** + * Whether Medusa should keep track of the inventory for this Product Variant. + */ + manage_inventory?: boolean + /** + * The weight of the Product Variant. + */ + weight?: number + /** + * The length of the Product Variant. + */ + length?: number + /** + * The height of the Product Variant. + */ + height?: number + /** + * The width of the Product Variant. + */ + width?: number + /** + * The country of origin of the Product Variant. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product Variant. + */ + mid_code?: string + /** + * The material composition of the Product Variant. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + prices: Array<{ + /** + * The ID of the price. + */ + id?: string + /** + * The ID of the Region for which the price is used. Only required if currency_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + options?: Array<{ + /** + * The ID of the Product Option to set the value for. + */ + option_id: string + /** + * The value to give for the Product Option. + */ + value: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts new file mode 100644 index 0000000000..3a5bc1911d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts @@ -0,0 +1,232 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsReq { + /** + * The title of the Product + */ + title: string + /** + * The subtitle of the Product + */ + subtitle?: string + /** + * A description of the Product. + */ + description?: string + /** + * A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to `true` will result in a Gift Card being created. + */ + is_giftcard?: boolean + /** + * A flag to indicate if discounts can be applied to the LineItems generated from this Product + */ + discountable?: boolean + /** + * Images of the Product. + */ + images?: Array + /** + * The thumbnail to use for the Product. + */ + thumbnail?: string + /** + * A unique handle to identify the Product by. + */ + handle?: string + /** + * The status of the product. + */ + status?: "draft" | "proposed" | "published" | "rejected" + /** + * The Product Type to associate the Product with. + */ + type?: { + /** + * The ID of the Product Type. + */ + id?: string + /** + * The value of the Product Type. + */ + value: string + } + /** + * The ID of the Collection the Product should belong to. + */ + collection_id?: string + /** + * Tags to associate the Product with. + */ + tags?: Array<{ + /** + * The ID of an existing Tag. + */ + id?: string + /** + * The value of the Tag, these will be upserted. + */ + value: string + }> + /** + * [EXPERIMENTAL] Sales channels to associate the Product with. + */ + sales_channels?: Array<{ + /** + * The ID of an existing Sales channel. + */ + id: string + }> + /** + * Categories to add the Product to. + */ + categories?: Array + /** + * The Options that the Product should have. These define on which properties the Product's Product Variants will differ. + */ + options?: Array<{ + /** + * The title to identify the Product Option by. + */ + title: string + }> + /** + * A list of Product Variants to create with the Product. + */ + variants?: Array<{ + /** + * The title to identify the Product Variant by. + */ + title: string + /** + * The unique SKU for the Product Variant. + */ + sku?: string + /** + * The EAN number of the item. + */ + ean?: string + /** + * The UPC number of the item. + */ + upc?: string + /** + * A generic GTIN field for the Product Variant. + */ + barcode?: string + /** + * The Harmonized System code for the Product Variant. + */ + hs_code?: string + /** + * The amount of stock kept for the Product Variant. + */ + inventory_quantity?: number + /** + * Whether the Product Variant can be purchased when out of stock. + */ + allow_backorder?: boolean + /** + * Whether Medusa should keep track of the inventory for this Product Variant. + */ + manage_inventory?: boolean + /** + * The wieght of the Product Variant. + */ + weight?: number + /** + * The length of the Product Variant. + */ + length?: number + /** + * The height of the Product Variant. + */ + height?: number + /** + * The width of the Product Variant. + */ + width?: number + /** + * The country of origin of the Product Variant. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product Variant. + */ + mid_code?: string + /** + * The material composition of the Product Variant. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + prices?: Array<{ + /** + * The ID of the Region for which the price is used. Only required if currency_code is not provided. + */ + region_id?: string + /** + * The 3 character ISO currency code for which the price will be used. Only required if region_id is not provided. + */ + currency_code?: string + /** + * The amount to charge for the Product Variant. + */ + amount: number + /** + * The minimum quantity for which the price will be used. + */ + min_quantity?: number + /** + * The maximum quantity for which the price will be used. + */ + max_quantity?: number + }> + options?: Array<{ + /** + * The value to give for the Product Option at the same index in the Product's `options` field. + */ + value: string + }> + }> + /** + * The weight of the Product. + */ + weight?: number + /** + * The length of the Product. + */ + length?: number + /** + * The height of the Product. + */ + height?: number + /** + * The width of the Product. + */ + width?: number + /** + * The Harmonized System code for the Product Variant. + */ + hs_code?: string + /** + * The country of origin of the Product. + */ + origin_country?: string + /** + * The Manufacturer Identification code for the Product. + */ + mid_code?: string + /** + * The material composition of the Product. + */ + material?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts new file mode 100644 index 0000000000..3003612160 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostProductsToCollectionReq { + /** + * An array of Product IDs to add to the Product Collection. + */ + product_ids: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts new file mode 100644 index 0000000000..e3a97c02f9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPublishableApiKeySalesChannelsBatchReq { + /** + * The IDs of the sales channels to add to the publishable api key + */ + sales_channel_ids: Array<{ + /** + * The ID of the sales channel + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts new file mode 100644 index 0000000000..8e2f2924b1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPublishableApiKeysPublishableApiKeyReq { + /** + * A title to update for the key. + */ + title?: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts new file mode 100644 index 0000000000..74402363da --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostPublishableApiKeysReq { + /** + * A title for the publishable api key + */ + title: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts new file mode 100644 index 0000000000..adcfe4a254 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostRegionsRegionCountriesReq { + /** + * The 2 character ISO code for the Country. + */ + country_code: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts new file mode 100644 index 0000000000..02c6fe3704 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostRegionsRegionFulfillmentProvidersReq { + /** + * The ID of the Fulfillment Provider to add. + */ + provider_id: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts new file mode 100644 index 0000000000..d995ed78a3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostRegionsRegionPaymentProvidersReq { + /** + * The ID of the Payment Provider to add. + */ + provider_id: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts new file mode 100644 index 0000000000..1b3533e0b7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts @@ -0,0 +1,51 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostRegionsRegionReq { + /** + * The name of the Region + */ + name?: string + /** + * The 3 character ISO currency code to use for the Region. + */ + currency_code?: string + /** + * If true Medusa will automatically calculate taxes for carts in this region. If false you have to manually call POST /carts/:id/taxes. + */ + automatic_taxes?: boolean + /** + * Whether gift cards in this region should be applied sales tax when purchasing a gift card + */ + gift_cards_taxable?: boolean + /** + * The ID of the tax provider to use; if null the system tax provider is used + */ + tax_provider_id?: string + /** + * An optional tax code the Region. + */ + tax_code?: string + /** + * The tax rate to use on Orders in the Region. + */ + tax_rate?: number + /** + * [EXPERIMENTAL] Tax included in prices of region + */ + includes_tax?: boolean + /** + * A list of Payment Provider IDs that should be enabled for the Region + */ + payment_providers?: Array + /** + * A list of Fulfillment Provider IDs that should be enabled for the Region + */ + fulfillment_providers?: Array + /** + * A list of countries' 2 ISO Characters that should be included in the Region. + */ + countries?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts new file mode 100644 index 0000000000..abbd2e4a56 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts @@ -0,0 +1,39 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostRegionsReq { + /** + * The name of the Region + */ + name: string + /** + * The 3 character ISO currency code to use for the Region. + */ + currency_code: string + /** + * An optional tax code the Region. + */ + tax_code?: string + /** + * The tax rate to use on Orders in the Region. + */ + tax_rate: number + /** + * A list of Payment Provider IDs that should be enabled for the Region + */ + payment_providers: Array + /** + * A list of Fulfillment Provider IDs that should be enabled for the Region + */ + fulfillment_providers: Array + /** + * A list of countries' 2 ISO Characters that should be included in the Region. + */ + countries: Array + /** + * [EXPERIMENTAL] Tax included in prices of region + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts new file mode 100644 index 0000000000..15e7cf730b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostReservationsReq { + /** + * The id of the location of the reservation + */ + line_item_id?: string + /** + * The id of the location of the reservation + */ + location_id: string + /** + * The id of the inventory item the reservation relates to + */ + inventory_item_id: string + /** + * The id of the reservation item + */ + quantity: number + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts new file mode 100644 index 0000000000..a1f85d3360 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostReservationsReservationReq { + /** + * The id of the location of the reservation + */ + location_id?: string + /** + * The id of the reservation item + */ + quantity?: number + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts new file mode 100644 index 0000000000..3a99e53e62 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostReturnReasonsReasonReq { + /** + * The label to display to the Customer. + */ + label?: string + /** + * The value that the Return Reason will be identified by. Must be unique. + */ + value?: string + /** + * An optional description to for the Reason. + */ + description?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts new file mode 100644 index 0000000000..d90ff8dc7b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostReturnReasonsReq { + /** + * The label to display to the Customer. + */ + label: string + /** + * The value that the Return Reason will be identified by. Must be unique. + */ + value: string + /** + * The ID of the parent return reason. + */ + parent_return_reason_id?: string + /** + * An optional description to for the Reason. + */ + description?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts b/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts new file mode 100644 index 0000000000..78cdfb9b90 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts @@ -0,0 +1,24 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostReturnsReturnReceiveReq { + /** + * The Line Items that have been received. + */ + items: Array<{ + /** + * The ID of the Line Item. + */ + item_id: string + /** + * The quantity of the Line Item. + */ + quantity: number + }> + /** + * The amount to refund. + */ + refund?: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts new file mode 100644 index 0000000000..a20f0baf5a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostSalesChannelsChannelProductsBatchReq { + /** + * The IDs of the products to add to the Sales Channel + */ + product_ids: Array<{ + /** + * The ID of the product + */ + id: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelStockLocationsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelStockLocationsReq.ts new file mode 100644 index 0000000000..be6e24062f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelStockLocationsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostSalesChannelsChannelStockLocationsReq { + /** + * The ID of the stock location + */ + location_id: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts new file mode 100644 index 0000000000..12ea1138fa --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostSalesChannelsReq { + /** + * The name of the Sales Channel + */ + name: string + /** + * The description of the Sales Channel + */ + description?: string + /** + * Whether the Sales Channel is disabled or not. + */ + is_disabled?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts new file mode 100644 index 0000000000..ece48bfc8c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostSalesChannelsSalesChannelReq { + /** + * Name of the sales channel. + */ + name?: string + /** + * Sales Channel description. + */ + description?: string + /** + * Indication of if the sales channel is active. + */ + is_disabled?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts new file mode 100644 index 0000000000..7ec8f3d7f2 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostShippingOptionsOptionReq { + /** + * The name of the Shipping Option + */ + name?: string + /** + * The amount to charge for the Shipping Option. + */ + amount?: number + /** + * If true, the option can be used for draft orders + */ + admin_only?: boolean + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + /** + * The requirements that must be satisfied for the Shipping Option to be available. + */ + requirements: Array<{ + /** + * The ID of the requirement + */ + id?: string + /** + * The type of the requirement + */ + type: "max_subtotal" | "min_subtotal" + /** + * The amount to compare with. + */ + amount: number + }> + /** + * [EXPERIMENTAL] Tax included in prices of shipping option + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts new file mode 100644 index 0000000000..7c0820e127 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts @@ -0,0 +1,64 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostShippingOptionsReq { + /** + * The name of the Shipping Option + */ + name: string + /** + * The ID of the Region in which the Shipping Option will be available. + */ + region_id: string + /** + * The ID of the Fulfillment Provider that handles the Shipping Option. + */ + provider_id: string + /** + * The ID of the Shipping Profile to add the Shipping Option to. + */ + profile_id?: number + /** + * The data needed for the Fulfillment Provider to handle shipping with this Shipping Option. + */ + data: Record + /** + * The type of the Shipping Option price. + */ + price_type: "flat_rate" | "calculated" + /** + * The amount to charge for the Shipping Option. + */ + amount?: number + /** + * The requirements that must be satisfied for the Shipping Option to be available. + */ + requirements?: Array<{ + /** + * The type of the requirement + */ + type: "max_subtotal" | "min_subtotal" + /** + * The amount to compare with. + */ + amount: number + }> + /** + * Whether the Shipping Option defines a return shipment. + */ + is_return?: boolean + /** + * If true, the option can be used for draft orders + */ + admin_only?: boolean + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + /** + * [EXPERIMENTAL] Tax included in prices of shipping option + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts new file mode 100644 index 0000000000..b62599af6e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostShippingProfilesProfileReq { + /** + * The name of the Shipping Profile + */ + name?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record + /** + * The type of the Shipping Profile + */ + type?: "default" | "gift_card" | "custom" + /** + * An optional array of product ids to associate with the Shipping Profile + */ + products?: any[] + /** + * An optional array of shipping option ids to associate with the Shipping Profile + */ + shipping_options?: any[] +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts new file mode 100644 index 0000000000..da33d3173b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostShippingProfilesReq { + /** + * The name of the Shipping Profile + */ + name: string + /** + * The type of the Shipping Profile + */ + type: "default" | "gift_card" | "custom" +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts new file mode 100644 index 0000000000..93fc365b26 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationAddressInput } from "./StockLocationAddressInput" + +export interface AdminPostStockLocationsLocationReq { + /** + * the name of the stock location + */ + name?: string + /** + * the stock location address ID + */ + address_id?: string + /** + * An optional key-value map with additional details + */ + metadata?: Record + address?: StockLocationAddressInput +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts new file mode 100644 index 0000000000..69fb25caa6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationAddressInput } from "./StockLocationAddressInput" + +export interface AdminPostStockLocationsReq { + /** + * the name of the stock location + */ + name: string + /** + * the stock location address ID + */ + address_id?: string + /** + * An optional key-value map with additional details + */ + metadata?: Record + address?: StockLocationAddressInput +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts b/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts new file mode 100644 index 0000000000..5dac1fd606 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts @@ -0,0 +1,35 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostStoreReq { + /** + * The name of the Store + */ + name?: string + /** + * A template for Swap links - use `{{cart_id}}` to insert the Swap Cart id + */ + swap_link_template?: string + /** + * A template for payment links links - use `{{cart_id}}` to insert the Cart id + */ + payment_link_template?: string + /** + * A template for invite links - use `{{invite_token}}` to insert the invite token + */ + invite_link_template?: string + /** + * The default currency code for the Store. + */ + default_currency_code?: string + /** + * Array of currencies in 2 character ISO code format. + */ + currencies?: Array + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesParams.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesParams.ts new file mode 100644 index 0000000000..17609cb1a3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts new file mode 100644 index 0000000000..154e5e0a63 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts @@ -0,0 +1,35 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesReq { + /** + * A code to identify the tax type by + */ + code: string + /** + * A human friendly name for the tax + */ + name: string + /** + * The ID of the Region that the rate belongs to + */ + region_id: string + /** + * The numeric rate to charge + */ + rate?: number + /** + * The IDs of the products associated with this tax rate + */ + products?: Array + /** + * The IDs of the shipping options associated with this tax rate + */ + shipping_options?: Array + /** + * The IDs of the types of products associated with this tax rate + */ + product_types?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateParams.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateParams.ts new file mode 100644 index 0000000000..74ebc917a4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductTypesParams.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductTypesParams.ts new file mode 100644 index 0000000000..a5b959baa5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductTypesParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateProductTypesParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductTypesReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductTypesReq.ts new file mode 100644 index 0000000000..2f7a3b0654 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductTypesReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateProductTypesReq { + /** + * The IDs of the types of products to associate with this tax rate + */ + product_types: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsParams.ts new file mode 100644 index 0000000000..5eab00e425 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateProductsParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts new file mode 100644 index 0000000000..ed7bfb1677 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateProductsReq { + /** + * The IDs of the products to associate with this tax rate + */ + products: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts new file mode 100644 index 0000000000..5eb163b0ef --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts @@ -0,0 +1,35 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateReq { + /** + * A code to identify the tax type by + */ + code?: string + /** + * A human friendly name for the tax + */ + name?: string + /** + * The ID of the Region that the rate belongs to + */ + region_id?: string + /** + * The numeric rate to charge + */ + rate?: number + /** + * The IDs of the products associated with this tax rate + */ + products?: Array + /** + * The IDs of the shipping options associated with this tax rate + */ + shipping_options?: Array + /** + * The IDs of the types of products associated with this tax rate + */ + product_types?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsParams.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsParams.ts new file mode 100644 index 0000000000..871965abca --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateShippingOptionsParams { + /** + * Which fields should be included in the result. + */ + fields?: Array + /** + * Which fields should be expanded and retrieved in the result. + */ + expand?: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts new file mode 100644 index 0000000000..a4038264d2 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostTaxRatesTaxRateShippingOptionsReq { + /** + * The IDs of the shipping options to associate with this tax rate + */ + shipping_options: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts b/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts new file mode 100644 index 0000000000..ac15ae80ea --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPostUploadsDownloadUrlReq { + /** + * key of the file to obtain the download link for + */ + file_key: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListDeleteBatchRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteBatchRes.ts new file mode 100644 index 0000000000..7811a92a83 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteBatchRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPriceListDeleteBatchRes { + ids: Array + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListDeleteProductPricesRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteProductPricesRes.ts new file mode 100644 index 0000000000..22ebe740ec --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteProductPricesRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPriceListDeleteProductPricesRes { + /** + * The price ids that have been deleted. + */ + ids: Array + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteRes.ts new file mode 100644 index 0000000000..b76502e9dc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPriceListDeleteRes { + /** + * The ID of the deleted Price List. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListDeleteVariantPricesRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteVariantPricesRes.ts new file mode 100644 index 0000000000..6791e4c243 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListDeleteVariantPricesRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPriceListDeleteVariantPricesRes { + /** + * The price ids that have been deleted. + */ + ids: Array + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListRes.ts new file mode 100644 index 0000000000..9a6f9d5176 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PriceList } from "./PriceList" + +export interface AdminPriceListRes { + price_list: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListsListRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListsListRes.ts new file mode 100644 index 0000000000..e016dbf66e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PriceList } from "./PriceList" + +export interface AdminPriceListsListRes { + price_lists: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPriceListsProductsListRes.ts b/packages/generated/client-types/src/lib/models/AdminPriceListsProductsListRes.ts new file mode 100644 index 0000000000..9008f06b3b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPriceListsProductsListRes.ts @@ -0,0 +1,39 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" +import type { ProductVariant } from "./ProductVariant" + +export interface AdminPriceListsProductsListRes { + products: Array< + Merge< + SetRelation< + Product, + | "categories" + | "collection" + | "images" + | "options" + | "tags" + | "type" + | "variants" + >, + { + variants: Array> + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductCategoriesCategoryDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminProductCategoriesCategoryDeleteRes.ts new file mode 100644 index 0000000000..85b75e4d3d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductCategoriesCategoryDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminProductCategoriesCategoryDeleteRes { + /** + * The ID of the deleted product category + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductCategoriesCategoryRes.ts b/packages/generated/client-types/src/lib/models/AdminProductCategoriesCategoryRes.ts new file mode 100644 index 0000000000..68eefd2adb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductCategoriesCategoryRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCategory } from "./ProductCategory" + +export interface AdminProductCategoriesCategoryRes { + product_category: SetRelation< + ProductCategory, + "category_children" | "parent_category" + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductCategoriesListRes.ts b/packages/generated/client-types/src/lib/models/AdminProductCategoriesListRes.ts new file mode 100644 index 0000000000..fb7e2055f9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductCategoriesListRes.ts @@ -0,0 +1,24 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCategory } from "./ProductCategory" + +export interface AdminProductCategoriesListRes { + product_categories: Array< + SetRelation + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductTagsListRes.ts b/packages/generated/client-types/src/lib/models/AdminProductTagsListRes.ts new file mode 100644 index 0000000000..6d12dfb585 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductTagsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductTag } from "./ProductTag" + +export interface AdminProductTagsListRes { + product_tags: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductTypesListRes.ts b/packages/generated/client-types/src/lib/models/AdminProductTypesListRes.ts new file mode 100644 index 0000000000..84e91c46eb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductTypesListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductType } from "./ProductType" + +export interface AdminProductTypesListRes { + product_types: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsDeleteOptionRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsDeleteOptionRes.ts new file mode 100644 index 0000000000..85c9c3ab81 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsDeleteOptionRes.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedProduct } from "./PricedProduct" +import type { ProductVariant } from "./ProductVariant" + +export interface AdminProductsDeleteOptionRes { + /** + * The ID of the deleted Product Option + */ + option_id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean + product: Merge< + SetRelation< + PricedProduct, + "collection" | "images" | "options" | "tags" | "type" | "variants" + >, + { + variants: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsDeleteRes.ts new file mode 100644 index 0000000000..31943a690f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminProductsDeleteRes { + /** + * The ID of the deleted Product. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsDeleteVariantRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsDeleteVariantRes.ts new file mode 100644 index 0000000000..4bc42f01cb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsDeleteVariantRes.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedProduct } from "./PricedProduct" +import type { ProductVariant } from "./ProductVariant" + +export interface AdminProductsDeleteVariantRes { + /** + * The ID of the deleted Product Variant. + */ + variant_id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean + product: Merge< + SetRelation< + PricedProduct, + "collection" | "images" | "options" | "tags" | "type" | "variants" + >, + { + variants: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsListRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsListRes.ts new file mode 100644 index 0000000000..e15082d115 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsListRes.ts @@ -0,0 +1,33 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedProduct } from "./PricedProduct" +import type { ProductVariant } from "./ProductVariant" + +export interface AdminProductsListRes { + products: Array< + Merge< + SetRelation< + PricedProduct, + "collection" | "images" | "options" | "tags" | "type" | "variants" + >, + { + variants: Array> + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsListTagsRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsListTagsRes.ts new file mode 100644 index 0000000000..2bee9cc7a3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsListTagsRes.ts @@ -0,0 +1,21 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminProductsListTagsRes { + tags: Array<{ + /** + * The ID of the tag. + */ + id: string + /** + * The number of products that use this tag. + */ + usage_count: string + /** + * The value of the tag. + */ + value: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsListTypesRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsListTypesRes.ts new file mode 100644 index 0000000000..fd182fce98 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsListTypesRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductType } from "./ProductType" + +export interface AdminProductsListTypesRes { + types: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsListVariantsRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsListVariantsRes.ts new file mode 100644 index 0000000000..b4d8646f69 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsListVariantsRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductVariant } from "./ProductVariant" + +export interface AdminProductsListVariantsRes { + variants: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminProductsRes.ts b/packages/generated/client-types/src/lib/models/AdminProductsRes.ts new file mode 100644 index 0000000000..c98cac915d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminProductsRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedProduct } from "./PricedProduct" +import type { ProductVariant } from "./ProductVariant" + +export interface AdminProductsRes { + product: Merge< + SetRelation< + PricedProduct, + "collection" | "images" | "options" | "tags" | "type" | "variants" + >, + { + variants: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminPublishableApiKeyDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeyDeleteRes.ts new file mode 100644 index 0000000000..02f0b2b5fe --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeyDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminPublishableApiKeyDeleteRes { + /** + * The ID of the deleted PublishableApiKey. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether the PublishableApiKeys was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysListRes.ts b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysListRes.ts new file mode 100644 index 0000000000..e27602698e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PublishableApiKey } from "./PublishableApiKey" + +export interface AdminPublishableApiKeysListRes { + publishable_api_keys: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysListSalesChannelsRes.ts b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysListSalesChannelsRes.ts new file mode 100644 index 0000000000..6dcd379dc7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysListSalesChannelsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { SalesChannel } from "./SalesChannel" + +export interface AdminPublishableApiKeysListSalesChannelsRes { + sales_channels: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysRes.ts b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysRes.ts new file mode 100644 index 0000000000..78f6662b0e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminPublishableApiKeysRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PublishableApiKey } from "./PublishableApiKey" + +export interface AdminPublishableApiKeysRes { + publishable_api_key: PublishableApiKey +} diff --git a/packages/generated/client-types/src/lib/models/AdminRefundRes.ts b/packages/generated/client-types/src/lib/models/AdminRefundRes.ts new file mode 100644 index 0000000000..b643a32884 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminRefundRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Refund } from "./Refund" + +export interface AdminRefundRes { + refund: Refund +} diff --git a/packages/generated/client-types/src/lib/models/AdminRegionsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminRegionsDeleteRes.ts new file mode 100644 index 0000000000..7c1a5e408c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminRegionsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminRegionsDeleteRes { + /** + * The ID of the deleted Region. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminRegionsListRes.ts b/packages/generated/client-types/src/lib/models/AdminRegionsListRes.ts new file mode 100644 index 0000000000..2d64a10313 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminRegionsListRes.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" + +export interface AdminRegionsListRes { + regions: Array< + SetRelation< + Region, + "countries" | "fulfillment_providers" | "payment_providers" + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminRegionsRes.ts b/packages/generated/client-types/src/lib/models/AdminRegionsRes.ts new file mode 100644 index 0000000000..a8a0a61974 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminRegionsRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" + +export interface AdminRegionsRes { + region: SetRelation< + Region, + "countries" | "fulfillment_providers" | "payment_providers" + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminReservationsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminReservationsDeleteRes.ts new file mode 100644 index 0000000000..e72168f31f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReservationsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminReservationsDeleteRes { + /** + * The ID of the deleted Reservation. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the Reservation was deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminReservationsListRes.ts b/packages/generated/client-types/src/lib/models/AdminReservationsListRes.ts new file mode 100644 index 0000000000..dcb5d97842 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReservationsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ReservationItemDTO } from "./ReservationItemDTO" + +export interface AdminReservationsListRes { + reservations: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminReservationsRes.ts b/packages/generated/client-types/src/lib/models/AdminReservationsRes.ts new file mode 100644 index 0000000000..b06581aed7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReservationsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ReservationItemDTO } from "./ReservationItemDTO" + +export interface AdminReservationsRes { + reservation: ReservationItemDTO +} diff --git a/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts b/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts new file mode 100644 index 0000000000..fcdbdf44de --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminResetPasswordRequest { + /** + * The Users email. + */ + email?: string + /** + * The token generated from the 'password-token' endpoint. + */ + token: string + /** + * The Users new password. + */ + password: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts b/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts new file mode 100644 index 0000000000..1555b3ae9c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminResetPasswordTokenRequest { + /** + * The Users email. + */ + email: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminReturnReasonsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminReturnReasonsDeleteRes.ts new file mode 100644 index 0000000000..c0d3705a0a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReturnReasonsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminReturnReasonsDeleteRes { + /** + * The ID of the deleted return reason + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminReturnReasonsListRes.ts b/packages/generated/client-types/src/lib/models/AdminReturnReasonsListRes.ts new file mode 100644 index 0000000000..fb985e22a5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReturnReasonsListRes.ts @@ -0,0 +1,12 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ReturnReason } from "./ReturnReason" + +export interface AdminReturnReasonsListRes { + return_reasons: Array< + SetRelation + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminReturnReasonsRes.ts b/packages/generated/client-types/src/lib/models/AdminReturnReasonsRes.ts new file mode 100644 index 0000000000..c48622d74c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReturnReasonsRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ReturnReason } from "./ReturnReason" + +export interface AdminReturnReasonsRes { + return_reason: SetRelation< + ReturnReason, + "parent_return_reason" | "return_reason_children" + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminReturnsCancelRes.ts b/packages/generated/client-types/src/lib/models/AdminReturnsCancelRes.ts new file mode 100644 index 0000000000..f634eec7bc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReturnsCancelRes.ts @@ -0,0 +1,99 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimItem } from "./ClaimItem" +import type { ClaimOrder } from "./ClaimOrder" +import type { Discount } from "./Discount" +import type { Fulfillment } from "./Fulfillment" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { Return } from "./Return" +import type { ReturnItem } from "./ReturnItem" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +export interface AdminReturnsCancelRes { + order: Merge< + SetRelation< + Order, + | "billing_address" + | "claims" + | "customer" + | "discounts" + | "fulfillments" + | "gift_card_transactions" + | "gift_cards" + | "items" + | "payments" + | "refunds" + | "region" + | "returns" + | "shipping_address" + | "shipping_methods" + | "swaps" + >, + { + claims: Array< + Merge< + SetRelation< + ClaimOrder, + | "additional_items" + | "claim_items" + | "fulfillments" + | "return_order" + | "shipping_address" + | "shipping_methods" + >, + { + additional_items: Array> + claim_items: Array> + fulfillments: Array> + return_order: Merge< + SetRelation, + { + shipping_method: SetRelation + } + > + } + > + > + discounts: Array> + fulfillments: Array> + returns: Array< + Merge< + SetRelation, + { + items: Array> + shipping_method: SetRelation + } + > + > + swaps: Array< + Merge< + SetRelation< + Swap, + | "additional_items" + | "fulfillments" + | "payment" + | "return_order" + | "shipping_address" + | "shipping_methods" + >, + { + additional_items: Array> + fulfillments: Array> + return_order: Merge< + SetRelation, + { + shipping_method: SetRelation + } + > + shipping_methods: Array> + } + > + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminReturnsListRes.ts b/packages/generated/client-types/src/lib/models/AdminReturnsListRes.ts new file mode 100644 index 0000000000..c4ff9c03b9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReturnsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Return } from "./Return" + +export interface AdminReturnsListRes { + returns: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminReturnsRes.ts b/packages/generated/client-types/src/lib/models/AdminReturnsRes.ts new file mode 100644 index 0000000000..22d7ec3fb1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminReturnsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Return } from "./Return" + +export interface AdminReturnsRes { + return: Return +} diff --git a/packages/generated/client-types/src/lib/models/AdminSalesChannelsDeleteLocationRes.ts b/packages/generated/client-types/src/lib/models/AdminSalesChannelsDeleteLocationRes.ts new file mode 100644 index 0000000000..8d82d00a9a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminSalesChannelsDeleteLocationRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminSalesChannelsDeleteLocationRes { + /** + * The ID of the removed stock location from a sales channel + */ + id: string + /** + * The type of the object that was removed. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminSalesChannelsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminSalesChannelsDeleteRes.ts new file mode 100644 index 0000000000..0495df09e4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminSalesChannelsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminSalesChannelsDeleteRes { + /** + * The ID of the deleted sales channel + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminSalesChannelsListRes.ts b/packages/generated/client-types/src/lib/models/AdminSalesChannelsListRes.ts new file mode 100644 index 0000000000..b989cc84bd --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminSalesChannelsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { SalesChannel } from "./SalesChannel" + +export interface AdminSalesChannelsListRes { + sales_channels: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminSalesChannelsRes.ts b/packages/generated/client-types/src/lib/models/AdminSalesChannelsRes.ts new file mode 100644 index 0000000000..c89fb5f52b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminSalesChannelsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { SalesChannel } from "./SalesChannel" + +export interface AdminSalesChannelsRes { + sales_channel: SalesChannel +} diff --git a/packages/generated/client-types/src/lib/models/AdminShippingOptionsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminShippingOptionsDeleteRes.ts new file mode 100644 index 0000000000..f500f58a35 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminShippingOptionsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminShippingOptionsDeleteRes { + /** + * The ID of the deleted Shipping Option. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminShippingOptionsListRes.ts b/packages/generated/client-types/src/lib/models/AdminShippingOptionsListRes.ts new file mode 100644 index 0000000000..4ed29401dc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminShippingOptionsListRes.ts @@ -0,0 +1,33 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" +import type { ShippingOption } from "./ShippingOption" + +export interface AdminShippingOptionsListRes { + shipping_options: Array< + Merge< + SetRelation, + { + region: SetRelation< + Region, + "fulfillment_providers" | "payment_providers" + > + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminShippingOptionsRes.ts b/packages/generated/client-types/src/lib/models/AdminShippingOptionsRes.ts new file mode 100644 index 0000000000..9613dda08d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminShippingOptionsRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" +import type { ShippingOption } from "./ShippingOption" + +export interface AdminShippingOptionsRes { + shipping_option: Merge< + SetRelation, + { + region: SetRelation + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminShippingProfilesListRes.ts b/packages/generated/client-types/src/lib/models/AdminShippingProfilesListRes.ts new file mode 100644 index 0000000000..09c5416d4f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminShippingProfilesListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ShippingProfile } from "./ShippingProfile" + +export interface AdminShippingProfilesListRes { + shipping_profiles: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminShippingProfilesRes.ts b/packages/generated/client-types/src/lib/models/AdminShippingProfilesRes.ts new file mode 100644 index 0000000000..0844d0e775 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminShippingProfilesRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ShippingProfile } from "./ShippingProfile" + +export interface AdminShippingProfilesRes { + shipping_profile: SetRelation< + ShippingProfile, + "products" | "shipping_options" + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminStockLocationsDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminStockLocationsDeleteRes.ts new file mode 100644 index 0000000000..0d8aaf96d7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminStockLocationsDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminStockLocationsDeleteRes { + /** + * The ID of the deleted Stock Location. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts b/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts new file mode 100644 index 0000000000..79293f758f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO" + +export interface AdminStockLocationsListRes { + stock_locations: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminStockLocationsRes.ts b/packages/generated/client-types/src/lib/models/AdminStockLocationsRes.ts new file mode 100644 index 0000000000..aecc99b29e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminStockLocationsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO" + +export interface AdminStockLocationsRes { + stock_location: StockLocationExpandedDTO +} diff --git a/packages/generated/client-types/src/lib/models/AdminStoresRes.ts b/packages/generated/client-types/src/lib/models/AdminStoresRes.ts new file mode 100644 index 0000000000..c4b33013a5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminStoresRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Store } from "./Store" + +export interface AdminStoresRes { + store: Store +} diff --git a/packages/generated/client-types/src/lib/models/AdminSwapsListRes.ts b/packages/generated/client-types/src/lib/models/AdminSwapsListRes.ts new file mode 100644 index 0000000000..cd9e0ccac5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminSwapsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Swap } from "./Swap" + +export interface AdminSwapsListRes { + swaps: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminSwapsRes.ts b/packages/generated/client-types/src/lib/models/AdminSwapsRes.ts new file mode 100644 index 0000000000..24731dc765 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminSwapsRes.ts @@ -0,0 +1,37 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { Fulfillment } from "./Fulfillment" +import type { LineItem } from "./LineItem" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +export interface AdminSwapsRes { + swap: Merge< + SetRelation< + Swap, + | "additional_items" + | "cart" + | "fulfillments" + | "order" + | "payment" + | "return_order" + | "shipping_address" + | "shipping_methods" + >, + { + additional_items: Array> + cart: Merge< + SetRelation, + { + items: Array> + } + > + fulfillments: Array> + shipping_methods: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/AdminTaxProvidersList.ts b/packages/generated/client-types/src/lib/models/AdminTaxProvidersList.ts new file mode 100644 index 0000000000..ef0a471749 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminTaxProvidersList.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { TaxProvider } from "./TaxProvider" + +export interface AdminTaxProvidersList { + tax_providers: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminTaxRatesDeleteRes.ts b/packages/generated/client-types/src/lib/models/AdminTaxRatesDeleteRes.ts new file mode 100644 index 0000000000..ca166e3d56 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminTaxRatesDeleteRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminTaxRatesDeleteRes { + /** + * The ID of the deleted Shipping Option. + */ + id: string + /** + * The type of the object that was deleted. + */ + object: string + /** + * Whether or not the items were deleted. + */ + deleted: boolean +} diff --git a/packages/generated/client-types/src/lib/models/AdminTaxRatesListRes.ts b/packages/generated/client-types/src/lib/models/AdminTaxRatesListRes.ts new file mode 100644 index 0000000000..8d84df91a2 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminTaxRatesListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { TaxRate } from "./TaxRate" + +export interface AdminTaxRatesListRes { + tax_rates: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminTaxRatesRes.ts b/packages/generated/client-types/src/lib/models/AdminTaxRatesRes.ts new file mode 100644 index 0000000000..83b4743bfe --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminTaxRatesRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { TaxRate } from "./TaxRate" + +export interface AdminTaxRatesRes { + tax_rate: TaxRate +} diff --git a/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts b/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts new file mode 100644 index 0000000000..c07f844099 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminUpdatePaymentCollectionsReq { + /** + * An optional description to create or update the payment collection. + */ + description?: string + /** + * An optional set of key-value pairs to hold additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminUpdateUserRequest.ts b/packages/generated/client-types/src/lib/models/AdminUpdateUserRequest.ts new file mode 100644 index 0000000000..021aaff98f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminUpdateUserRequest.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminUpdateUserRequest { + /** + * The name of the User. + */ + first_name?: string + /** + * The name of the User. + */ + last_name?: string + /** + * Userrole assigned to the user. + */ + role?: "admin" | "member" | "developer" + /** + * The api token of the User. + */ + api_token?: string + /** + * An optional set of key-value pairs with additional information. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/AdminUploadsDownloadUrlRes.ts b/packages/generated/client-types/src/lib/models/AdminUploadsDownloadUrlRes.ts new file mode 100644 index 0000000000..c4d31f6233 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminUploadsDownloadUrlRes.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminUploadsDownloadUrlRes { + /** + * The Download URL of the file + */ + download_url: string +} diff --git a/packages/generated/client-types/src/lib/models/AdminUploadsRes.ts b/packages/generated/client-types/src/lib/models/AdminUploadsRes.ts new file mode 100644 index 0000000000..eefe6299c8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminUploadsRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface AdminUploadsRes { + uploads: Array<{ + /** + * The URL of the uploaded file. + */ + url: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/AdminUserRes.ts b/packages/generated/client-types/src/lib/models/AdminUserRes.ts new file mode 100644 index 0000000000..6008b95bdc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminUserRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { User } from "./User" + +export interface AdminUserRes { + user: User +} diff --git a/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts b/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts new file mode 100644 index 0000000000..f1133fb232 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { User } from "./User" + +export interface AdminUsersListRes { + users: Array +} diff --git a/packages/generated/client-types/src/lib/models/AdminVariantsListRes.ts b/packages/generated/client-types/src/lib/models/AdminVariantsListRes.ts new file mode 100644 index 0000000000..d6708fc3c5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminVariantsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedVariant } from "./PricedVariant" + +export interface AdminVariantsListRes { + variants: Array> + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/AdminVariantsRes.ts b/packages/generated/client-types/src/lib/models/AdminVariantsRes.ts new file mode 100644 index 0000000000..5e506f4a72 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/AdminVariantsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedVariant } from "./PricedVariant" + +export interface AdminVariantsRes { + variant: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/BatchJob.ts b/packages/generated/client-types/src/lib/models/BatchJob.ts new file mode 100644 index 0000000000..f0b5573b67 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/BatchJob.ts @@ -0,0 +1,105 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { User } from "./User" + +/** + * A Batch Job. + */ +export interface BatchJob { + /** + * The unique identifier for the batch job. + */ + id: string + /** + * The type of batch job. + */ + type: "product-import" | "product-export" + /** + * The status of the batch job. + */ + status: + | "created" + | "pre_processed" + | "confirmed" + | "processing" + | "completed" + | "canceled" + | "failed" + /** + * The unique identifier of the user that created the batch job. + */ + created_by: string | null + /** + * A user object. Available if the relation `created_by_user` is expanded. + */ + created_by_user?: User | null + /** + * The context of the batch job, the type of the batch job determines what the context should contain. + */ + context: Record | null + /** + * Specify if the job must apply the modifications or not. + */ + dry_run: boolean + /** + * The result of the batch job. + */ + result: + | (Record & { + count?: number + advancement_count?: number + progress?: number + errors?: { + message?: string + code?: string | number + err?: any[] + } + stat_descriptors?: { + key?: string + name?: string + message?: string + } + file_key?: string + file_size?: number + }) + | null + /** + * The date from which the job has been pre-processed. + */ + pre_processed_at: string | null + /** + * The date the job is processing at. + */ + processing_at: string | null + /** + * The date when the confirmation has been done. + */ + confirmed_at: string | null + /** + * The date of the completion. + */ + completed_at: string | null + /** + * The date of the concellation. + */ + canceled_at: string | null + /** + * The date when the job failed. + */ + failed_at: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was last updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/Cart.ts b/packages/generated/client-types/src/lib/models/Cart.ts new file mode 100644 index 0000000000..08d799df85 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Cart.ts @@ -0,0 +1,181 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Address } from "./Address" +import type { Customer } from "./Customer" +import type { Discount } from "./Discount" +import type { GiftCard } from "./GiftCard" +import type { LineItem } from "./LineItem" +import type { Payment } from "./Payment" +import type { PaymentSession } from "./PaymentSession" +import type { Region } from "./Region" +import type { SalesChannel } from "./SalesChannel" +import type { ShippingMethod } from "./ShippingMethod" + +/** + * Represents a user cart + */ +export interface Cart { + /** + * The cart's ID + */ + id: string + /** + * The email associated with the cart + */ + email: string | null + /** + * The billing address's ID + */ + billing_address_id: string | null + /** + * Available if the relation `billing_address` is expanded. + */ + billing_address?: Address | null + /** + * The shipping address's ID + */ + shipping_address_id: string | null + /** + * Available if the relation `shipping_address` is expanded. + */ + shipping_address?: Address | null + /** + * Available if the relation `items` is expanded. + */ + items?: Array + /** + * The region's ID + */ + region_id: string + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * Available if the relation `discounts` is expanded. + */ + discounts?: Array + /** + * Available if the relation `gift_cards` is expanded. + */ + gift_cards?: Array + /** + * The customer's ID + */ + customer_id: string | null + /** + * A customer object. Available if the relation `customer` is expanded. + */ + customer?: Customer | null + /** + * The selected payment session in the cart. + */ + payment_session: PaymentSession | null + /** + * The payment sessions created on the cart. + */ + payment_sessions?: Array + /** + * The payment's ID if available + */ + payment_id: string | null + /** + * Available if the relation `payment` is expanded. + */ + payment?: Payment | null + /** + * The shipping methods added to the cart. + */ + shipping_methods?: Array + /** + * The cart's type. + */ + type: "default" | "swap" | "draft_order" | "payment_link" | "claim" + /** + * The date with timezone at which the cart was completed. + */ + completed_at: string | null + /** + * The date with timezone at which the payment was authorized. + */ + payment_authorized_at: string | null + /** + * Randomly generated key used to continue the completion of a cart in case of failure. + */ + idempotency_key: string | null + /** + * The context of the cart which can include info like IP or user agent. + */ + context: Record | null + /** + * The sales channel ID the cart is associated with. + */ + sales_channel_id?: string | null + /** + * A sales channel object. Available if the relation `sales_channel` is expanded. + */ + sales_channel?: SalesChannel | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null + /** + * The total of shipping + */ + shipping_total?: number + /** + * The total of discount + */ + discount_total?: number + /** + * The total of items with taxes + */ + item_tax_total?: number + /** + * The total of shipping with taxes + */ + shipping_tax_total?: number + /** + * The total of tax + */ + tax_total?: number + /** + * The total amount refunded if the order associated with this cart is returned. + */ + refunded_total?: number + /** + * The total amount of the cart + */ + total?: number + /** + * The subtotal of the cart + */ + subtotal?: number + /** + * The amount that can be refunded + */ + refundable_amount?: number + /** + * The total of gift cards + */ + gift_card_total?: number + /** + * The total of gift cards with taxes + */ + gift_card_tax_total?: number +} diff --git a/packages/generated/client-types/src/lib/models/ClaimImage.ts b/packages/generated/client-types/src/lib/models/ClaimImage.ts new file mode 100644 index 0000000000..196c4cf4a5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ClaimImage.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimItem } from "./ClaimItem" + +/** + * Represents photo documentation of a claim. + */ +export interface ClaimImage { + /** + * The claim image's ID + */ + id: string + /** + * The ID of the claim item associated with the image + */ + claim_item_id: string + /** + * A claim item object. Available if the relation `claim_item` is expanded. + */ + claim_item?: ClaimItem | null + /** + * The URL of the image + */ + url: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ClaimItem.ts b/packages/generated/client-types/src/lib/models/ClaimItem.ts new file mode 100644 index 0000000000..af9c01d0b5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ClaimItem.ts @@ -0,0 +1,80 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimImage } from "./ClaimImage" +import type { ClaimOrder } from "./ClaimOrder" +import type { ClaimTag } from "./ClaimTag" +import type { LineItem } from "./LineItem" +import type { ProductVariant } from "./ProductVariant" + +/** + * Represents a claimed item along with information about the reasons for the claim. + */ +export interface ClaimItem { + /** + * The claim item's ID + */ + id: string + /** + * Available if the relation `images` is expanded. + */ + images?: Array + /** + * The ID of the claim this item is associated with. + */ + claim_order_id: string + /** + * A claim order object. Available if the relation `claim_order` is expanded. + */ + claim_order?: ClaimOrder | null + /** + * The ID of the line item that the claim item refers to. + */ + item_id: string + /** + * Available if the relation `item` is expanded. + */ + item?: LineItem | null + /** + * The ID of the product variant that is claimed. + */ + variant_id: string + /** + * A variant object. Available if the relation `variant` is expanded. + */ + variant?: ProductVariant | null + /** + * The reason for the claim + */ + reason: "missing_item" | "wrong_item" | "production_failure" | "other" + /** + * An optional note about the claim, for additional information + */ + note: string | null + /** + * The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order. + */ + quantity: number + /** + * User defined tags for easy filtering and grouping. Available if the relation 'tags' is expanded. + */ + tags?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ClaimOrder.ts b/packages/generated/client-types/src/lib/models/ClaimOrder.ts new file mode 100644 index 0000000000..a84a58a6cf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ClaimOrder.ts @@ -0,0 +1,111 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Address } from "./Address" +import type { ClaimItem } from "./ClaimItem" +import type { Fulfillment } from "./Fulfillment" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { Return } from "./Return" +import type { ShippingMethod } from "./ShippingMethod" + +/** + * Claim Orders represent a group of faulty or missing items. Each claim order consists of a subset of items associated with an original order, and can contain additional information about fulfillments and returns. + */ +export interface ClaimOrder { + /** + * The claim's ID + */ + id: string + /** + * The claim's type + */ + type: "refund" | "replace" + /** + * The status of the claim's payment + */ + payment_status: "na" | "not_refunded" | "refunded" + /** + * The claim's fulfillment status + */ + fulfillment_status: + | "not_fulfilled" + | "partially_fulfilled" + | "fulfilled" + | "partially_shipped" + | "shipped" + | "partially_returned" + | "returned" + | "canceled" + | "requires_action" + /** + * The items that have been claimed + */ + claim_items?: Array + /** + * Refers to the new items to be shipped when the claim order has the type `replace` + */ + additional_items?: Array + /** + * The ID of the order that the claim comes from. + */ + order_id: string + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * A return object. Holds information about the return if the claim is to be returned. Available if the relation 'return_order' is expanded + */ + return_order?: Return | null + /** + * The ID of the address that the new items should be shipped to + */ + shipping_address_id: string | null + /** + * Available if the relation `shipping_address` is expanded. + */ + shipping_address?: Address | null + /** + * The shipping methods that the claim order will be shipped with. + */ + shipping_methods?: Array + /** + * The fulfillments of the new items to be shipped + */ + fulfillments?: Array + /** + * The amount that will be refunded in conjunction with the claim + */ + refund_amount: number | null + /** + * The date with timezone at which the claim was canceled. + */ + canceled_at: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null + /** + * Flag for describing whether or not notifications related to this should be send. + */ + no_notification: boolean | null + /** + * Randomly generated key used to continue the completion of the cart associated with the claim in case of failure. + */ + idempotency_key: string | null +} diff --git a/packages/generated/client-types/src/lib/models/ClaimTag.ts b/packages/generated/client-types/src/lib/models/ClaimTag.ts new file mode 100644 index 0000000000..5c868c9d12 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ClaimTag.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping. + */ +export interface ClaimTag { + /** + * The claim tag's ID + */ + id: string + /** + * The value that the claim tag holds + */ + value: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Country.ts b/packages/generated/client-types/src/lib/models/Country.ts new file mode 100644 index 0000000000..865115c082 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Country.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" + +/** + * Country details + */ +export interface Country { + /** + * The country's ID + */ + id: string + /** + * The 2 character ISO code of the country in lower case + */ + iso_2: string + /** + * The 2 character ISO code of the country in lower case + */ + iso_3: string + /** + * The numerical ISO code for the country. + */ + num_code: string + /** + * The normalized country name in upper case. + */ + name: string + /** + * The country name appropriate for display. + */ + display_name: string + /** + * The region ID this country is associated with. + */ + region_id: string | null + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null +} diff --git a/packages/generated/client-types/src/lib/models/CreateStockLocationInput.ts b/packages/generated/client-types/src/lib/models/CreateStockLocationInput.ts new file mode 100644 index 0000000000..3de1e2b328 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/CreateStockLocationInput.ts @@ -0,0 +1,28 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationAddressInput } from "./StockLocationAddressInput" + +/** + * Represents the Input to create a Stock Location + */ +export interface CreateStockLocationInput { + /** + * The stock location name + */ + name: string + /** + * The Stock location address ID + */ + address_id?: string + /** + * Stock location address object + */ + address?: StockLocationAddressInput & Record + /** + * An optional key-value map with additional details + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/Currency.ts b/packages/generated/client-types/src/lib/models/Currency.ts new file mode 100644 index 0000000000..251f031945 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Currency.ts @@ -0,0 +1,30 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Currency + */ +export interface Currency { + /** + * The 3 character ISO code for the currency. + */ + code: string + /** + * The symbol used to indicate the currency. + */ + symbol: string + /** + * The native symbol used to indicate the currency. + */ + symbol_native: string + /** + * The written name of the currency + */ + name: string + /** + * [EXPERIMENTAL] Does the currency prices include tax + */ + includes_tax?: boolean +} diff --git a/packages/generated/client-types/src/lib/models/CustomShippingOption.ts b/packages/generated/client-types/src/lib/models/CustomShippingOption.ts new file mode 100644 index 0000000000..209536ec38 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/CustomShippingOption.ts @@ -0,0 +1,53 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { ShippingOption } from "./ShippingOption" + +/** + * Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option + */ +export interface CustomShippingOption { + /** + * The custom shipping option's ID + */ + id: string + /** + * The custom price set that will override the shipping option's original price + */ + price: number + /** + * The ID of the Shipping Option that the custom shipping option overrides + */ + shipping_option_id: string + /** + * A shipping option object. Available if the relation `shipping_option` is expanded. + */ + shipping_option?: ShippingOption | null + /** + * The ID of the Cart that the custom shipping option is attached to + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Customer.ts b/packages/generated/client-types/src/lib/models/Customer.ts new file mode 100644 index 0000000000..ed09b51340 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Customer.ts @@ -0,0 +1,74 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Address } from "./Address" +import type { CustomerGroup } from "./CustomerGroup" +import type { Order } from "./Order" + +/** + * Represents a customer + */ +export interface Customer { + /** + * The customer's ID + */ + id: string + /** + * The customer's email + */ + email: string + /** + * The customer's first name + */ + first_name: string | null + /** + * The customer's last name + */ + last_name: string | null + /** + * The customer's billing address ID + */ + billing_address_id: string | null + /** + * Available if the relation `billing_address` is expanded. + */ + billing_address?: Address | null + /** + * Available if the relation `shipping_addresses` is expanded. + */ + shipping_addresses?: Array
+ /** + * The customer's phone number + */ + phone: string | null + /** + * Whether the customer has an account or not + */ + has_account: boolean + /** + * Available if the relation `orders` is expanded. + */ + orders?: Array + /** + * The customer groups the customer belongs to. Available if the relation `groups` is expanded. + */ + groups?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/CustomerGroup.ts b/packages/generated/client-types/src/lib/models/CustomerGroup.ts new file mode 100644 index 0000000000..cc6a203da3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/CustomerGroup.ts @@ -0,0 +1,45 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" +import type { PriceList } from "./PriceList" + +/** + * Represents a customer group + */ +export interface CustomerGroup { + /** + * The customer group's ID + */ + id: string + /** + * The name of the customer group + */ + name: string + /** + * The customers that belong to the customer group. Available if the relation `customers` is expanded. + */ + customers?: Array + /** + * The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded. + */ + price_lists?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Discount.ts b/packages/generated/client-types/src/lib/models/Discount.ts new file mode 100644 index 0000000000..99a2972e26 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Discount.ts @@ -0,0 +1,85 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountRule } from "./DiscountRule" +import type { Region } from "./Region" + +/** + * Represents a discount that can be applied to a cart for promotional purposes. + */ +export interface Discount { + /** + * The discount's ID + */ + id: string + /** + * A unique code for the discount - this will be used by the customer to apply the discount + */ + code: string + /** + * A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts + */ + is_dynamic: boolean + /** + * The Discount Rule that governs the behaviour of the Discount + */ + rule_id: string | null + /** + * Available if the relation `rule` is expanded. + */ + rule?: DiscountRule | null + /** + * Whether the Discount has been disabled. Disabled discounts cannot be applied to carts + */ + is_disabled: boolean + /** + * The Discount that the discount was created from. This will always be a dynamic discount + */ + parent_discount_id: string | null + /** + * Available if the relation `parent_discount` is expanded. + */ + parent_discount?: Discount | null + /** + * The time at which the discount can be used. + */ + starts_at: string + /** + * The time at which the discount can no longer be used. + */ + ends_at: string | null + /** + * Duration the discount runs between + */ + valid_duration: string | null + /** + * The Regions in which the Discount can be used. Available if the relation `regions` is expanded. + */ + regions?: Array + /** + * The maximum number of times that a discount can be used. + */ + usage_limit: number | null + /** + * The number of times a discount has been used. + */ + usage_count: number + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountCondition.ts b/packages/generated/client-types/src/lib/models/DiscountCondition.ts new file mode 100644 index 0000000000..2f1f10b166 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountCondition.ts @@ -0,0 +1,78 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { CustomerGroup } from "./CustomerGroup" +import type { DiscountRule } from "./DiscountRule" +import type { Product } from "./Product" +import type { ProductCollection } from "./ProductCollection" +import type { ProductTag } from "./ProductTag" +import type { ProductType } from "./ProductType" + +/** + * Holds rule conditions for when a discount is applicable + */ +export interface DiscountCondition { + /** + * The discount condition's ID + */ + id: string + /** + * The type of the Condition + */ + type: + | "products" + | "product_types" + | "product_collections" + | "product_tags" + | "customer_groups" + /** + * The operator of the Condition + */ + operator: "in" | "not_in" + /** + * The ID of the discount rule associated with the condition + */ + discount_rule_id: string + /** + * Available if the relation `discount_rule` is expanded. + */ + discount_rule?: DiscountRule | null + /** + * products associated with this condition if type = products. Available if the relation `products` is expanded. + */ + products?: Array + /** + * Product types associated with this condition if type = product_types. Available if the relation `product_types` is expanded. + */ + product_types?: Array + /** + * Product tags associated with this condition if type = product_tags. Available if the relation `product_tags` is expanded. + */ + product_tags?: Array + /** + * Product collections associated with this condition if type = product_collections. Available if the relation `product_collections` is expanded. + */ + product_collections?: Array + /** + * Customer groups associated with this condition if type = customer_groups. Available if the relation `customer_groups` is expanded. + */ + customer_groups?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountConditionCustomerGroup.ts b/packages/generated/client-types/src/lib/models/DiscountConditionCustomerGroup.ts new file mode 100644 index 0000000000..e54fc3c6f9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountConditionCustomerGroup.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { CustomerGroup } from "./CustomerGroup" +import type { DiscountCondition } from "./DiscountCondition" + +/** + * Associates a discount condition with a customer group + */ +export interface DiscountConditionCustomerGroup { + /** + * The ID of the Product Tag + */ + customer_group_id: string + /** + * The ID of the Discount Condition + */ + condition_id: string + /** + * Available if the relation `customer_group` is expanded. + */ + customer_group?: CustomerGroup | null + /** + * Available if the relation `discount_condition` is expanded. + */ + discount_condition?: DiscountCondition | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountConditionProduct.ts b/packages/generated/client-types/src/lib/models/DiscountConditionProduct.ts new file mode 100644 index 0000000000..baf61641f7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountConditionProduct.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountCondition } from "./DiscountCondition" +import type { Product } from "./Product" + +/** + * Associates a discount condition with a product + */ +export interface DiscountConditionProduct { + /** + * The ID of the Product Tag + */ + product_id: string + /** + * The ID of the Discount Condition + */ + condition_id: string + /** + * Available if the relation `product` is expanded. + */ + product?: Product | null + /** + * Available if the relation `discount_condition` is expanded. + */ + discount_condition?: DiscountCondition | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountConditionProductCollection.ts b/packages/generated/client-types/src/lib/models/DiscountConditionProductCollection.ts new file mode 100644 index 0000000000..ae5bfe4c32 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountConditionProductCollection.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountCondition } from "./DiscountCondition" +import type { ProductCollection } from "./ProductCollection" + +/** + * Associates a discount condition with a product collection + */ +export interface DiscountConditionProductCollection { + /** + * The ID of the Product Collection + */ + product_collection_id: string + /** + * The ID of the Discount Condition + */ + condition_id: string + /** + * Available if the relation `product_collection` is expanded. + */ + product_collection?: ProductCollection | null + /** + * Available if the relation `discount_condition` is expanded. + */ + discount_condition?: DiscountCondition | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountConditionProductTag.ts b/packages/generated/client-types/src/lib/models/DiscountConditionProductTag.ts new file mode 100644 index 0000000000..37163a82b3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountConditionProductTag.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountCondition } from "./DiscountCondition" +import type { ProductTag } from "./ProductTag" + +/** + * Associates a discount condition with a product tag + */ +export interface DiscountConditionProductTag { + /** + * The ID of the Product Tag + */ + product_tag_id: string + /** + * The ID of the Discount Condition + */ + condition_id: string + /** + * Available if the relation `product_tag` is expanded. + */ + product_tag?: ProductTag | null + /** + * Available if the relation `discount_condition` is expanded. + */ + discount_condition?: DiscountCondition | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountConditionProductType.ts b/packages/generated/client-types/src/lib/models/DiscountConditionProductType.ts new file mode 100644 index 0000000000..4e9f4489d7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountConditionProductType.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountCondition } from "./DiscountCondition" +import type { ProductType } from "./ProductType" + +/** + * Associates a discount condition with a product type + */ +export interface DiscountConditionProductType { + /** + * The ID of the Product Tag + */ + product_type_id: string + /** + * The ID of the Discount Condition + */ + condition_id: string + /** + * Available if the relation `product_type` is expanded. + */ + product_type?: ProductType | null + /** + * Available if the relation `discount_condition` is expanded. + */ + discount_condition?: DiscountCondition | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DiscountRule.ts b/packages/generated/client-types/src/lib/models/DiscountRule.ts new file mode 100644 index 0000000000..71643f7b47 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DiscountRule.ts @@ -0,0 +1,52 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { DiscountCondition } from "./DiscountCondition" + +/** + * Holds the rules that governs how a Discount is calculated when applied to a Cart. + */ +export interface DiscountRule { + /** + * The discount rule's ID + */ + id: string + /** + * The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers. + */ + type: "fixed" | "percentage" | "free_shipping" + /** + * A short description of the discount + */ + description: string | null + /** + * The value that the discount represents; this will depend on the type of the discount + */ + value: number + /** + * The scope that the discount should apply to. + */ + allocation: "total" | "item" | null + /** + * A set of conditions that can be used to limit when the discount can be used. Available if the relation `conditions` is expanded. + */ + conditions?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/DraftOrder.ts b/packages/generated/client-types/src/lib/models/DraftOrder.ts new file mode 100644 index 0000000000..31388848d4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/DraftOrder.ts @@ -0,0 +1,69 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { Order } from "./Order" + +/** + * Represents a draft order + */ +export interface DraftOrder { + /** + * The draft order's ID + */ + id: string + /** + * The status of the draft order + */ + status: "open" | "completed" + /** + * The draft order's display ID + */ + display_id: string + /** + * The ID of the cart associated with the draft order. + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The ID of the order associated with the draft order. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The date the draft order was canceled at. + */ + canceled_at: string | null + /** + * The date the draft order was completed at. + */ + completed_at: string | null + /** + * Whether to send the customer notifications regarding order updates. + */ + no_notification_order: boolean | null + /** + * Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Error.ts b/packages/generated/client-types/src/lib/models/Error.ts new file mode 100644 index 0000000000..56d195061a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Error.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface Error { + /** + * A slug code to indicate the type of the error. + */ + code?: string + /** + * Description of the error that occurred. + */ + message?: string + /** + * A slug indicating the type of the error. + */ + type?: string +} diff --git a/packages/generated/client-types/src/lib/models/ExtendedStoreDTO.ts b/packages/generated/client-types/src/lib/models/ExtendedStoreDTO.ts new file mode 100644 index 0000000000..8c0318e3d5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ExtendedStoreDTO.ts @@ -0,0 +1,17 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { FeatureFlagsResponse } from "./FeatureFlagsResponse" +import type { FulfillmentProvider } from "./FulfillmentProvider" +import type { ModulesResponse } from "./ModulesResponse" +import type { PaymentProvider } from "./PaymentProvider" +import type { Store } from "./Store" + +export type ExtendedStoreDTO = Store & { + payment_providers: PaymentProvider + fulfillment_providers: FulfillmentProvider + feature_flags: FeatureFlagsResponse + modules: ModulesResponse +} diff --git a/packages/generated/client-types/src/lib/models/FeatureFlagsResponse.ts b/packages/generated/client-types/src/lib/models/FeatureFlagsResponse.ts new file mode 100644 index 0000000000..01b237cda6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/FeatureFlagsResponse.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export type FeatureFlagsResponse = Array<{ + /** + * The key of the feature flag. + */ + key: string + /** + * The value of the feature flag. + */ + value: boolean +}> diff --git a/packages/generated/client-types/src/lib/models/Fulfillment.ts b/packages/generated/client-types/src/lib/models/Fulfillment.ts new file mode 100644 index 0000000000..968c884c4c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Fulfillment.ts @@ -0,0 +1,102 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimOrder } from "./ClaimOrder" +import type { FulfillmentItem } from "./FulfillmentItem" +import type { FulfillmentProvider } from "./FulfillmentProvider" +import type { Order } from "./Order" +import type { Swap } from "./Swap" +import type { TrackingLink } from "./TrackingLink" + +/** + * Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments. + */ +export interface Fulfillment { + /** + * The fulfillment's ID + */ + id: string + /** + * The id of the Claim that the Fulfillment belongs to. + */ + claim_order_id: string | null + /** + * A claim order object. Available if the relation `claim_order` is expanded. + */ + claim_order?: ClaimOrder | null + /** + * The id of the Swap that the Fulfillment belongs to. + */ + swap_id: string | null + /** + * A swap object. Available if the relation `swap` is expanded. + */ + swap?: Swap | null + /** + * The id of the Order that the Fulfillment belongs to. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The id of the Fulfillment Provider responsible for handling the fulfillment + */ + provider_id: string + /** + * Available if the relation `provider` is expanded. + */ + provider?: FulfillmentProvider | null + /** + * The id of the stock location the fulfillment will be shipped from + */ + location_id: string | null + /** + * The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded. + */ + items?: Array + /** + * The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider. Available if the relation `tracking_links` is expanded. + */ + tracking_links?: Array + /** + * The tracking numbers that can be used to track the status of the fulfillment. + * @deprecated + */ + tracking_numbers: Array + /** + * This contains all the data necessary for the Fulfillment provider to handle the fulfillment. + */ + data: Record + /** + * The date with timezone at which the Fulfillment was shipped. + */ + shipped_at: string | null + /** + * Flag for describing whether or not notifications related to this should be sent. + */ + no_notification: boolean | null + /** + * The date with timezone at which the Fulfillment was canceled. + */ + canceled_at: string | null + /** + * Randomly generated key used to continue the completion of the fulfillment in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/FulfillmentItem.ts b/packages/generated/client-types/src/lib/models/FulfillmentItem.ts new file mode 100644 index 0000000000..078e3f18d5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/FulfillmentItem.ts @@ -0,0 +1,33 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Fulfillment } from "./Fulfillment" +import type { LineItem } from "./LineItem" + +/** + * Correlates a Line Item with a Fulfillment, keeping track of the quantity of the Line Item. + */ +export interface FulfillmentItem { + /** + * The id of the Fulfillment that the Fulfillment Item belongs to. + */ + fulfillment_id: string + /** + * The id of the Line Item that the Fulfillment Item references. + */ + item_id: string + /** + * A fulfillment object. Available if the relation `fulfillment` is expanded. + */ + fulfillment?: Fulfillment | null + /** + * Available if the relation `item` is expanded. + */ + item?: LineItem | null + /** + * The quantity of the Line Item that is included in the Fulfillment. + */ + quantity: number +} diff --git a/packages/generated/client-types/src/lib/models/FulfillmentProvider.ts b/packages/generated/client-types/src/lib/models/FulfillmentProvider.ts new file mode 100644 index 0000000000..07331eca23 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/FulfillmentProvider.ts @@ -0,0 +1,18 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a fulfillment provider plugin and holds its installation status. + */ +export interface FulfillmentProvider { + /** + * The id of the fulfillment provider as given by the plugin. + */ + id: string + /** + * Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`. + */ + is_installed: boolean +} diff --git a/packages/generated/client-types/src/lib/models/GetOrderEditsOrderEditParams.ts b/packages/generated/client-types/src/lib/models/GetOrderEditsOrderEditParams.ts new file mode 100644 index 0000000000..95638b4052 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GetOrderEditsOrderEditParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface GetOrderEditsOrderEditParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/GetOrderEditsParams.ts b/packages/generated/client-types/src/lib/models/GetOrderEditsParams.ts new file mode 100644 index 0000000000..24b2673788 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GetOrderEditsParams.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface GetOrderEditsParams { + /** + * Query used for searching order edit internal note. + */ + q?: string + /** + * List order edits by order id. + */ + order_id?: string + /** + * The number of items in the response + */ + limit?: number + /** + * The offset of items in response + */ + offset?: number + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/GetPaymentsParams.ts b/packages/generated/client-types/src/lib/models/GetPaymentsParams.ts new file mode 100644 index 0000000000..9322808f85 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GetPaymentsParams.ts @@ -0,0 +1,6 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface GetPaymentsParams {} diff --git a/packages/generated/client-types/src/lib/models/GetPublishableApiKeySalesChannelsParams.ts b/packages/generated/client-types/src/lib/models/GetPublishableApiKeySalesChannelsParams.ts new file mode 100644 index 0000000000..dd4b063063 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GetPublishableApiKeySalesChannelsParams.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface GetPublishableApiKeySalesChannelsParams { + /** + * Query used for searching sales channels' names and descriptions. + */ + q?: string +} diff --git a/packages/generated/client-types/src/lib/models/GetPublishableApiKeysParams.ts b/packages/generated/client-types/src/lib/models/GetPublishableApiKeysParams.ts new file mode 100644 index 0000000000..1aa28dbe79 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GetPublishableApiKeysParams.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface GetPublishableApiKeysParams { + /** + * Query used for searching publishable api keys by title. + */ + q?: string + /** + * The number of items in the response + */ + limit?: number + /** + * The offset of items in response + */ + offset?: number + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/GiftCard.ts b/packages/generated/client-types/src/lib/models/GiftCard.ts new file mode 100644 index 0000000000..5141049537 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GiftCard.ts @@ -0,0 +1,73 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Order } from "./Order" +import type { Region } from "./Region" + +/** + * Gift Cards are redeemable and represent a value that can be used towards the payment of an Order. + */ +export interface GiftCard { + /** + * The gift card's ID + */ + id: string + /** + * The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card. + */ + code: string + /** + * The value that the Gift Card represents. + */ + value: number + /** + * The remaining value on the Gift Card. + */ + balance: number + /** + * The id of the Region in which the Gift Card is available. + */ + region_id: string + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * The id of the Order that the Gift Card was purchased in. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts. + */ + is_disabled: boolean + /** + * The time at which the Gift Card can no longer be used. + */ + ends_at: string | null + /** + * The gift card's tax rate that will be applied on calculating totals + */ + tax_rate: number | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/GiftCardTransaction.ts b/packages/generated/client-types/src/lib/models/GiftCardTransaction.ts new file mode 100644 index 0000000000..bbf91060c9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/GiftCardTransaction.ts @@ -0,0 +1,49 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { GiftCard } from "./GiftCard" +import type { Order } from "./Order" + +/** + * Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order + */ +export interface GiftCardTransaction { + /** + * The gift card transaction's ID + */ + id: string + /** + * The ID of the Gift Card that was used in the transaction. + */ + gift_card_id: string + /** + * A gift card object. Available if the relation `gift_card` is expanded. + */ + gift_card?: GiftCard | null + /** + * The ID of the Order that the Gift Card was used to pay for. + */ + order_id: string + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The amount that was used from the Gift Card. + */ + amount: number + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * Whether the transaction is taxable or not. + */ + is_taxable: boolean | null + /** + * The tax rate of the transaction + */ + tax_rate: number | null +} diff --git a/packages/generated/client-types/src/lib/models/IdempotencyKey.ts b/packages/generated/client-types/src/lib/models/IdempotencyKey.ts new file mode 100644 index 0000000000..e3886acf5a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/IdempotencyKey.ts @@ -0,0 +1,50 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Idempotency Key is used to continue a process in case of any failure that might occur. + */ +export interface IdempotencyKey { + /** + * The idempotency key's ID + */ + id: string + /** + * The unique randomly generated key used to determine the state of a process. + */ + idempotency_key: string + /** + * Date which the idempotency key was locked. + */ + created_at: string + /** + * Date which the idempotency key was locked. + */ + locked_at: string | null + /** + * The method of the request + */ + request_method: string | null + /** + * The parameters passed to the request + */ + request_params: Record | null + /** + * The request's path + */ + request_path: string | null + /** + * The response's code. + */ + response_code: string | null + /** + * The response's body + */ + response_body: Record | null + /** + * Where to continue from. + */ + recovery_point: string +} diff --git a/packages/generated/client-types/src/lib/models/Image.ts b/packages/generated/client-types/src/lib/models/Image.ts new file mode 100644 index 0000000000..ae6995ca4f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Image.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Images holds a reference to a URL at which the image file can be found. + */ +export interface Image { + /** + * The image's ID + */ + id: string + /** + * The URL at which the image file can be found. + */ + url: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/InventoryItemDTO.ts b/packages/generated/client-types/src/lib/models/InventoryItemDTO.ts new file mode 100644 index 0000000000..2ca80cef4e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/InventoryItemDTO.ts @@ -0,0 +1,63 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface InventoryItemDTO { + /** + * The Stock Keeping Unit (SKU) code of the Inventory Item. + */ + sku: string + /** + * The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + hs_code?: string + /** + * The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + origin_country?: string + /** + * The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + mid_code?: string + /** + * The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + material?: string + /** + * The weight of the Inventory Item. May be used in shipping rate calculations. + */ + weight?: number + /** + * The height of the Inventory Item. May be used in shipping rate calculations. + */ + height?: number + /** + * The width of the Inventory Item. May be used in shipping rate calculations. + */ + width?: number + /** + * The length of the Inventory Item. May be used in shipping rate calculations. + */ + length?: number + /** + * Whether the item requires shipping. + */ + requires_shipping?: boolean + /** + * An optional key-value map with additional details + */ + metadata?: Record + /** + * The date with timezone at which the resource was created. + */ + created_at?: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at?: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at?: string +} diff --git a/packages/generated/client-types/src/lib/models/InventoryLevelDTO.ts b/packages/generated/client-types/src/lib/models/InventoryLevelDTO.ts new file mode 100644 index 0000000000..85801727db --- /dev/null +++ b/packages/generated/client-types/src/lib/models/InventoryLevelDTO.ts @@ -0,0 +1,39 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface InventoryLevelDTO { + /** + * the item location ID + */ + location_id: string + /** + * the total stock quantity of an inventory item at the given location ID + */ + stocked_quantity: number + /** + * the reserved stock quantity of an inventory item at the given location ID + */ + reserved_quantity: number + /** + * the incoming stock quantity of an inventory item at the given location ID + */ + incoming_quantity: number + /** + * An optional key-value map with additional details + */ + metadata?: Record + /** + * The date with timezone at which the resource was created. + */ + created_at?: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at?: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at?: string +} diff --git a/packages/generated/client-types/src/lib/models/Invite.ts b/packages/generated/client-types/src/lib/models/Invite.ts new file mode 100644 index 0000000000..f80989cf48 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Invite.ts @@ -0,0 +1,50 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents an invite + */ +export interface Invite { + /** + * The invite's ID + */ + id: string + /** + * The email of the user being invited. + */ + user_email: string + /** + * The user's role. + */ + role: "admin" | "member" | "developer" | null + /** + * Whether the invite was accepted or not. + */ + accepted: boolean + /** + * The token used to accept the invite. + */ + token: string + /** + * The date the invite expires at. + */ + expires_at: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/LineItem.ts b/packages/generated/client-types/src/lib/models/LineItem.ts new file mode 100644 index 0000000000..d46fac94a8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/LineItem.ts @@ -0,0 +1,183 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { ClaimOrder } from "./ClaimOrder" +import type { LineItemAdjustment } from "./LineItemAdjustment" +import type { LineItemTaxLine } from "./LineItemTaxLine" +import type { Order } from "./Order" +import type { OrderEdit } from "./OrderEdit" +import type { ProductVariant } from "./ProductVariant" +import type { Swap } from "./Swap" + +/** + * Line Items represent purchasable units that can be added to a Cart for checkout. When Line Items are purchased they will get copied to the resulting order and can eventually be referenced in Fulfillments and Returns. Line Items may also be created when processing Swaps and Claims. + */ +export interface LineItem { + /** + * The line item's ID + */ + id: string + /** + * The ID of the Cart that the Line Item belongs to. + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The ID of the Order that the Line Item belongs to. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The id of the Swap that the Line Item belongs to. + */ + swap_id: string | null + /** + * A swap object. Available if the relation `swap` is expanded. + */ + swap?: Swap | null + /** + * The id of the Claim that the Line Item belongs to. + */ + claim_order_id: string | null + /** + * A claim order object. Available if the relation `claim_order` is expanded. + */ + claim_order?: ClaimOrder | null + /** + * Available if the relation `tax_lines` is expanded. + */ + tax_lines?: Array + /** + * Available if the relation `adjustments` is expanded. + */ + adjustments?: Array + /** + * The id of the original line item + */ + original_item_id: string | null + /** + * The ID of the order edit to which a cloned item belongs + */ + order_edit_id: string | null + /** + * The order edit joined. Available if the relation `order_edit` is expanded. + */ + order_edit?: OrderEdit | null + /** + * The title of the Line Item, this should be easily identifiable by the Customer. + */ + title: string + /** + * A more detailed description of the contents of the Line Item. + */ + description: string | null + /** + * A URL string to a small image of the contents of the Line Item. + */ + thumbnail: string | null + /** + * Is the item being returned + */ + is_return: boolean + /** + * Flag to indicate if the Line Item is a Gift Card. + */ + is_giftcard: boolean + /** + * Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item. + */ + should_merge: boolean + /** + * Flag to indicate if the Line Item should be included when doing discount calculations. + */ + allow_discounts: boolean + /** + * Flag to indicate if the Line Item has fulfillment associated with it. + */ + has_shipping: boolean | null + /** + * The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to. + */ + unit_price: number + /** + * The id of the Product Variant contained in the Line Item. + */ + variant_id: string | null + /** + * A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. + */ + variant?: ProductVariant | null + /** + * The quantity of the content in the Line Item. + */ + quantity: number + /** + * The quantity of the Line Item that has been fulfilled. + */ + fulfilled_quantity: number | null + /** + * The quantity of the Line Item that has been returned. + */ + returned_quantity: number | null + /** + * The quantity of the Line Item that has been shipped. + */ + shipped_quantity: number | null + /** + * The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration. + */ + refundable?: number + /** + * The subtotal of the line item + */ + subtotal?: number + /** + * The total of tax of the line item + */ + tax_total?: number + /** + * The total amount of the line item + */ + total?: number + /** + * The original total amount of the line item + */ + original_total?: number + /** + * The original tax total amount of the line item + */ + original_tax_total?: number + /** + * The total of discount of the line item + */ + discount_total?: number + /** + * The total of the gift card of the line item + */ + gift_card_total?: number + /** + * [EXPERIMENTAL] Indicates if the line item unit_price include tax + */ + includes_tax?: boolean + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/LineItemAdjustment.ts b/packages/generated/client-types/src/lib/models/LineItemAdjustment.ts new file mode 100644 index 0000000000..2e5ba6f16d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/LineItemAdjustment.ts @@ -0,0 +1,45 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Discount } from "./Discount" +import type { LineItem } from "./LineItem" + +/** + * Represents a Line Item Adjustment + */ +export interface LineItemAdjustment { + /** + * The Line Item Adjustment's ID + */ + id: string + /** + * The ID of the line item + */ + item_id: string + /** + * Available if the relation `item` is expanded. + */ + item?: LineItem | null + /** + * The line item's adjustment description + */ + description: string + /** + * The ID of the discount associated with the adjustment + */ + discount_id: string | null + /** + * Available if the relation `discount` is expanded. + */ + discount?: Discount | null + /** + * The adjustment amount + */ + amount: number + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/LineItemTaxLine.ts b/packages/generated/client-types/src/lib/models/LineItemTaxLine.ts new file mode 100644 index 0000000000..c49a66c9d4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/LineItemTaxLine.ts @@ -0,0 +1,48 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" + +/** + * Represents a Line Item Tax Line + */ +export interface LineItemTaxLine { + /** + * The line item tax line's ID + */ + id: string + /** + * A code to identify the tax type by + */ + code: string | null + /** + * A human friendly name for the tax + */ + name: string + /** + * The numeric rate to charge tax by + */ + rate: number + /** + * The ID of the line item + */ + item_id: string + /** + * Available if the relation `item` is expanded. + */ + item?: LineItem | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ModulesResponse.ts b/packages/generated/client-types/src/lib/models/ModulesResponse.ts new file mode 100644 index 0000000000..8668b686ef --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ModulesResponse.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export type ModulesResponse = Array<{ + /** + * The key of the module. + */ + module: string + /** + * The resolution path of the module or false if module is not installed. + */ + resolution: string +}> diff --git a/packages/generated/client-types/src/lib/models/MoneyAmount.ts b/packages/generated/client-types/src/lib/models/MoneyAmount.ts new file mode 100644 index 0000000000..dfbf67defa --- /dev/null +++ b/packages/generated/client-types/src/lib/models/MoneyAmount.ts @@ -0,0 +1,75 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Currency } from "./Currency" +import type { PriceList } from "./PriceList" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" + +/** + * Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon. + */ +export interface MoneyAmount { + /** + * The money amount's ID + */ + id: string + /** + * The 3 character currency code that the Money Amount is given in. + */ + currency_code: string + /** + * Available if the relation `currency` is expanded. + */ + currency?: Currency | null + /** + * The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost. + */ + amount: number + /** + * The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + */ + min_quantity: number | null + /** + * The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities. + */ + max_quantity: number | null + /** + * The ID of the price list associated with the money amount + */ + price_list_id: string | null + /** + * Available if the relation `price_list` is expanded. + */ + price_list?: PriceList | null + /** + * The id of the Product Variant contained in the Line Item. + */ + variant_id: string | null + /** + * The Product Variant contained in the Line Item. Available if the relation `variant` is expanded. + */ + variant?: ProductVariant | null + /** + * The region's ID + */ + region_id: string | null + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/MultipleErrors.ts b/packages/generated/client-types/src/lib/models/MultipleErrors.ts new file mode 100644 index 0000000000..a2f2886aa1 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/MultipleErrors.ts @@ -0,0 +1,14 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Error } from "./Error" + +export interface MultipleErrors { + /** + * Array of errors + */ + errors?: Array + message?: string +} diff --git a/packages/generated/client-types/src/lib/models/Note.ts b/packages/generated/client-types/src/lib/models/Note.ts new file mode 100644 index 0000000000..5e1c45d2ce --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Note.ts @@ -0,0 +1,52 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { User } from "./User" + +/** + * Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these. + */ +export interface Note { + /** + * The note's ID + */ + id: string + /** + * The type of resource that the Note refers to. + */ + resource_type: string + /** + * The ID of the resource that the Note refers to. + */ + resource_id: string + /** + * The contents of the note. + */ + value: string + /** + * The ID of the author (user) + */ + author_id: string | null + /** + * Available if the relation `author` is expanded. + */ + author?: User | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Notification.ts b/packages/generated/client-types/src/lib/models/Notification.ts new file mode 100644 index 0000000000..b2e9c92977 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Notification.ts @@ -0,0 +1,73 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" +import type { NotificationProvider } from "./NotificationProvider" + +/** + * Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends. + */ +export interface Notification { + /** + * The notification's ID + */ + id: string + /** + * The name of the event that the notification was sent for. + */ + event_name: string | null + /** + * The type of resource that the Notification refers to. + */ + resource_type: string + /** + * The ID of the resource that the Notification refers to. + */ + resource_id: string + /** + * The ID of the Customer that the Notification was sent to. + */ + customer_id: string | null + /** + * A customer object. Available if the relation `customer` is expanded. + */ + customer?: Customer | null + /** + * The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id + */ + to: string + /** + * The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend. + */ + data: Record + /** + * The notification's parent ID + */ + parent_id: string | null + /** + * Available if the relation `parent_notification` is expanded. + */ + parent_notification?: Notification | null + /** + * The resends that have been completed after the original Notification. Available if the relation `resends` is expanded. + */ + resends?: Array + /** + * The id of the Notification Provider that handles the Notification. + */ + provider_id: string | null + /** + * Available if the relation `provider` is expanded. + */ + provider?: NotificationProvider | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string +} diff --git a/packages/generated/client-types/src/lib/models/NotificationProvider.ts b/packages/generated/client-types/src/lib/models/NotificationProvider.ts new file mode 100644 index 0000000000..164262742d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/NotificationProvider.ts @@ -0,0 +1,18 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a notification provider plugin and holds its installation status. + */ +export interface NotificationProvider { + /** + * The id of the notification provider as given by the plugin. + */ + id: string + /** + * Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`. + */ + is_installed: boolean +} diff --git a/packages/generated/client-types/src/lib/models/OAuth.ts b/packages/generated/client-types/src/lib/models/OAuth.ts new file mode 100644 index 0000000000..c4061a33fb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/OAuth.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represent an OAuth app + */ +export interface OAuth { + /** + * The app's ID + */ + id: string + /** + * The app's display name + */ + display_name: string + /** + * The app's name + */ + application_name: string + /** + * The URL to install the app + */ + install_url: string | null + /** + * The URL to uninstall the app + */ + uninstall_url: string | null + /** + * Any data necessary to the app. + */ + data: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Order.ts b/packages/generated/client-types/src/lib/models/Order.ts new file mode 100644 index 0000000000..6d04ca189a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Order.ts @@ -0,0 +1,258 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Address } from "./Address" +import type { Cart } from "./Cart" +import type { ClaimOrder } from "./ClaimOrder" +import type { Currency } from "./Currency" +import type { Customer } from "./Customer" +import type { Discount } from "./Discount" +import type { DraftOrder } from "./DraftOrder" +import type { Fulfillment } from "./Fulfillment" +import type { GiftCard } from "./GiftCard" +import type { GiftCardTransaction } from "./GiftCardTransaction" +import type { LineItem } from "./LineItem" +import type { OrderEdit } from "./OrderEdit" +import type { Payment } from "./Payment" +import type { Refund } from "./Refund" +import type { Region } from "./Region" +import type { Return } from "./Return" +import type { SalesChannel } from "./SalesChannel" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +/** + * Represents an order + */ +export interface Order { + /** + * The order's ID + */ + id: string + /** + * The order's status + */ + status: "pending" | "completed" | "archived" | "canceled" | "requires_action" + /** + * The order's fulfillment status + */ + fulfillment_status: + | "not_fulfilled" + | "partially_fulfilled" + | "fulfilled" + | "partially_shipped" + | "shipped" + | "partially_returned" + | "returned" + | "canceled" + | "requires_action" + /** + * The order's payment status + */ + payment_status: + | "not_paid" + | "awaiting" + | "captured" + | "partially_refunded" + | "refunded" + | "canceled" + | "requires_action" + /** + * The order's display ID + */ + display_id: number + /** + * The ID of the cart associated with the order + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The ID of the customer associated with the order + */ + customer_id: string + /** + * A customer object. Available if the relation `customer` is expanded. + */ + customer?: Customer | null + /** + * The email associated with the order + */ + email: string + /** + * The ID of the billing address associated with the order + */ + billing_address_id: string | null + /** + * Available if the relation `billing_address` is expanded. + */ + billing_address?: Address | null + /** + * The ID of the shipping address associated with the order + */ + shipping_address_id: string | null + /** + * Available if the relation `shipping_address` is expanded. + */ + shipping_address?: Address | null + /** + * The region's ID + */ + region_id: string + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * The 3 character currency code that is used in the order + */ + currency_code: string + /** + * Available if the relation `currency` is expanded. + */ + currency?: Currency | null + /** + * The order's tax rate + */ + tax_rate: number | null + /** + * The discounts used in the order. Available if the relation `discounts` is expanded. + */ + discounts?: Array + /** + * The gift cards used in the order. Available if the relation `gift_cards` is expanded. + */ + gift_cards?: Array + /** + * The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. + */ + shipping_methods?: Array + /** + * The payments used in the order. Available if the relation `payments` is expanded. + */ + payments?: Array + /** + * The fulfillments used in the order. Available if the relation `fulfillments` is expanded. + */ + fulfillments?: Array + /** + * The returns associated with the order. Available if the relation `returns` is expanded. + */ + returns?: Array + /** + * The claims associated with the order. Available if the relation `claims` is expanded. + */ + claims?: Array + /** + * The refunds associated with the order. Available if the relation `refunds` is expanded. + */ + refunds?: Array + /** + * The swaps associated with the order. Available if the relation `swaps` is expanded. + */ + swaps?: Array + /** + * The ID of the draft order this order is associated with. + */ + draft_order_id: string | null + /** + * A draft order object. Available if the relation `draft_order` is expanded. + */ + draft_order?: DraftOrder | null + /** + * The line items that belong to the order. Available if the relation `items` is expanded. + */ + items?: Array + /** + * Order edits done on the order. Available if the relation `edits` is expanded. + */ + edits?: Array + /** + * The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. + */ + gift_card_transactions?: Array + /** + * The date the order was canceled on. + */ + canceled_at: string | null + /** + * Flag for describing whether or not notifications related to this should be send. + */ + no_notification: boolean | null + /** + * Randomly generated key used to continue the processing of the order in case of failure. + */ + idempotency_key: string | null + /** + * The ID of an external order. + */ + external_id: string | null + /** + * The ID of the sales channel this order is associated with. + */ + sales_channel_id?: string | null + /** + * A sales channel object. Available if the relation `sales_channel` is expanded. + */ + sales_channel?: SalesChannel | null + /** + * The total of shipping + */ + shipping_total?: number + /** + * The total of discount + */ + discount_total?: number + /** + * The total of tax + */ + tax_total?: number + /** + * The total amount refunded if the order is returned. + */ + refunded_total?: number + /** + * The total amount of the order + */ + total?: number + /** + * The subtotal of the order + */ + subtotal?: number + /** + * The total amount paid + */ + paid_total?: number + /** + * The amount that can be refunded + */ + refundable_amount?: number + /** + * The total of gift cards + */ + gift_card_total?: number + /** + * The total of gift cards with taxes + */ + gift_card_tax_total?: number + /** + * The items that are returnable as part of the order, order swaps or order claims + */ + returnable_items?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/OrderEdit.ts b/packages/generated/client-types/src/lib/models/OrderEdit.ts new file mode 100644 index 0000000000..d42a386305 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/OrderEdit.ts @@ -0,0 +1,131 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { OrderItemChange } from "./OrderItemChange" +import type { PaymentCollection } from "./PaymentCollection" + +/** + * Order edit keeps track of order items changes. + */ +export interface OrderEdit { + /** + * The order edit's ID + */ + id: string + /** + * The ID of the order that is edited + */ + order_id: string + /** + * Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * Available if the relation `changes` is expanded. + */ + changes?: Array + /** + * An optional note with additional details about the order edit. + */ + internal_note: string | null + /** + * The unique identifier of the user or customer who created the order edit. + */ + created_by: string + /** + * The unique identifier of the user or customer who requested the order edit. + */ + requested_by: string | null + /** + * The date with timezone at which the edit was requested. + */ + requested_at: string | null + /** + * The unique identifier of the user or customer who confirmed the order edit. + */ + confirmed_by: string | null + /** + * The date with timezone at which the edit was confirmed. + */ + confirmed_at: string | null + /** + * The unique identifier of the user or customer who declined the order edit. + */ + declined_by: string | null + /** + * The date with timezone at which the edit was declined. + */ + declined_at: string | null + /** + * An optional note why the order edit is declined. + */ + declined_reason: string | null + /** + * The unique identifier of the user or customer who cancelled the order edit. + */ + canceled_by: string | null + /** + * The date with timezone at which the edit was cancelled. + */ + canceled_at: string | null + /** + * The total of subtotal + */ + subtotal?: number + /** + * The total of discount + */ + discount_total?: number + /** + * The total of the shipping amount + */ + shipping_total?: number + /** + * The total of the gift card amount + */ + gift_card_total?: number + /** + * The total of the gift card tax amount + */ + gift_card_tax_total?: number + /** + * The total of tax + */ + tax_total?: number + /** + * The total amount of the edited order. + */ + total?: number + /** + * The difference between the total amount of the order and total amount of edited order. + */ + difference_due?: number + /** + * The status of the order edit. + */ + status: "confirmed" | "declined" | "requested" | "created" | "canceled" + /** + * Available if the relation `items` is expanded. + */ + items?: Array + /** + * The ID of the payment collection + */ + payment_collection_id: string | null + /** + * Available if the relation `payment_collection` is expanded. + */ + payment_collection?: PaymentCollection | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string +} diff --git a/packages/generated/client-types/src/lib/models/OrderItemChange.ts b/packages/generated/client-types/src/lib/models/OrderItemChange.ts new file mode 100644 index 0000000000..123e57bea0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/OrderItemChange.ts @@ -0,0 +1,57 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" +import type { OrderEdit } from "./OrderEdit" + +/** + * Represents an order edit item change + */ +export interface OrderItemChange { + /** + * The order item change's ID + */ + id: string + /** + * The order item change's status + */ + type: "item_add" | "item_remove" | "item_update" + /** + * The ID of the order edit + */ + order_edit_id: string + /** + * Available if the relation `order_edit` is expanded. + */ + order_edit?: OrderEdit | null + /** + * The ID of the original line item in the order + */ + original_line_item_id: string | null + /** + * Available if the relation `original_line_item` is expanded. + */ + original_line_item?: LineItem | null + /** + * The ID of the cloned line item. + */ + line_item_id: string | null + /** + * Available if the relation `line_item` is expanded. + */ + line_item?: LineItem | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/Payment.ts b/packages/generated/client-types/src/lib/models/Payment.ts new file mode 100644 index 0000000000..9776c95e2b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Payment.ts @@ -0,0 +1,91 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { Currency } from "./Currency" +import type { Order } from "./Order" +import type { Swap } from "./Swap" + +/** + * Payments represent an amount authorized with a given payment method, Payments can be captured, canceled or refunded. + */ +export interface Payment { + /** + * The payment's ID + */ + id: string + /** + * The ID of the Swap that the Payment is used for. + */ + swap_id: string | null + /** + * A swap object. Available if the relation `swap` is expanded. + */ + swap?: Swap | null + /** + * The id of the Cart that the Payment Session is created for. + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The ID of the Order that the Payment is used for. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The amount that the Payment has been authorized for. + */ + amount: number + /** + * The 3 character ISO currency code that the Payment is completed in. + */ + currency_code: string + /** + * Available if the relation `currency` is expanded. + */ + currency?: Currency | null + /** + * The amount of the original Payment amount that has been refunded back to the Customer. + */ + amount_refunded: number + /** + * The id of the Payment Provider that is responsible for the Payment + */ + provider_id: string + /** + * The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state. + */ + data: Record + /** + * The date with timezone at which the Payment was captured. + */ + captured_at: string | null + /** + * The date with timezone at which the Payment was canceled. + */ + canceled_at: string | null + /** + * Randomly generated key used to continue the completion of a payment in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/PaymentCollection.ts b/packages/generated/client-types/src/lib/models/PaymentCollection.ts new file mode 100644 index 0000000000..a760c5673e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PaymentCollection.ts @@ -0,0 +1,88 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Currency } from "./Currency" +import type { Payment } from "./Payment" +import type { PaymentSession } from "./PaymentSession" +import type { Region } from "./Region" + +/** + * Payment Collection + */ +export interface PaymentCollection { + /** + * The payment collection's ID + */ + id: string + /** + * The type of the payment collection + */ + type: "order_edit" + /** + * The type of the payment collection + */ + status: + | "not_paid" + | "awaiting" + | "authorized" + | "partially_authorized" + | "canceled" + /** + * Description of the payment collection + */ + description: string | null + /** + * Amount of the payment collection. + */ + amount: number + /** + * Authorized amount of the payment collection. + */ + authorized_amount: number | null + /** + * The region's ID + */ + region_id: string + /** + * Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * The 3 character ISO code for the currency. + */ + currency_code: string + /** + * Available if the relation `currency` is expanded. + */ + currency?: Currency | null + /** + * Available if the relation `payment_sessions` is expanded. + */ + payment_sessions?: Array + /** + * Available if the relation `payments` is expanded. + */ + payments?: Array + /** + * The ID of the user that created the payment collection. + */ + created_by: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/PaymentProvider.ts b/packages/generated/client-types/src/lib/models/PaymentProvider.ts new file mode 100644 index 0000000000..fa63c3ab85 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PaymentProvider.ts @@ -0,0 +1,18 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a Payment Provider plugin and holds its installation status. + */ +export interface PaymentProvider { + /** + * The id of the payment provider as given by the plugin. + */ + id: string + /** + * Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`. + */ + is_installed: boolean +} diff --git a/packages/generated/client-types/src/lib/models/PaymentSession.ts b/packages/generated/client-types/src/lib/models/PaymentSession.ts new file mode 100644 index 0000000000..5b2a20a7fc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PaymentSession.ts @@ -0,0 +1,64 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" + +/** + * Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc. + */ +export interface PaymentSession { + /** + * The payment session's ID + */ + id: string + /** + * The id of the Cart that the Payment Session is created for. + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The id of the Payment Provider that is responsible for the Payment Session + */ + provider_id: string + /** + * A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase. + */ + is_selected: boolean | null + /** + * A flag to indicate if a communication with the third party provider has been initiated. + */ + is_initiated: boolean + /** + * Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer. + */ + status: "authorized" | "pending" | "requires_more" | "error" | "canceled" + /** + * The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state. + */ + data: Record + /** + * Randomly generated key used to continue the completion of a cart in case of failure. + */ + idempotency_key: string | null + /** + * The amount that the Payment Session has been authorized for. + */ + amount: number | null + /** + * The date with timezone at which the Payment Session was authorized. + */ + payment_authorized_at: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string +} diff --git a/packages/generated/client-types/src/lib/models/PriceList.ts b/packages/generated/client-types/src/lib/models/PriceList.ts new file mode 100644 index 0000000000..59fd51a8dd --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PriceList.ts @@ -0,0 +1,65 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { CustomerGroup } from "./CustomerGroup" +import type { MoneyAmount } from "./MoneyAmount" + +/** + * Price Lists represents a set of prices that overrides the default price for one or more product variants. + */ +export interface PriceList { + /** + * The price list's ID + */ + id: string + /** + * The price list's name + */ + name: string + /** + * The price list's description + */ + description: string + /** + * The type of Price List. This can be one of either `sale` or `override`. + */ + type: "sale" | "override" + /** + * The status of the Price List + */ + status: "active" | "draft" + /** + * The date with timezone that the Price List starts being valid. + */ + starts_at: string | null + /** + * The date with timezone that the Price List stops being valid. + */ + ends_at: string | null + /** + * The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded. + */ + customer_groups?: Array + /** + * The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. + */ + prices?: Array + /** + * [EXPERIMENTAL] Does the price list prices include tax + */ + includes_tax?: boolean + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/PricedProduct.ts b/packages/generated/client-types/src/lib/models/PricedProduct.ts new file mode 100644 index 0000000000..ae31b3bc55 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PricedProduct.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedVariant } from "./PricedVariant" +import type { Product } from "./Product" + +export type PricedProduct = Product & { + variants?: Array +} diff --git a/packages/generated/client-types/src/lib/models/PricedShippingOption.ts b/packages/generated/client-types/src/lib/models/PricedShippingOption.ts new file mode 100644 index 0000000000..0790aa8dae --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PricedShippingOption.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ShippingOption } from "./ShippingOption" + +export type PricedShippingOption = ShippingOption & { + /** + * Price including taxes + */ + price_incl_tax?: number + /** + * An array of applied tax rates + */ + tax_rates?: Array<{ + /** + * The tax rate value + */ + rate?: number + /** + * The name of the tax rate + */ + name?: string + /** + * The code of the tax rate + */ + code?: string + }> + /** + * The taxes applied. + */ + tax_amount?: number +} diff --git a/packages/generated/client-types/src/lib/models/PricedVariant.ts b/packages/generated/client-types/src/lib/models/PricedVariant.ts new file mode 100644 index 0000000000..cc5010a5b8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PricedVariant.ts @@ -0,0 +1,50 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductVariant } from "./ProductVariant" + +export type PricedVariant = ProductVariant & { + /** + * The original price of the variant without any discounted prices applied. + */ + original_price?: number + /** + * The calculated price of the variant. Can be a discounted price. + */ + calculated_price?: number + /** + * The original price of the variant including taxes. + */ + original_price_incl_tax?: number + /** + * The calculated price of the variant including taxes. + */ + calculated_price_incl_tax?: number + /** + * The taxes applied on the original price. + */ + original_tax?: number + /** + * The taxes applied on the calculated price. + */ + calculated_tax?: number + /** + * An array of applied tax rates + */ + tax_rates?: Array<{ + /** + * The tax rate value + */ + rate?: number + /** + * The name of the tax rate + */ + name?: string + /** + * The code of the tax rate + */ + code?: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/Product.ts b/packages/generated/client-types/src/lib/models/Product.ts new file mode 100644 index 0000000000..295cb58633 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Product.ts @@ -0,0 +1,156 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Image } from "./Image" +import type { ProductCategory } from "./ProductCategory" +import type { ProductCollection } from "./ProductCollection" +import type { ProductOption } from "./ProductOption" +import type { ProductTag } from "./ProductTag" +import type { ProductType } from "./ProductType" +import type { ProductVariant } from "./ProductVariant" +import type { SalesChannel } from "./SalesChannel" +import type { ShippingProfile } from "./ShippingProfile" + +/** + * Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by. + */ +export interface Product { + /** + * The product's ID + */ + id: string + /** + * A title that can be displayed for easy identification of the Product. + */ + title: string + /** + * An optional subtitle that can be used to further specify the Product. + */ + subtitle: string | null + /** + * A short description of the Product. + */ + description: string | null + /** + * A unique identifier for the Product (e.g. for slug structure). + */ + handle: string | null + /** + * Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased. + */ + is_giftcard: boolean + /** + * The status of the product + */ + status: "draft" | "proposed" | "published" | "rejected" + /** + * Images of the Product. Available if the relation `images` is expanded. + */ + images?: Array + /** + * A URL to an image file that can be used to identify the Product. + */ + thumbnail: string | null + /** + * The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded. + */ + options?: Array + /** + * The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded. + */ + variants?: Array + /** + * The product's associated categories. Available if the relation `categories` are expanded. + */ + categories?: Array + /** + * The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. + */ + profile_id: string + /** + * Available if the relation `profile` is expanded. + */ + profile?: ShippingProfile | null + /** + * The weight of the Product Variant. May be used in shipping rate calculations. + */ + weight: number | null + /** + * The length of the Product Variant. May be used in shipping rate calculations. + */ + length: number | null + /** + * The height of the Product Variant. May be used in shipping rate calculations. + */ + height: number | null + /** + * The width of the Product Variant. May be used in shipping rate calculations. + */ + width: number | null + /** + * The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + hs_code: string | null + /** + * The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + origin_country: string | null + /** + * The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + mid_code: string | null + /** + * The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + material: string | null + /** + * The Product Collection that the Product belongs to + */ + collection_id: string | null + /** + * A product collection object. Available if the relation `collection` is expanded. + */ + collection?: ProductCollection | null + /** + * The Product type that the Product belongs to + */ + type_id: string | null + /** + * Available if the relation `type` is expanded. + */ + type?: ProductType | null + /** + * The Product Tags assigned to the Product. Available if the relation `tags` is expanded. + */ + tags?: Array + /** + * Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`. + */ + discountable: boolean + /** + * The external ID of the product + */ + external_id: string | null + /** + * The sales channels the product is associated with. Available if the relation `sales_channels` is expanded. + */ + sales_channels?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductCategory.ts b/packages/generated/client-types/src/lib/models/ProductCategory.ts new file mode 100644 index 0000000000..58a0e95386 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductCategory.ts @@ -0,0 +1,68 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" + +/** + * Represents a product category + */ +export interface ProductCategory { + /** + * The product category's ID + */ + id: string + /** + * The product category's name + */ + name: string + /** + * A unique string that identifies the Product Category - can for example be used in slug structures. + */ + handle: string + /** + * A string for Materialized Paths - used for finding ancestors and descendents + */ + mpath: string | null + /** + * A flag to make product category an internal category for admins + */ + is_internal: boolean + /** + * A flag to make product category visible/hidden in the store front + */ + is_active: boolean + /** + * An integer that depicts the rank of category in a tree node + */ + rank?: number + /** + * Available if the relation `category_children` are expanded. + */ + category_children: Array + /** + * The ID of the parent category. + */ + parent_category_id: string | null + /** + * A product category object. Available if the relation `parent_category` is expanded. + */ + parent_category?: ProductCategory | null + /** + * Products associated with category. Available if the relation `products` is expanded. + */ + products?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductCollection.ts b/packages/generated/client-types/src/lib/models/ProductCollection.ts new file mode 100644 index 0000000000..db7597bae8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductCollection.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" + +/** + * Product Collections represents a group of Products that are related. + */ +export interface ProductCollection { + /** + * The product collection's ID + */ + id: string + /** + * The title that the Product Collection is identified by. + */ + title: string + /** + * A unique string that identifies the Product Collection - can for example be used in slug structures. + */ + handle: string | null + /** + * The Products contained in the Product Collection. Available if the relation `products` is expanded. + */ + products?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductOption.ts b/packages/generated/client-types/src/lib/models/ProductOption.ts new file mode 100644 index 0000000000..37069b9f33 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductOption.ts @@ -0,0 +1,49 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" +import type { ProductOptionValue } from "./ProductOptionValue" + +/** + * Product Options define properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color", but Medusa doesn't limit what Product Options that can be defined. + */ +export interface ProductOption { + /** + * The product option's ID + */ + id: string + /** + * The title that the Product Option is defined by (e.g. `Size`). + */ + title: string + /** + * The Product Option Values that are defined for the Product Option. Available if the relation `values` is expanded. + */ + values?: Array + /** + * The ID of the Product that the Product Option is defined for. + */ + product_id: string + /** + * A product object. Available if the relation `product` is expanded. + */ + product?: Product | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductOptionValue.ts b/packages/generated/client-types/src/lib/models/ProductOptionValue.ts new file mode 100644 index 0000000000..6c7e914c7b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductOptionValue.ts @@ -0,0 +1,53 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductOption } from "./ProductOption" +import type { ProductVariant } from "./ProductVariant" + +/** + * A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product. + */ +export interface ProductOptionValue { + /** + * The product option value's ID + */ + id: string + /** + * The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`). + */ + value: string + /** + * The ID of the Product Option that the Product Option Value is defined for. + */ + option_id: string + /** + * Available if the relation `option` is expanded. + */ + option?: ProductOption | null + /** + * The ID of the Product Variant that the Product Option Value is defined for. + */ + variant_id: string + /** + * Available if the relation `variant` is expanded. + */ + variant?: ProductVariant | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductTag.ts b/packages/generated/client-types/src/lib/models/ProductTag.ts new file mode 100644 index 0000000000..2b3fb9a54a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductTag.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Product Tags can be added to Products for easy filtering and grouping. + */ +export interface ProductTag { + /** + * The product tag's ID + */ + id: string + /** + * The value that the Product Tag represents + */ + value: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductTaxRate.ts b/packages/generated/client-types/src/lib/models/ProductTaxRate.ts new file mode 100644 index 0000000000..ebf168857b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductTaxRate.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" +import type { TaxRate } from "./TaxRate" + +/** + * Associates a tax rate with a product to indicate that the product is taxed in a certain way + */ +export interface ProductTaxRate { + /** + * The ID of the Product + */ + product_id: string + /** + * Available if the relation `product` is expanded. + */ + product?: Product | null + /** + * The ID of the Tax Rate + */ + rate_id: string + /** + * Available if the relation `tax_rate` is expanded. + */ + tax_rate?: TaxRate | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductType.ts b/packages/generated/client-types/src/lib/models/ProductType.ts new file mode 100644 index 0000000000..04adaf09a3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductType.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Product Type can be added to Products for filtering and reporting purposes. + */ +export interface ProductType { + /** + * The product type's ID + */ + id: string + /** + * The value that the Product Type represents. + */ + value: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductTypeTaxRate.ts b/packages/generated/client-types/src/lib/models/ProductTypeTaxRate.ts new file mode 100644 index 0000000000..22bd4e8499 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductTypeTaxRate.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductType } from "./ProductType" +import type { TaxRate } from "./TaxRate" + +/** + * Associates a tax rate with a product type to indicate that the product type is taxed in a certain way + */ +export interface ProductTypeTaxRate { + /** + * The ID of the Product type + */ + product_type_id: string + /** + * Available if the relation `product_type` is expanded. + */ + product_type?: ProductType | null + /** + * The id of the Tax Rate + */ + rate_id: string + /** + * Available if the relation `tax_rate` is expanded. + */ + tax_rate?: TaxRate | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductVariant.ts b/packages/generated/client-types/src/lib/models/ProductVariant.ts new file mode 100644 index 0000000000..e96c086de8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductVariant.ts @@ -0,0 +1,123 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { MoneyAmount } from "./MoneyAmount" +import type { Product } from "./Product" +import type { ProductOptionValue } from "./ProductOptionValue" +import type { ProductVariantInventoryItem } from "./ProductVariantInventoryItem" + +/** + * Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. + */ +export interface ProductVariant { + /** + * The product variant's ID + */ + id: string + /** + * A title that can be displayed for easy identification of the Product Variant. + */ + title: string + /** + * The ID of the Product that the Product Variant belongs to. + */ + product_id: string + /** + * A product object. Available if the relation `product` is expanded. + */ + product?: Product | null + /** + * The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded. + */ + prices?: Array + /** + * The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems. + */ + sku: string | null + /** + * A generic field for a GTIN number that can be used to identify the Product Variant. + */ + barcode: string | null + /** + * An EAN barcode number that can be used to identify the Product Variant. + */ + ean: string | null + /** + * A UPC barcode number that can be used to identify the Product Variant. + */ + upc: string | null + /** + * The ranking of this variant + */ + variant_rank?: number | null + /** + * The current quantity of the item that is stocked. + */ + inventory_quantity: number + /** + * Whether the Product Variant should be purchasable when `inventory_quantity` is 0. + */ + allow_backorder: boolean + /** + * Whether Medusa should manage inventory for the Product Variant. + */ + manage_inventory: boolean + /** + * The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + hs_code: string | null + /** + * The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + origin_country: string | null + /** + * The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + mid_code: string | null + /** + * The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + */ + material: string | null + /** + * The weight of the Product Variant. May be used in shipping rate calculations. + */ + weight: number | null + /** + * The length of the Product Variant. May be used in shipping rate calculations. + */ + length: number | null + /** + * The height of the Product Variant. May be used in shipping rate calculations. + */ + height: number | null + /** + * The width of the Product Variant. May be used in shipping rate calculations. + */ + width: number | null + /** + * The Product Option Values specified for the Product Variant. Available if the relation `options` is expanded. + */ + options?: Array + /** + * The Inventory Items related to the product variant. Available if the relation `inventory_items` is expanded. + */ + inventory_items?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ProductVariantInventoryItem.ts b/packages/generated/client-types/src/lib/models/ProductVariantInventoryItem.ts new file mode 100644 index 0000000000..a7b5a4f000 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ProductVariantInventoryItem.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductVariant } from "./ProductVariant" + +/** + * Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant. + */ +export interface ProductVariantInventoryItem { + /** + * The product variant inventory item's ID + */ + id: string + /** + * The id of the inventory item + */ + inventory_item_id: string + /** + * The id of the variant. + */ + variant_id: string + /** + * A ProductVariant object. Available if the relation `variant` is expanded. + */ + variant?: ProductVariant | null + /** + * The quantity of an inventory item required for one quantity of the variant. + */ + required_quantity: number + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/PublishableApiKey.ts b/packages/generated/client-types/src/lib/models/PublishableApiKey.ts new file mode 100644 index 0000000000..8b7a8538bd --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PublishableApiKey.ts @@ -0,0 +1,38 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Publishable API key defines scopes (i.e. resources) that are available within a request. + */ +export interface PublishableApiKey { + /** + * The key's ID + */ + id: string + /** + * The unique identifier of the user that created the key. + */ + created_by: string | null + /** + * The unique identifier of the user that revoked the key. + */ + revoked_by: string | null + /** + * The date with timezone at which the key was revoked. + */ + revoked_at: string | null + /** + * The key's title. + */ + title: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string +} diff --git a/packages/generated/client-types/src/lib/models/PublishableApiKeySalesChannel.ts b/packages/generated/client-types/src/lib/models/PublishableApiKeySalesChannel.ts new file mode 100644 index 0000000000..b569c400c5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/PublishableApiKeySalesChannel.ts @@ -0,0 +1,18 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Holds mapping between Publishable API keys and Sales Channels + */ +export interface PublishableApiKeySalesChannel { + /** + * The sales channel's ID + */ + sales_channel_id: string + /** + * The publishable API key's ID + */ + publishable_key_id: string +} diff --git a/packages/generated/client-types/src/lib/models/Refund.ts b/packages/generated/client-types/src/lib/models/Refund.ts new file mode 100644 index 0000000000..abde9ee666 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Refund.ts @@ -0,0 +1,61 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Order } from "./Order" +import type { Payment } from "./Payment" + +/** + * Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator. + */ +export interface Refund { + /** + * The refund's ID + */ + id: string + /** + * The id of the Order that the Refund is related to. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The payment's ID if available + */ + payment_id: string | null + /** + * Available if the relation `payment` is expanded. + */ + payment?: Payment | null + /** + * The amount that has be refunded to the Customer. + */ + amount: number + /** + * An optional note explaining why the amount was refunded. + */ + note: string | null + /** + * The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return. + */ + reason: "discount" | "return" | "swap" | "claim" | "other" + /** + * Randomly generated key used to continue the completion of the refund in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/Region.ts b/packages/generated/client-types/src/lib/models/Region.ts new file mode 100644 index 0000000000..788218a580 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Region.ts @@ -0,0 +1,93 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Country } from "./Country" +import type { Currency } from "./Currency" +import type { FulfillmentProvider } from "./FulfillmentProvider" +import type { PaymentProvider } from "./PaymentProvider" +import type { TaxProvider } from "./TaxProvider" +import type { TaxRate } from "./TaxRate" + +/** + * Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries. + */ +export interface Region { + /** + * The region's ID + */ + id: string + /** + * The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name. + */ + name: string + /** + * The 3 character currency code that the Region uses. + */ + currency_code: string + /** + * Available if the relation `currency` is expanded. + */ + currency?: Currency | null + /** + * The tax rate that should be charged on purchases in the Region. + */ + tax_rate: number + /** + * The tax rates that are included in the Region. Available if the relation `tax_rates` is expanded. + */ + tax_rates?: Array + /** + * The tax code used on purchases in the Region. This may be used by other systems for accounting purposes. + */ + tax_code: string | null + /** + * Whether the gift cards are taxable or not in this region. + */ + gift_cards_taxable: boolean + /** + * Whether taxes should be automated in this region. + */ + automatic_taxes: boolean + /** + * The countries that are included in the Region. Available if the relation `countries` is expanded. + */ + countries?: Array + /** + * The ID of the tax provider used in this region + */ + tax_provider_id: string | null + /** + * Available if the relation `tax_provider` is expanded. + */ + tax_provider?: TaxProvider | null + /** + * The Payment Providers that can be used to process Payments in the Region. Available if the relation `payment_providers` is expanded. + */ + payment_providers?: Array + /** + * The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `fulfillment_providers` is expanded. + */ + fulfillment_providers?: Array + /** + * [EXPERIMENTAL] Does the prices for the region include tax + */ + includes_tax?: boolean + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ReservationItemDTO.ts b/packages/generated/client-types/src/lib/models/ReservationItemDTO.ts new file mode 100644 index 0000000000..39b46e6e42 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ReservationItemDTO.ts @@ -0,0 +1,42 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a reservation of an inventory item at a stock location + */ +export interface ReservationItemDTO { + /** + * The id of the reservation item + */ + id: string + /** + * The id of the location of the reservation + */ + location_id: string + /** + * The id of the inventory item the reservation relates to + */ + inventory_item_id: string + /** + * The id of the reservation item + */ + quantity: number + /** + * An optional key-value map with additional details + */ + metadata?: Record + /** + * The date with timezone at which the resource was created. + */ + created_at?: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at?: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at?: string +} diff --git a/packages/generated/client-types/src/lib/models/ResponseInventoryItem.ts b/packages/generated/client-types/src/lib/models/ResponseInventoryItem.ts new file mode 100644 index 0000000000..d34f6276b4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ResponseInventoryItem.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { InventoryItemDTO } from "./InventoryItemDTO" + +export type ResponseInventoryItem = InventoryItemDTO & { + available_quantity: number +} diff --git a/packages/generated/client-types/src/lib/models/Return.ts b/packages/generated/client-types/src/lib/models/Return.ts new file mode 100644 index 0000000000..339dd05e10 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Return.ts @@ -0,0 +1,92 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimOrder } from "./ClaimOrder" +import type { Order } from "./Order" +import type { ReturnItem } from "./ReturnItem" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +/** + * Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap. + */ +export interface Return { + /** + * The return's ID + */ + id: string + /** + * Status of the Return. + */ + status: "requested" | "received" | "requires_action" | "canceled" + /** + * The Return Items that will be shipped back to the warehouse. Available if the relation `items` is expanded. + */ + items?: Array + /** + * The ID of the Swap that the Return is a part of. + */ + swap_id: string | null + /** + * A swap object. Available if the relation `swap` is expanded. + */ + swap?: Swap | null + /** + * The ID of the Claim that the Return is a part of. + */ + claim_order_id: string | null + /** + * A claim order object. Available if the relation `claim_order` is expanded. + */ + claim_order?: ClaimOrder | null + /** + * The ID of the Order that the Return is made from. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. + */ + shipping_method?: ShippingMethod | null + /** + * Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment. + */ + shipping_data: Record | null + /** + * The id of the stock location the return will be added back. + */ + location_id: string | null + /** + * The amount that should be refunded as a result of the return. + */ + refund_amount: number + /** + * When set to true, no notification will be sent related to this return. + */ + no_notification: boolean | null + /** + * Randomly generated key used to continue the completion of the return in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the return was received. + */ + received_at: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ReturnItem.ts b/packages/generated/client-types/src/lib/models/ReturnItem.ts new file mode 100644 index 0000000000..e998751653 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ReturnItem.ts @@ -0,0 +1,62 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" +import type { Return } from "./Return" +import type { ReturnReason } from "./ReturnReason" + +/** + * Correlates a Line Item with a Return, keeping track of the quantity of the Line Item that will be returned. + */ +export interface ReturnItem { + /** + * The id of the Return that the Return Item belongs to. + */ + return_id: string + /** + * The id of the Line Item that the Return Item references. + */ + item_id: string + /** + * Available if the relation `return_order` is expanded. + */ + return_order?: Return | null + /** + * Available if the relation `item` is expanded. + */ + item?: LineItem | null + /** + * The quantity of the Line Item that is included in the Return. + */ + quantity: number + /** + * Whether the Return Item was requested initially or received unexpectedly in the warehouse. + */ + is_requested: boolean + /** + * The quantity that was originally requested to be returned. + */ + requested_quantity: number | null + /** + * The quantity that was received in the warehouse. + */ + received_quantity: number | null + /** + * The ID of the reason for returning the item. + */ + reason_id: string | null + /** + * Available if the relation `reason` is expanded. + */ + reason?: ReturnReason | null + /** + * An optional note with additional details about the Return. + */ + note: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ReturnReason.ts b/packages/generated/client-types/src/lib/models/ReturnReason.ts new file mode 100644 index 0000000000..bf4266ec6a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ReturnReason.ts @@ -0,0 +1,54 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * A Reason for why a given product is returned. A Return Reason can be used on Return Items in order to indicate why a Line Item was returned. + */ +export interface ReturnReason { + /** + * The return reason's ID + */ + id: string + /** + * The value to identify the reason by. + */ + value: string + /** + * A text that can be displayed to the Customer as a reason. + */ + label: string + /** + * A description of the Reason. + */ + description: string | null + /** + * The ID of the parent reason. + */ + parent_return_reason_id: string | null + /** + * Available if the relation `parent_return_reason` is expanded. + */ + parent_return_reason?: ReturnReason | null + /** + * Available if the relation `return_reason_children` is expanded. + */ + return_reason_children?: ReturnReason + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/SalesChannel.ts b/packages/generated/client-types/src/lib/models/SalesChannel.ts new file mode 100644 index 0000000000..bedf7a6e1d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/SalesChannel.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { SalesChannelLocation } from "./SalesChannelLocation" + +/** + * A Sales Channel + */ +export interface SalesChannel { + /** + * The sales channel's ID + */ + id: string + /** + * The name of the sales channel. + */ + name: string + /** + * The description of the sales channel. + */ + description: string | null + /** + * Specify if the sales channel is enabled or disabled. + */ + is_disabled: boolean + /** + * The Stock Locations related to the sales channel. Available if the relation `locations` is expanded. + */ + locations?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/SalesChannelLocation.ts b/packages/generated/client-types/src/lib/models/SalesChannelLocation.ts new file mode 100644 index 0000000000..88a1fe6546 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/SalesChannelLocation.ts @@ -0,0 +1,40 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { SalesChannel } from "./SalesChannel" + +/** + * Sales Channel Stock Location link sales channels with stock locations. + */ +export interface SalesChannelLocation { + /** + * The Sales Channel Stock Location's ID + */ + id: string + /** + * The id of the Sales Channel + */ + sales_channel_id: string + /** + * The id of the Location Stock. + */ + location_id: string + /** + * The sales channel the location is associated with. Available if the relation `sales_channel` is expanded. + */ + sales_channel?: SalesChannel | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/ShippingMethod.ts b/packages/generated/client-types/src/lib/models/ShippingMethod.ts new file mode 100644 index 0000000000..4ebe72798a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ShippingMethod.ts @@ -0,0 +1,98 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { ClaimOrder } from "./ClaimOrder" +import type { Order } from "./Order" +import type { Return } from "./Return" +import type { ShippingMethodTaxLine } from "./ShippingMethodTaxLine" +import type { ShippingOption } from "./ShippingOption" +import type { Swap } from "./Swap" + +/** + * Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment. + */ +export interface ShippingMethod { + /** + * The shipping method's ID + */ + id: string + /** + * The id of the Shipping Option that the Shipping Method is built from. + */ + shipping_option_id: string + /** + * The id of the Order that the Shipping Method is used on. + */ + order_id: string | null + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The id of the Claim that the Shipping Method is used on. + */ + claim_order_id: string | null + /** + * A claim order object. Available if the relation `claim_order` is expanded. + */ + claim_order?: ClaimOrder | null + /** + * The id of the Cart that the Shipping Method is used on. + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The id of the Swap that the Shipping Method is used on. + */ + swap_id: string | null + /** + * A swap object. Available if the relation `swap` is expanded. + */ + swap?: Swap | null + /** + * The id of the Return that the Shipping Method is used on. + */ + return_id: string | null + /** + * A return object. Available if the relation `return_order` is expanded. + */ + return_order?: Return | null + /** + * Available if the relation `shipping_option` is expanded. + */ + shipping_option?: ShippingOption | null + /** + * Available if the relation `tax_lines` is expanded. + */ + tax_lines?: Array + /** + * The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of. + */ + price: number + /** + * Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id. + */ + data: Record + /** + * [EXPERIMENTAL] Indicates if the shipping method price include tax + */ + includes_tax?: boolean + /** + * The subtotal of the shipping + */ + subtotal?: number + /** + * The total amount of the shipping + */ + total?: number + /** + * The total of tax + */ + tax_total?: number +} diff --git a/packages/generated/client-types/src/lib/models/ShippingMethodTaxLine.ts b/packages/generated/client-types/src/lib/models/ShippingMethodTaxLine.ts new file mode 100644 index 0000000000..9dfd76b4eb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ShippingMethodTaxLine.ts @@ -0,0 +1,48 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ShippingMethod } from "./ShippingMethod" + +/** + * Shipping Method Tax Line + */ +export interface ShippingMethodTaxLine { + /** + * The line item tax line's ID + */ + id: string + /** + * A code to identify the tax type by + */ + code: string | null + /** + * A human friendly name for the tax + */ + name: string + /** + * The numeric rate to charge tax by + */ + rate: number + /** + * The ID of the line item + */ + shipping_method_id: string + /** + * Available if the relation `shipping_method` is expanded. + */ + shipping_method?: ShippingMethod | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ShippingOption.ts b/packages/generated/client-types/src/lib/models/ShippingOption.ts new file mode 100644 index 0000000000..9b2ec83172 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ShippingOption.ts @@ -0,0 +1,91 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { FulfillmentProvider } from "./FulfillmentProvider" +import type { Region } from "./Region" +import type { ShippingOptionRequirement } from "./ShippingOptionRequirement" +import type { ShippingProfile } from "./ShippingProfile" + +/** + * Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information. + */ +export interface ShippingOption { + /** + * The shipping option's ID + */ + id: string + /** + * The name given to the Shipping Option - this may be displayed to the Customer. + */ + name: string + /** + * The region's ID + */ + region_id: string + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products. + */ + profile_id: string + /** + * Available if the relation `profile` is expanded. + */ + profile?: ShippingProfile | null + /** + * The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option. + */ + provider_id: string + /** + * Available if the relation `provider` is expanded. + */ + provider?: FulfillmentProvider | null + /** + * The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations. + */ + price_type: "flat_rate" | "calculated" + /** + * The amount to charge for shipping when the Shipping Option price type is `flat_rate`. + */ + amount: number | null + /** + * Flag to indicate if the Shipping Option can be used for Return shipments. + */ + is_return: boolean + /** + * Flag to indicate if the Shipping Option usage is restricted to admin users. + */ + admin_only: boolean + /** + * The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded. + */ + requirements?: Array + /** + * The data needed for the Fulfillment Provider to identify the Shipping Option. + */ + data: Record + /** + * [EXPERIMENTAL] Does the shipping option price include tax + */ + includes_tax?: boolean + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ShippingOptionRequirement.ts b/packages/generated/client-types/src/lib/models/ShippingOptionRequirement.ts new file mode 100644 index 0000000000..72f9355a8a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ShippingOptionRequirement.ts @@ -0,0 +1,36 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ShippingOption } from "./ShippingOption" + +/** + * A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart. + */ +export interface ShippingOptionRequirement { + /** + * The shipping option requirement's ID + */ + id: string + /** + * The id of the Shipping Option that the hipping option requirement belongs to + */ + shipping_option_id: string + /** + * Available if the relation `shipping_option` is expanded. + */ + shipping_option?: ShippingOption | null + /** + * The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available. + */ + type: "min_subtotal" | "max_subtotal" + /** + * The amount to compare the Cart subtotal to. + */ + amount: number + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null +} diff --git a/packages/generated/client-types/src/lib/models/ShippingProfile.ts b/packages/generated/client-types/src/lib/models/ShippingProfile.ts new file mode 100644 index 0000000000..255b7c9998 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ShippingProfile.ts @@ -0,0 +1,49 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" +import type { ShippingOption } from "./ShippingOption" + +/** + * Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products. + */ +export interface ShippingProfile { + /** + * The shipping profile's ID + */ + id: string + /** + * The name given to the Shipping profile - this may be displayed to the Customer. + */ + name: string + /** + * The type of the Shipping Profile, may be `default`, `gift_card` or `custom`. + */ + type: "default" | "gift_card" | "custom" + /** + * The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded. + */ + products?: Array + /** + * The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded. + */ + shipping_options?: Array + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/ShippingTaxRate.ts b/packages/generated/client-types/src/lib/models/ShippingTaxRate.ts new file mode 100644 index 0000000000..308678302c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/ShippingTaxRate.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ShippingOption } from "./ShippingOption" +import type { TaxRate } from "./TaxRate" + +/** + * Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way + */ +export interface ShippingTaxRate { + /** + * The ID of the Shipping Option + */ + shipping_option_id: string + /** + * Available if the relation `shipping_option` is expanded. + */ + shipping_option?: ShippingOption | null + /** + * The ID of the Tax Rate + */ + rate_id: string + /** + * Available if the relation `tax_rate` is expanded. + */ + tax_rate?: TaxRate | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/StagedJob.ts b/packages/generated/client-types/src/lib/models/StagedJob.ts new file mode 100644 index 0000000000..328cbbb82c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StagedJob.ts @@ -0,0 +1,26 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * A staged job resource + */ +export interface StagedJob { + /** + * The staged job's ID + */ + id: string + /** + * The name of the event + */ + event_name: string + /** + * Data necessary for the job + */ + data: Record + /** + * The staged job's option + */ + option?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StockLocationAddressDTO.ts b/packages/generated/client-types/src/lib/models/StockLocationAddressDTO.ts new file mode 100644 index 0000000000..8186e94a89 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StockLocationAddressDTO.ts @@ -0,0 +1,62 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a Stock Location Address + */ +export interface StockLocationAddressDTO { + /** + * The stock location address' ID + */ + id?: string + /** + * Stock location address + */ + address_1: string + /** + * Stock location address' complement + */ + address_2?: string + /** + * Stock location company' name + */ + company?: string + /** + * Stock location address' city + */ + city?: string + /** + * Stock location address' country + */ + country_code: string + /** + * Stock location address' phone number + */ + phone?: string + /** + * Stock location address' postal code + */ + postal_code?: string + /** + * Stock location address' province + */ + province?: string + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at?: string + /** + * An optional key-value map with additional details + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StockLocationAddressInput.ts b/packages/generated/client-types/src/lib/models/StockLocationAddressInput.ts new file mode 100644 index 0000000000..230174ea95 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StockLocationAddressInput.ts @@ -0,0 +1,42 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a Stock Location Address Input + */ +export interface StockLocationAddressInput { + /** + * Stock location address + */ + address_1: string + /** + * Stock location address' complement + */ + address_2?: string + /** + * Stock location address' city + */ + city?: string + /** + * Stock location address' country + */ + country_code: string + /** + * Stock location address' phone number + */ + phone?: string + /** + * Stock location address' postal code + */ + postal_code?: string + /** + * Stock location address' province + */ + province?: string + /** + * An optional key-value map with additional details + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StockLocationDTO.ts b/packages/generated/client-types/src/lib/models/StockLocationDTO.ts new file mode 100644 index 0000000000..41b3e7b91d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StockLocationDTO.ts @@ -0,0 +1,44 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationAddressDTO } from "./StockLocationAddressDTO" + +/** + * Represents a Stock Location + */ +export interface StockLocationDTO { + /** + * The stock location's ID + */ + id: string + /** + * Stock location address' ID + */ + address_id: string + /** + * The name of the stock location + */ + name: string + /** + * The Address of the Stock Location + */ + address?: StockLocationAddressDTO & Record + /** + * An optional key-value map with additional details + */ + metadata?: Record + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at?: string +} diff --git a/packages/generated/client-types/src/lib/models/StockLocationExpandedDTO.ts b/packages/generated/client-types/src/lib/models/StockLocationExpandedDTO.ts new file mode 100644 index 0000000000..33760133e2 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StockLocationExpandedDTO.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { SalesChannel } from "./SalesChannel" +import type { StockLocationDTO } from "./StockLocationDTO" + +export type StockLocationExpandedDTO = StockLocationDTO & { + sales_channels?: SalesChannel +} diff --git a/packages/generated/client-types/src/lib/models/Store.ts b/packages/generated/client-types/src/lib/models/Store.ts new file mode 100644 index 0000000000..9d554c6556 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Store.ts @@ -0,0 +1,69 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Currency } from "./Currency" +import type { SalesChannel } from "./SalesChannel" + +/** + * Holds settings for the Store, such as name, currencies, etc. + */ +export interface Store { + /** + * The store's ID + */ + id: string + /** + * The name of the Store - this may be displayed to the Customer. + */ + name: string + /** + * The 3 character currency code that is the default of the store. + */ + default_currency_code: string + /** + * Available if the relation `default_currency` is expanded. + */ + default_currency?: Currency | null + /** + * The currencies that are enabled for the Store. Available if the relation `currencies` is expanded. + */ + currencies?: Array + /** + * A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. + */ + swap_link_template: string | null + /** + * A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. + */ + payment_link_template: string | null + /** + * A template to generate Invite links from + */ + invite_link_template: string | null + /** + * The location ID the store is associated with. + */ + default_location_id: string | null + /** + * The sales channel ID the cart is associated with. + */ + default_sales_channel_id?: string | null + /** + * A sales channel object. Available if the relation `default_sales_channel` is expanded. + */ + default_sales_channel?: SalesChannel | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/StoreAuthRes.ts b/packages/generated/client-types/src/lib/models/StoreAuthRes.ts new file mode 100644 index 0000000000..108933be43 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreAuthRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" +import type { Order } from "./Order" + +export interface StoreAuthRes { + customer: Merge< + SetRelation, + { + orders: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreCartShippingOptionsListRes.ts b/packages/generated/client-types/src/lib/models/StoreCartShippingOptionsListRes.ts new file mode 100644 index 0000000000..d587d53eed --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCartShippingOptionsListRes.ts @@ -0,0 +1,12 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedShippingOption } from "./PricedShippingOption" + +export interface StoreCartShippingOptionsListRes { + shipping_options: Array< + SetRelation + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreCartsRes.ts b/packages/generated/client-types/src/lib/models/StoreCartsRes.ts new file mode 100644 index 0000000000..c5864d0ada --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCartsRes.ts @@ -0,0 +1,73 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { Discount } from "./Discount" +import type { LineItem } from "./LineItem" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" +import type { ShippingMethod } from "./ShippingMethod" + +export interface StoreCartsRes { + cart: Merge< + SetRelation< + Cart, + | "billing_address" + | "discounts" + | "gift_cards" + | "items" + | "payment" + | "payment_sessions" + | "region" + | "shipping_address" + | "shipping_methods" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "item_tax_total" + | "refundable_amount" + | "refunded_total" + | "shipping_tax_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + >, + { + discounts: Array> + items: Array< + Merge< + SetRelation< + LineItem, + | "adjustments" + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "tax_lines" + >, + { + variant: SetRelation + } + > + > + region: SetRelation< + Region, + | "countries" + | "payment_providers" + | "tax_rates" + | "fulfillment_providers" + > + shipping_methods: Array< + SetRelation + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreCollectionsListRes.ts b/packages/generated/client-types/src/lib/models/StoreCollectionsListRes.ts new file mode 100644 index 0000000000..a3a57dd495 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCollectionsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCollection } from "./ProductCollection" + +export interface StoreCollectionsListRes { + collections: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreCollectionsRes.ts b/packages/generated/client-types/src/lib/models/StoreCollectionsRes.ts new file mode 100644 index 0000000000..b3c4fbcd35 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCollectionsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCollection } from "./ProductCollection" + +export interface StoreCollectionsRes { + collection: ProductCollection +} diff --git a/packages/generated/client-types/src/lib/models/StoreCompleteCartRes.ts b/packages/generated/client-types/src/lib/models/StoreCompleteCartRes.ts new file mode 100644 index 0000000000..deb3af9138 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCompleteCartRes.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Cart } from "./Cart" +import type { Order } from "./Order" +import type { Swap } from "./Swap" + +export interface StoreCompleteCartRes { + /** + * The type of the data property. + */ + type: "order" | "cart" | "swap" + /** + * The data of the result object. Its type depends on the type field. + */ + data: Order | Cart | Swap +} diff --git a/packages/generated/client-types/src/lib/models/StoreCustomersListOrdersRes.ts b/packages/generated/client-types/src/lib/models/StoreCustomersListOrdersRes.ts new file mode 100644 index 0000000000..72957782db --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCustomersListOrdersRes.ts @@ -0,0 +1,139 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimOrder } from "./ClaimOrder" +import type { Discount } from "./Discount" +import type { Fulfillment } from "./Fulfillment" +import type { GiftCardTransaction } from "./GiftCardTransaction" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +export interface StoreCustomersListOrdersRes { + orders: Array< + Merge< + SetRelation< + Order, + | "customer" + | "discounts" + | "fulfillments" + | "items" + | "payments" + | "region" + | "shipping_address" + | "shipping_methods" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "paid_total" + | "refundable_amount" + | "refunded_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + | "claims" + | "swaps" + | "gift_card_transactions" + | "gift_cards" + | "refunds" + >, + { + discounts: Array> + fulfillments: Array> + items: Array< + Merge< + SetRelation< + LineItem, + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + >, + { + variant: SetRelation + } + > + > + region: SetRelation< + Region, + "fulfillment_providers" | "payment_providers" + > + shipping_methods: Array< + SetRelation + > + claims: Array< + Merge< + SetRelation, + { + additional_items: Array< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + } + > + > + swaps: Array< + Merge< + SetRelation, + { + additional_items: Array< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + } + > + > + gift_card_transactions: Array< + SetRelation + > + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreCustomersListPaymentMethodsRes.ts b/packages/generated/client-types/src/lib/models/StoreCustomersListPaymentMethodsRes.ts new file mode 100644 index 0000000000..ce67a6e22d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCustomersListPaymentMethodsRes.ts @@ -0,0 +1,17 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreCustomersListPaymentMethodsRes { + payment_methods: Array<{ + /** + * The id of the Payment Provider where the payment method is saved. + */ + provider_id: string + /** + * The data needed for the Payment Provider to use the saved payment method. + */ + data: Record + }> +} diff --git a/packages/generated/client-types/src/lib/models/StoreCustomersRes.ts b/packages/generated/client-types/src/lib/models/StoreCustomersRes.ts new file mode 100644 index 0000000000..0540c23b76 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCustomersRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" + +export interface StoreCustomersRes { + customer: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/StoreCustomersResetPasswordRes.ts b/packages/generated/client-types/src/lib/models/StoreCustomersResetPasswordRes.ts new file mode 100644 index 0000000000..a5cafd713c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreCustomersResetPasswordRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Customer } from "./Customer" + +export interface StoreCustomersResetPasswordRes { + customer: Customer +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetAuthEmailRes.ts b/packages/generated/client-types/src/lib/models/StoreGetAuthEmailRes.ts new file mode 100644 index 0000000000..262c4446c8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetAuthEmailRes.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetAuthEmailRes { + /** + * Whether email exists or not. + */ + exists: boolean +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetCollectionsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetCollectionsParams.ts new file mode 100644 index 0000000000..1ef12142ed --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetCollectionsParams.ts @@ -0,0 +1,61 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetCollectionsParams { + /** + * The number of collections to skip before starting to collect the collections set + */ + offset?: number + /** + * The number of collections to return + */ + limit?: number + /** + * Filter by the collection handle + */ + handle?: Array + /** + * Date comparison for when resulting collections were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetCustomersCustomerOrdersParams.ts b/packages/generated/client-types/src/lib/models/StoreGetCustomersCustomerOrdersParams.ts new file mode 100644 index 0000000000..da50b8ca1a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetCustomersCustomerOrdersParams.ts @@ -0,0 +1,130 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetCustomersCustomerOrdersParams { + /** + * Query used for searching orders. + */ + q?: string + /** + * Id of the order to search for. + */ + id?: string + /** + * Status to search for. + */ + status?: Array + /** + * Fulfillment status to search for. + */ + fulfillment_status?: Array + /** + * Payment status to search for. + */ + payment_status?: Array + /** + * Display id to search for. + */ + display_id?: string + /** + * to search for. + */ + cart_id?: string + /** + * to search for. + */ + email?: string + /** + * to search for. + */ + region_id?: string + /** + * The 3 character ISO currency code to set prices based on. + */ + currency_code?: string + /** + * to search for. + */ + tax_rate?: string + /** + * Date comparison for when resulting collections were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting collections were canceled. + */ + canceled_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * How many orders to return. + */ + limit?: number + /** + * The offset in the resulting orders. + */ + offset?: number + /** + * (Comma separated string) Which fields should be included in the resulting orders. + */ + fields?: string + /** + * (Comma separated string) Which relations should be expanded in the resulting orders. + */ + expand?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetOrdersParams.ts b/packages/generated/client-types/src/lib/models/StoreGetOrdersParams.ts new file mode 100644 index 0000000000..047571cd83 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetOrdersParams.ts @@ -0,0 +1,32 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetOrdersParams { + /** + * The display id given to the Order. + */ + display_id: number + /** + * (Comma separated) Which fields should be included in the result. + */ + fields?: string + /** + * (Comma separated) Which fields should be expanded in the result. + */ + expand?: string + /** + * The email associated with this order. + */ + email: string + /** + * The shipping address associated with this order. + */ + shipping_address?: { + /** + * The postal code of the shipping address + */ + postal_code?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetPaymentCollectionsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetPaymentCollectionsParams.ts new file mode 100644 index 0000000000..51581fe0bf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetPaymentCollectionsParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetPaymentCollectionsParams { + /** + * Comma separated list of relations to include in the results. + */ + expand?: string + /** + * Comma separated list of fields to include in the results. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesCategoryParams.ts b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesCategoryParams.ts new file mode 100644 index 0000000000..8a00721b56 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesCategoryParams.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetProductCategoriesCategoryParams { + /** + * (Comma separated) Which fields should be expanded in each product category. + */ + expand?: string + /** + * (Comma separated) Which fields should be retrieved in each product category. + */ + fields?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesCategoryRes.ts b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesCategoryRes.ts new file mode 100644 index 0000000000..0e04eae689 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesCategoryRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCategory } from "./ProductCategory" + +export interface StoreGetProductCategoriesCategoryRes { + product_category: SetRelation< + ProductCategory, + "category_children" | "parent_category" + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesParams.ts b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesParams.ts new file mode 100644 index 0000000000..f07495a5fc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesParams.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetProductCategoriesParams { + /** + * Query used for searching product category names or handles. + */ + q?: string + /** + * Returns categories scoped by parent + */ + parent_category_id?: string + /** + * Include all nested descendants of category + */ + include_descendants_tree?: boolean + /** + * How many product categories to skip in the result. + */ + offset?: number + /** + * Limit the number of product categories returned. + */ + limit?: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesRes.ts b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesRes.ts new file mode 100644 index 0000000000..9ba92c7faf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductCategoriesRes.ts @@ -0,0 +1,24 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductCategory } from "./ProductCategory" + +export interface StoreGetProductCategoriesRes { + product_categories: Array< + SetRelation + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductTagsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetProductTagsParams.ts new file mode 100644 index 0000000000..f914b51038 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductTagsParams.ts @@ -0,0 +1,77 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetProductTagsParams { + /** + * The number of types to return. + */ + limit?: number + /** + * The number of items to skip before the results. + */ + offset?: number + /** + * The field to sort items by. + */ + order?: string + /** + * The discount condition id on which to filter the product tags. + */ + discount_condition_id?: string + /** + * The tag values to search for + */ + value?: Array + /** + * The tag IDs to search for + */ + id?: Array + /** + * A query string to search values for + */ + q?: string + /** + * Date comparison for when resulting product tags were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting product tags were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductTypesParams.ts b/packages/generated/client-types/src/lib/models/StoreGetProductTypesParams.ts new file mode 100644 index 0000000000..e526710ef6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductTypesParams.ts @@ -0,0 +1,77 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetProductTypesParams { + /** + * The number of types to return. + */ + limit?: number + /** + * The number of items to skip before the results. + */ + offset?: number + /** + * The field to sort items by. + */ + order?: string + /** + * The discount condition id on which to filter the product types. + */ + discount_condition_id?: string + /** + * The type values to search for + */ + value?: Array + /** + * The type IDs to search for + */ + id?: Array + /** + * A query string to search values for + */ + q?: string + /** + * Date comparison for when resulting product types were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting product types were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetProductsParams.ts new file mode 100644 index 0000000000..f6e5b0c0db --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductsParams.ts @@ -0,0 +1,129 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetProductsParams { + /** + * Query used for searching products by title, description, variant's title, variant's sku, and collection's title + */ + q?: string + /** + * product IDs to search for. + */ + id?: string | Array + /** + * an array of sales channel IDs to filter the retrieved products by. + */ + sales_channel_id?: Array + /** + * Collection IDs to search for + */ + collection_id?: Array + /** + * Type IDs to search for + */ + type_id?: Array + /** + * Tag IDs to search for + */ + tags?: Array + /** + * title to search for. + */ + title?: string + /** + * description to search for. + */ + description?: string + /** + * handle to search for. + */ + handle?: string + /** + * Search for giftcards using is_giftcard=true. + */ + is_giftcard?: boolean + /** + * Date comparison for when resulting products were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting products were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Category ids to filter by. + */ + category_id?: Array + /** + * Include category children when filtering by category_id. + */ + include_category_children?: boolean + /** + * How many products to skip in the result. + */ + offset?: number + /** + * Limit the number of products returned. + */ + limit?: number + /** + * (Comma separated) Which fields should be expanded in each product of the result. + */ + expand?: string + /** + * (Comma separated) Which fields should be included in each product of the result. + */ + fields?: string + /** + * the field used to order the products. + */ + order?: string + /** + * The id of the Cart to set prices based on. + */ + cart_id?: string + /** + * The id of the Region to set prices based on. + */ + region_id?: string + /** + * The currency code to use for price selection. + */ + currency_code?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetProductsProductParams.ts b/packages/generated/client-types/src/lib/models/StoreGetProductsProductParams.ts new file mode 100644 index 0000000000..5bde519bd4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetProductsProductParams.ts @@ -0,0 +1,31 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetProductsProductParams { + /** + * The sales channel used when fetching the product. + */ + sales_channel_id?: string + /** + * The ID of the customer's cart. + */ + cart_id?: string + /** + * The ID of the region the customer is using. This is helpful to ensure correct prices are retrieved for a region. + */ + region_id?: string + /** + * (Comma separated) Which fields should be included in the result. + */ + fields?: string + /** + * (Comma separated) Which fields should be expanded in each product of the result. + */ + expand?: string + /** + * The 3 character ISO currency code to set prices based on. This is helpful to ensure correct prices are retrieved for a currency. + */ + currency_code?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetRegionsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetRegionsParams.ts new file mode 100644 index 0000000000..578624f4f5 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetRegionsParams.ts @@ -0,0 +1,57 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetRegionsParams { + /** + * How many regions to skip in the result. + */ + offset?: number + /** + * Limit the number of regions returned. + */ + limit?: number + /** + * Date comparison for when resulting regions were created. + */ + created_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } + /** + * Date comparison for when resulting regions were updated. + */ + updated_at?: { + /** + * filter by dates less than this date + */ + lt?: string + /** + * filter by dates greater than this date + */ + gt?: string + /** + * filter by dates less than or equal to this date + */ + lte?: string + /** + * filter by dates greater than or equal to this date + */ + gte?: string + } +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetShippingOptionsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetShippingOptionsParams.ts new file mode 100644 index 0000000000..44f3d5a84b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetShippingOptionsParams.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetShippingOptionsParams { + /** + * Whether return Shipping Options should be included. By default all Shipping Options are returned. + */ + is_return?: boolean + /** + * A comma separated list of Product ids to filter Shipping Options by. + */ + product_ids?: string + /** + * the Region to retrieve Shipping Options from. + */ + region_id?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetVariantsParams.ts b/packages/generated/client-types/src/lib/models/StoreGetVariantsParams.ts new file mode 100644 index 0000000000..7dc5c7e6b9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetVariantsParams.ts @@ -0,0 +1,66 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetVariantsParams { + /** + * A comma separated list of Product Variant ids to filter by. + */ + ids?: string + /** + * A sales channel id for result configuration. + */ + sales_channel_id?: string + /** + * A comma separated list of Product Variant relations to load. + */ + expand?: string + /** + * How many product variants to skip in the result. + */ + offset?: number + /** + * Maximum number of Product Variants to return. + */ + limit?: number + /** + * The id of the Cart to set prices based on. + */ + cart_id?: string + /** + * The id of the Region to set prices based on. + */ + region_id?: string + /** + * The currency code to use for price selection. + */ + currency_code?: string + /** + * product variant title to search for. + */ + title?: string | Array + /** + * Filter by available inventory quantity + */ + inventory_quantity?: + | number + | { + /** + * filter by inventory quantity less than this number + */ + lt?: number + /** + * filter by inventory quantity greater than this number + */ + gt?: number + /** + * filter by inventory quantity less than or equal to this number + */ + lte?: number + /** + * filter by inventory quantity greater than or equal to this number + */ + gte?: number + } +} diff --git a/packages/generated/client-types/src/lib/models/StoreGetVariantsVariantParams.ts b/packages/generated/client-types/src/lib/models/StoreGetVariantsVariantParams.ts new file mode 100644 index 0000000000..71d724fcf3 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGetVariantsVariantParams.ts @@ -0,0 +1,23 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StoreGetVariantsVariantParams { + /** + * The id of the Cart to set prices based on. + */ + cart_id?: string + /** + * A sales channel id for result configuration. + */ + sales_channel_id?: string + /** + * The id of the Region to set prices based on. + */ + region_id?: string + /** + * The 3 character ISO currency code to set prices based on. + */ + currency_code?: string +} diff --git a/packages/generated/client-types/src/lib/models/StoreGiftCardsRes.ts b/packages/generated/client-types/src/lib/models/StoreGiftCardsRes.ts new file mode 100644 index 0000000000..5df3692bb8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreGiftCardsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { GiftCard } from "./GiftCard" + +export interface StoreGiftCardsRes { + gift_card: GiftCard +} diff --git a/packages/generated/client-types/src/lib/models/StoreOrderEditsRes.ts b/packages/generated/client-types/src/lib/models/StoreOrderEditsRes.ts new file mode 100644 index 0000000000..8bc930f858 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreOrderEditsRes.ts @@ -0,0 +1,54 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { LineItem } from "./LineItem" +import type { OrderEdit } from "./OrderEdit" +import type { OrderItemChange } from "./OrderItemChange" + +export interface StoreOrderEditsRes { + order_edit: Merge< + SetRelation< + OrderEdit, + | "changes" + | "items" + | "payment_collection" + | "difference_due" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + >, + { + changes: Array< + Merge< + SetRelation, + { + line_item: SetRelation + original_line_item: SetRelation + } + > + > + items: Array< + SetRelation< + LineItem, + | "adjustments" + | "tax_lines" + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + > + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreOrdersRes.ts b/packages/generated/client-types/src/lib/models/StoreOrdersRes.ts new file mode 100644 index 0000000000..f60b33407a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreOrdersRes.ts @@ -0,0 +1,122 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ClaimOrder } from "./ClaimOrder" +import type { Discount } from "./Discount" +import type { Fulfillment } from "./Fulfillment" +import type { GiftCardTransaction } from "./GiftCardTransaction" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { ProductVariant } from "./ProductVariant" +import type { Region } from "./Region" +import type { ShippingMethod } from "./ShippingMethod" +import type { Swap } from "./Swap" + +export interface StoreOrdersRes { + order: Merge< + SetRelation< + Order, + | "customer" + | "discounts" + | "fulfillments" + | "items" + | "payments" + | "region" + | "shipping_address" + | "shipping_methods" + | "discount_total" + | "gift_card_tax_total" + | "gift_card_total" + | "paid_total" + | "refundable_amount" + | "refunded_total" + | "shipping_total" + | "subtotal" + | "tax_total" + | "total" + | "claims" + | "swaps" + | "gift_card_transactions" + | "gift_cards" + | "refunds" + >, + { + discounts: Array> + fulfillments: Array> + items: Array< + Merge< + SetRelation< + LineItem, + | "variant" + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + >, + { + variant: SetRelation + } + > + > + region: SetRelation + shipping_methods: Array< + SetRelation + > + claims: Array< + Merge< + SetRelation, + { + additional_items: Array< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + } + > + > + swaps: Array< + Merge< + SetRelation, + { + additional_items: Array< + SetRelation< + LineItem, + | "discount_total" + | "gift_card_total" + | "original_tax_total" + | "original_total" + | "refundable" + | "subtotal" + | "tax_total" + | "total" + | "adjustments" + | "tax_lines" + > + > + } + > + > + gift_card_transactions: Array< + SetRelation + > + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts b/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts new file mode 100644 index 0000000000..67425573e6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePaymentCollectionSessionsReq { + /** + * The ID of the Payment Provider. + */ + provider_id: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePaymentCollectionsRes.ts b/packages/generated/client-types/src/lib/models/StorePaymentCollectionsRes.ts new file mode 100644 index 0000000000..acc9ac7162 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePaymentCollectionsRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PaymentCollection } from "./PaymentCollection" +import type { Region } from "./Region" + +export interface StorePaymentCollectionsRes { + payment_collection: Merge< + SetRelation, + { + region: SetRelation + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts b/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts new file mode 100644 index 0000000000..1e273e2bdf --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PaymentSession } from "./PaymentSession" + +export interface StorePaymentCollectionsSessionRes { + payment_session: PaymentSession +} diff --git a/packages/generated/client-types/src/lib/models/StorePostAuthReq.ts b/packages/generated/client-types/src/lib/models/StorePostAuthReq.ts new file mode 100644 index 0000000000..078dc07d79 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostAuthReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostAuthReq { + /** + * The Customer's email. + */ + email: string + /** + * The Customer's password. + */ + password: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartReq.ts new file mode 100644 index 0000000000..a1333d244d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartReq.ts @@ -0,0 +1,36 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCartReq { + /** + * The ID of the Region to create the Cart in. + */ + region_id?: string + /** + * [EXPERIMENTAL] The ID of the Sales channel to create the Cart in. + */ + sales_channel_id?: string + /** + * The 2 character ISO country code to create the Cart in. + */ + country_code?: string + /** + * An optional array of `variant_id`, `quantity` pairs to generate Line Items from. + */ + items?: Array<{ + /** + * The id of the Product Variant to generate a Line Item from. + */ + variant_id: string + /** + * The quantity of the Product Variant to add + */ + quantity: number + }> + /** + * An optional object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent` + */ + context?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts new file mode 100644 index 0000000000..786759d62f --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCartsCartLineItemsItemReq { + /** + * The quantity to set the Line Item to. + */ + quantity: number +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts new file mode 100644 index 0000000000..22c21cf5b9 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCartsCartLineItemsReq { + /** + * The id of the Product Variant to generate the Line Item from. + */ + variant_id: string + /** + * The quantity of the Product Variant to add to the Line Item. + */ + quantity: number + /** + * An optional key-value map with additional details about the Line Item. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts new file mode 100644 index 0000000000..1d465565cc --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCartsCartPaymentSessionReq { + /** + * The ID of the Payment Provider. + */ + provider_id: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionUpdateReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionUpdateReq.ts new file mode 100644 index 0000000000..7cf318127e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionUpdateReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCartsCartPaymentSessionUpdateReq { + /** + * The data to update the payment session with. + */ + data: Record +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts new file mode 100644 index 0000000000..29d3bd5d49 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts @@ -0,0 +1,59 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" + +export interface StorePostCartsCartReq { + /** + * The id of the Region to create the Cart in. + */ + region_id?: string + /** + * The 2 character ISO country code to create the Cart in. + */ + country_code?: string + /** + * An email to be used on the Cart. + */ + email?: string + /** + * The ID of the Sales channel to update the Cart with. + */ + sales_channel_id?: string + /** + * The Address to be used for billing purposes. + */ + billing_address?: AddressPayload | string + /** + * The Address to be used for shipping. + */ + shipping_address?: AddressPayload | string + /** + * An array of Gift Card codes to add to the Cart. + */ + gift_cards?: Array<{ + /** + * The code that a Gift Card is identified by. + */ + code: string + }> + /** + * An array of Discount codes to add to the Cart. + */ + discounts?: Array<{ + /** + * The code that a Discount is identifed by. + */ + code: string + }> + /** + * The ID of the Customer to associate the Cart with. + */ + customer_id?: string + /** + * An optional object to provide context to the Cart. + */ + context?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts b/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts new file mode 100644 index 0000000000..f1bc6de702 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCartsCartShippingMethodReq { + /** + * ID of the shipping option to create the method from + */ + option_id: string + /** + * Used to hold any data that the shipping method may need to process the fulfillment of the order. Look at the documentation for your installed fulfillment providers to find out what to send. + */ + data?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts new file mode 100644 index 0000000000..ed7898692c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCustomersCustomerAcceptClaimReq { + /** + * The invite token provided by the admin. + */ + token: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAddressesAddressReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAddressesAddressReq.ts new file mode 100644 index 0000000000..843bc616f7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAddressesAddressReq.ts @@ -0,0 +1,8 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" + +export type StorePostCustomersCustomerAddressesAddressReq = AddressPayload diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAddressesReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAddressesReq.ts new file mode 100644 index 0000000000..9a2ac34fa8 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAddressesReq.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressCreatePayload } from "./AddressCreatePayload" + +export interface StorePostCustomersCustomerAddressesReq { + /** + * The Address to add to the Customer. + */ + address: AddressCreatePayload +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts new file mode 100644 index 0000000000..6fb1c44f5b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCustomersCustomerOrderClaimReq { + /** + * The ids of the orders to claim + */ + order_ids: Array +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerPasswordTokenReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerPasswordTokenReq.ts new file mode 100644 index 0000000000..c643d032b7 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerPasswordTokenReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCustomersCustomerPasswordTokenReq { + /** + * The email of the customer. + */ + email: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts new file mode 100644 index 0000000000..05e0480915 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts @@ -0,0 +1,37 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { AddressPayload } from "./AddressPayload" + +export interface StorePostCustomersCustomerReq { + /** + * The Customer's first name. + */ + first_name?: string + /** + * The Customer's last name. + */ + last_name?: string + /** + * The Address to be used for billing purposes. + */ + billing_address?: AddressPayload | string + /** + * The Customer's password. + */ + password?: string + /** + * The Customer's phone number. + */ + phone?: string + /** + * The email of the customer. + */ + email?: string + /** + * Metadata about the customer. + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts new file mode 100644 index 0000000000..30cd789364 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts @@ -0,0 +1,27 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCustomersReq { + /** + * The Customer's first name. + */ + first_name: string + /** + * The Customer's last name. + */ + last_name: string + /** + * The email of the customer. + */ + email: string + /** + * The Customer's password. + */ + password: string + /** + * The Customer's phone number. + */ + phone?: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostCustomersResetPasswordReq.ts b/packages/generated/client-types/src/lib/models/StorePostCustomersResetPasswordReq.ts new file mode 100644 index 0000000000..ea6c89bc07 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostCustomersResetPasswordReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostCustomersResetPasswordReq { + /** + * The email of the customer. + */ + email: string + /** + * The Customer's password. + */ + password: string + /** + * The reset password token + */ + token: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts b/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts new file mode 100644 index 0000000000..70232da35c --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostOrderEditsOrderEditDecline.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostOrderEditsOrderEditDecline { + /** + * The reason for declining the OrderEdit. + */ + declined_reason?: string +} diff --git a/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts new file mode 100644 index 0000000000..24b2f85b83 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostPaymentCollectionsBatchSessionsAuthorizeReq { + /** + * List of Payment Session IDs to authorize. + */ + session_ids: Array +} diff --git a/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts new file mode 100644 index 0000000000..556514057b --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostPaymentCollectionsBatchSessionsReq.ts @@ -0,0 +1,24 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostPaymentCollectionsBatchSessionsReq { + /** + * An array of payment sessions related to the Payment Collection. If the session_id is not provided, existing sessions not present will be deleted and the provided ones will be created. + */ + sessions: Array<{ + /** + * The ID of the Payment Provider. + */ + provider_id: string + /** + * The amount . + */ + amount: number + /** + * The ID of the Payment Session to be updated. + */ + session_id?: string + }> +} diff --git a/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts b/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts new file mode 100644 index 0000000000..16d898fadb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostReturnsReq.ts @@ -0,0 +1,41 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostReturnsReq { + /** + * The ID of the Order to create the Return from. + */ + order_id: string + /** + * The items to include in the Return. + */ + items: Array<{ + /** + * The ID of the Line Item from the Order. + */ + item_id: string + /** + * The quantity to return. + */ + quantity: number + /** + * The ID of the return reason. + */ + reason_id?: string + /** + * A note to add to the item returned. + */ + note?: string + }> + /** + * If the Return is to be handled by the store operator the Customer can choose a Return Shipping Method. Alternatvely the Customer can handle the Return themselves. + */ + return_shipping?: { + /** + * The ID of the Shipping Option to create the Shipping Method from. + */ + option_id: string + } +} diff --git a/packages/generated/client-types/src/lib/models/StorePostSearchReq.ts b/packages/generated/client-types/src/lib/models/StorePostSearchReq.ts new file mode 100644 index 0000000000..8809a6a4a6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostSearchReq.ts @@ -0,0 +1,19 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostSearchReq { + /** + * The query to run the search with. + */ + q: string + /** + * How many products to skip in the result. + */ + offset?: number + /** + * Limit the number of products returned. + */ + limit?: number +} diff --git a/packages/generated/client-types/src/lib/models/StorePostSearchRes.ts b/packages/generated/client-types/src/lib/models/StorePostSearchRes.ts new file mode 100644 index 0000000000..216a0fe228 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostSearchRes.ts @@ -0,0 +1,11 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export type StorePostSearchRes = { + /** + * Array of results. The format of the items depends on the search engine installed on the server. + */ + hits: any[] +} & Record diff --git a/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts b/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts new file mode 100644 index 0000000000..3f62ca2d21 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StorePostSwapsReq.ts @@ -0,0 +1,49 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +export interface StorePostSwapsReq { + /** + * The ID of the Order to create the Swap for. + */ + order_id: string + /** + * The items to include in the Return. + */ + return_items: Array<{ + /** + * The ID of the Line Item from the Order. + */ + item_id: string + /** + * The quantity to swap. + */ + quantity: number + /** + * The ID of the reason of this return. + */ + reason_id?: string + /** + * The note to add to the item being swapped. + */ + note?: string + }> + /** + * The ID of the Shipping Option to create the Shipping Method from. + */ + return_shipping_option?: string + /** + * The items to exchange the returned items to. + */ + additional_items: Array<{ + /** + * The ID of the Product Variant to send. + */ + variant_id: string + /** + * The quantity to send of the variant. + */ + quantity: number + }> +} diff --git a/packages/generated/client-types/src/lib/models/StoreProductTagsListRes.ts b/packages/generated/client-types/src/lib/models/StoreProductTagsListRes.ts new file mode 100644 index 0000000000..1b00f20300 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreProductTagsListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductTag } from "./ProductTag" + +export interface StoreProductTagsListRes { + product_tags: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreProductTypesListRes.ts b/packages/generated/client-types/src/lib/models/StoreProductTypesListRes.ts new file mode 100644 index 0000000000..b855e8651d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreProductTypesListRes.ts @@ -0,0 +1,22 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ProductType } from "./ProductType" + +export interface StoreProductTypesListRes { + product_types: Array + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreProductsListRes.ts b/packages/generated/client-types/src/lib/models/StoreProductsListRes.ts new file mode 100644 index 0000000000..f850e16b1e --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreProductsListRes.ts @@ -0,0 +1,35 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedProduct } from "./PricedProduct" +import type { ProductOption } from "./ProductOption" +import type { ProductVariant } from "./ProductVariant" + +export interface StoreProductsListRes { + products: Array< + Merge< + SetRelation< + PricedProduct, + "collection" | "images" | "options" | "tags" | "type" | "variants" + >, + { + options: Array> + variants: Array> + } + > + > + /** + * The total number of items available + */ + count: number + /** + * The number of items skipped before these items + */ + offset: number + /** + * The number of items per page + */ + limit: number +} diff --git a/packages/generated/client-types/src/lib/models/StoreProductsRes.ts b/packages/generated/client-types/src/lib/models/StoreProductsRes.ts new file mode 100644 index 0000000000..8be3fc3e6d --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreProductsRes.ts @@ -0,0 +1,21 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedProduct } from "./PricedProduct" +import type { ProductOption } from "./ProductOption" +import type { ProductVariant } from "./ProductVariant" + +export interface StoreProductsRes { + product: Merge< + SetRelation< + PricedProduct, + "collection" | "images" | "options" | "tags" | "type" | "variants" + >, + { + options: Array> + variants: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreRegionsListRes.ts b/packages/generated/client-types/src/lib/models/StoreRegionsListRes.ts new file mode 100644 index 0000000000..caec712e17 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreRegionsListRes.ts @@ -0,0 +1,15 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" + +export interface StoreRegionsListRes { + regions: Array< + SetRelation< + Region, + "countries" | "payment_providers" | "fulfillment_providers" + > + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreRegionsRes.ts b/packages/generated/client-types/src/lib/models/StoreRegionsRes.ts new file mode 100644 index 0000000000..eace2d10db --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreRegionsRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Region } from "./Region" + +export interface StoreRegionsRes { + region: SetRelation< + Region, + "countries" | "payment_providers" | "fulfillment_providers" + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreReturnReasonsListRes.ts b/packages/generated/client-types/src/lib/models/StoreReturnReasonsListRes.ts new file mode 100644 index 0000000000..c849f99fe2 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreReturnReasonsListRes.ts @@ -0,0 +1,12 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ReturnReason } from "./ReturnReason" + +export interface StoreReturnReasonsListRes { + return_reasons: Array< + SetRelation + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreReturnReasonsRes.ts b/packages/generated/client-types/src/lib/models/StoreReturnReasonsRes.ts new file mode 100644 index 0000000000..ac1effde5a --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreReturnReasonsRes.ts @@ -0,0 +1,13 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ReturnReason } from "./ReturnReason" + +export interface StoreReturnReasonsRes { + return_reason: SetRelation< + ReturnReason, + "parent_return_reason" | "return_reason_children" + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreReturnsRes.ts b/packages/generated/client-types/src/lib/models/StoreReturnsRes.ts new file mode 100644 index 0000000000..18a9c02991 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreReturnsRes.ts @@ -0,0 +1,16 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Return } from "./Return" +import type { ReturnItem } from "./ReturnItem" + +export interface StoreReturnsRes { + return: Merge< + SetRelation, + { + items: Array> + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreShippingOptionsListRes.ts b/packages/generated/client-types/src/lib/models/StoreShippingOptionsListRes.ts new file mode 100644 index 0000000000..35a22285df --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreShippingOptionsListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedShippingOption } from "./PricedShippingOption" + +export interface StoreShippingOptionsListRes { + shipping_options: Array> +} diff --git a/packages/generated/client-types/src/lib/models/StoreSwapsRes.ts b/packages/generated/client-types/src/lib/models/StoreSwapsRes.ts new file mode 100644 index 0000000000..e6745d4571 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreSwapsRes.ts @@ -0,0 +1,30 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Fulfillment } from "./Fulfillment" +import type { LineItem } from "./LineItem" +import type { Return } from "./Return" +import type { Swap } from "./Swap" + +export interface StoreSwapsRes { + swap: Merge< + SetRelation< + Swap, + | "additional_items" + | "cart" + | "fulfillments" + | "order" + | "payment" + | "return_order" + | "shipping_address" + | "shipping_methods" + >, + { + additional_items: Array> + fulfillments: Array> + return_order: SetRelation + } + > +} diff --git a/packages/generated/client-types/src/lib/models/StoreVariantsListRes.ts b/packages/generated/client-types/src/lib/models/StoreVariantsListRes.ts new file mode 100644 index 0000000000..e73739f319 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreVariantsListRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedVariant } from "./PricedVariant" + +export interface StoreVariantsListRes { + variants: Array> +} diff --git a/packages/generated/client-types/src/lib/models/StoreVariantsRes.ts b/packages/generated/client-types/src/lib/models/StoreVariantsRes.ts new file mode 100644 index 0000000000..f9c33d6171 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/StoreVariantsRes.ts @@ -0,0 +1,10 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { PricedVariant } from "./PricedVariant" + +export interface StoreVariantsRes { + variant: SetRelation +} diff --git a/packages/generated/client-types/src/lib/models/Swap.ts b/packages/generated/client-types/src/lib/models/Swap.ts new file mode 100644 index 0000000000..4a3dae1662 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/Swap.ts @@ -0,0 +1,130 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Address } from "./Address" +import type { Cart } from "./Cart" +import type { Fulfillment } from "./Fulfillment" +import type { LineItem } from "./LineItem" +import type { Order } from "./Order" +import type { Payment } from "./Payment" +import type { Return } from "./Return" +import type { ShippingMethod } from "./ShippingMethod" + +/** + * Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference. + */ +export interface Swap { + /** + * The swap's ID + */ + id: string + /** + * The status of the Fulfillment of the Swap. + */ + fulfillment_status: + | "not_fulfilled" + | "fulfilled" + | "shipped" + | "partially_shipped" + | "canceled" + | "requires_action" + /** + * The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount. + */ + payment_status: + | "not_paid" + | "awaiting" + | "captured" + | "confirmed" + | "canceled" + | "difference_refunded" + | "partially_refunded" + | "refunded" + | "requires_action" + /** + * The ID of the Order where the Line Items to be returned where purchased. + */ + order_id: string + /** + * An order object. Available if the relation `order` is expanded. + */ + order?: Order | null + /** + * The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded. + */ + additional_items?: Array + /** + * A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. + */ + return_order?: Return | null + /** + * The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded. + */ + fulfillments?: Array + /** + * The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. + */ + payment?: Payment | null + /** + * The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products. + */ + difference_due: number | null + /** + * The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order. + */ + shipping_address_id: string | null + /** + * Available if the relation `shipping_address` is expanded. + */ + shipping_address?: Address | null + /** + * The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. + */ + shipping_methods?: Array + /** + * The id of the Cart that the Customer will use to confirm the Swap. + */ + cart_id: string | null + /** + * A cart object. Available if the relation `cart` is expanded. + */ + cart?: Cart | null + /** + * The date with timezone at which the Swap was confirmed by the Customer. + */ + confirmed_at: string | null + /** + * The date with timezone at which the Swap was canceled. + */ + canceled_at: string | null + /** + * If set to true, no notification will be sent related to this swap + */ + no_notification: boolean | null + /** + * If true, swaps can be completed with items out of stock + */ + allow_backorder: boolean + /** + * Randomly generated key used to continue the completion of the swap in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/TaxLine.ts b/packages/generated/client-types/src/lib/models/TaxLine.ts new file mode 100644 index 0000000000..5351c62090 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/TaxLine.ts @@ -0,0 +1,38 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Line item that specifies an amount of tax to add to a line item. + */ +export interface TaxLine { + /** + * The tax line's ID + */ + id: string + /** + * A code to identify the tax type by + */ + code: string | null + /** + * A human friendly name for the tax + */ + name: string + /** + * The numeric rate to charge tax by + */ + rate: number + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/TaxProvider.ts b/packages/generated/client-types/src/lib/models/TaxProvider.ts new file mode 100644 index 0000000000..adb883cf07 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/TaxProvider.ts @@ -0,0 +1,18 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * The tax service used to calculate taxes + */ +export interface TaxProvider { + /** + * The id of the tax provider as given by the plugin. + */ + id: string + /** + * Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`. + */ + is_installed: boolean +} diff --git a/packages/generated/client-types/src/lib/models/TaxRate.ts b/packages/generated/client-types/src/lib/models/TaxRate.ts new file mode 100644 index 0000000000..0d57398545 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/TaxRate.ts @@ -0,0 +1,75 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Product } from "./Product" +import type { ProductType } from "./ProductType" +import type { Region } from "./Region" +import type { ShippingOption } from "./ShippingOption" + +/** + * A Tax Rate can be used to associate a certain rate to charge on products within a given Region + */ +export interface TaxRate { + /** + * The tax rate's ID + */ + id: string + /** + * The numeric rate to charge + */ + rate: number | null + /** + * A code to identify the tax type by + */ + code: string | null + /** + * A human friendly name for the tax + */ + name: string + /** + * The id of the Region that the rate belongs to + */ + region_id: string + /** + * A region object. Available if the relation `region` is expanded. + */ + region?: Region | null + /** + * The products that belong to this tax rate. Available if the relation `products` is expanded. + */ + products?: Array + /** + * The product types that belong to this tax rate. Available if the relation `product_types` is expanded. + */ + product_types?: Array + /** + * The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded. + */ + shipping_options?: Array + /** + * The count of products + */ + product_count?: number + /** + * The count of product types + */ + product_type_count?: number + /** + * The count of shipping options + */ + shipping_option_count?: number + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/TrackingLink.ts b/packages/generated/client-types/src/lib/models/TrackingLink.ts new file mode 100644 index 0000000000..74291eb9d4 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/TrackingLink.ts @@ -0,0 +1,52 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { Fulfillment } from "./Fulfillment" + +/** + * Tracking Link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. + */ +export interface TrackingLink { + /** + * The tracking link's ID + */ + id: string + /** + * The URL at which the status of the shipment can be tracked. + */ + url: string | null + /** + * The tracking number given by the shipping carrier. + */ + tracking_number: string + /** + * The id of the Fulfillment that the Tracking Link references. + */ + fulfillment_id: string + /** + * Available if the relation `fulfillment` is expanded. + */ + fulfillment?: Fulfillment | null + /** + * Randomly generated key used to continue the completion of a process in case of failure. + */ + idempotency_key: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/UpdateStockLocationInput.ts b/packages/generated/client-types/src/lib/models/UpdateStockLocationInput.ts new file mode 100644 index 0000000000..dca10c5726 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/UpdateStockLocationInput.ts @@ -0,0 +1,28 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { StockLocationAddressInput } from "./StockLocationAddressInput" + +/** + * Represents the Input to update a Stock Location + */ +export interface UpdateStockLocationInput { + /** + * The stock location name + */ + name?: string + /** + * The Stock location address ID + */ + address_id?: string + /** + * Stock location address object + */ + address?: StockLocationAddressInput & Record + /** + * An optional key-value map with additional details + */ + metadata?: Record +} diff --git a/packages/generated/client-types/src/lib/models/User.ts b/packages/generated/client-types/src/lib/models/User.ts new file mode 100644 index 0000000000..afeb06c4b6 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/User.ts @@ -0,0 +1,50 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +/** + * Represents a User who can manage store settings. + */ +export interface User { + /** + * The user's ID + */ + id: string + /** + * The user's role + */ + role: "admin" | "member" | "developer" + /** + * The email of the User + */ + email: string + /** + * The first name of the User + */ + first_name: string | null + /** + * The last name of the User + */ + last_name: string | null + /** + * An API token associated with the user. + */ + api_token: string | null + /** + * The date with timezone at which the resource was created. + */ + created_at: string + /** + * The date with timezone at which the resource was updated. + */ + updated_at: string + /** + * The date with timezone at which the resource was deleted. + */ + deleted_at: string | null + /** + * An optional key-value map with additional details + */ + metadata: Record | null +} diff --git a/packages/generated/client-types/src/lib/models/VariantInventory.ts b/packages/generated/client-types/src/lib/models/VariantInventory.ts new file mode 100644 index 0000000000..db48d9cfcb --- /dev/null +++ b/packages/generated/client-types/src/lib/models/VariantInventory.ts @@ -0,0 +1,34 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +import { SetRelation, Merge } from "../core/ModelUtils" + +import type { ResponseInventoryItem } from "./ResponseInventoryItem" + +export interface VariantInventory { + /** + * the id of the variant + */ + id?: string + /** + * the stock location address ID + */ + inventory?: ResponseInventoryItem + /** + * An optional key-value map with additional details + */ + sales_channel_availability?: { + /** + * Sales channel name + */ + channel_name?: string + /** + * Sales channel id + */ + channel_id?: string + /** + * Available quantity in sales channel + */ + available_quantity?: number + } +} diff --git a/packages/generated/client-types/src/lib/models/index.ts b/packages/generated/client-types/src/lib/models/index.ts new file mode 100644 index 0000000000..6d280e52f0 --- /dev/null +++ b/packages/generated/client-types/src/lib/models/index.ts @@ -0,0 +1,471 @@ +/* istanbul ignore file */ +/* tslint:disable */ +/* eslint-disable */ +export type { Address } from "./Address" +export type { AddressCreatePayload } from "./AddressCreatePayload" +export type { AddressPayload } from "./AddressPayload" +export type { AdminAppsListRes } from "./AdminAppsListRes" +export type { AdminAppsRes } from "./AdminAppsRes" +export type { AdminAuthRes } from "./AdminAuthRes" +export type { AdminBatchJobListRes } from "./AdminBatchJobListRes" +export type { AdminBatchJobRes } from "./AdminBatchJobRes" +export type { AdminCollectionsDeleteRes } from "./AdminCollectionsDeleteRes" +export type { AdminCollectionsListRes } from "./AdminCollectionsListRes" +export type { AdminCollectionsRes } from "./AdminCollectionsRes" +export type { AdminCreateUserRequest } from "./AdminCreateUserRequest" +export type { AdminCurrenciesListRes } from "./AdminCurrenciesListRes" +export type { AdminCurrenciesRes } from "./AdminCurrenciesRes" +export type { AdminCustomerGroupsDeleteRes } from "./AdminCustomerGroupsDeleteRes" +export type { AdminCustomerGroupsListRes } from "./AdminCustomerGroupsListRes" +export type { AdminCustomerGroupsRes } from "./AdminCustomerGroupsRes" +export type { AdminCustomersListRes } from "./AdminCustomersListRes" +export type { AdminCustomersRes } from "./AdminCustomersRes" +export type { AdminDeleteCustomerGroupsGroupCustomerBatchReq } from "./AdminDeleteCustomerGroupsGroupCustomerBatchReq" +export type { AdminDeleteDiscountsDiscountConditionsConditionBatchReq } from "./AdminDeleteDiscountsDiscountConditionsConditionBatchReq" +export type { AdminDeleteDiscountsDiscountConditionsConditionParams } from "./AdminDeleteDiscountsDiscountConditionsConditionParams" +export type { AdminDeletePriceListPricesPricesReq } from "./AdminDeletePriceListPricesPricesReq" +export type { AdminDeleteProductCategoriesCategoryProductsBatchParams } from "./AdminDeleteProductCategoriesCategoryProductsBatchParams" +export type { AdminDeleteProductCategoriesCategoryProductsBatchReq } from "./AdminDeleteProductCategoriesCategoryProductsBatchReq" +export type { AdminDeleteProductsFromCollectionReq } from "./AdminDeleteProductsFromCollectionReq" +export type { AdminDeleteProductsFromCollectionRes } from "./AdminDeleteProductsFromCollectionRes" +export type { AdminDeletePublishableApiKeySalesChannelsBatchReq } from "./AdminDeletePublishableApiKeySalesChannelsBatchReq" +export type { AdminDeleteSalesChannelsChannelProductsBatchReq } from "./AdminDeleteSalesChannelsChannelProductsBatchReq" +export type { AdminDeleteSalesChannelsChannelStockLocationsReq } from "./AdminDeleteSalesChannelsChannelStockLocationsReq" +export type { AdminDeleteShippingProfileRes } from "./AdminDeleteShippingProfileRes" +export type { AdminDeleteTaxRatesTaxRateProductsParams } from "./AdminDeleteTaxRatesTaxRateProductsParams" +export type { AdminDeleteTaxRatesTaxRateProductsReq } from "./AdminDeleteTaxRatesTaxRateProductsReq" +export type { AdminDeleteTaxRatesTaxRateProductTypesParams } from "./AdminDeleteTaxRatesTaxRateProductTypesParams" +export type { AdminDeleteTaxRatesTaxRateProductTypesReq } from "./AdminDeleteTaxRatesTaxRateProductTypesReq" +export type { AdminDeleteTaxRatesTaxRateShippingOptionsParams } from "./AdminDeleteTaxRatesTaxRateShippingOptionsParams" +export type { AdminDeleteTaxRatesTaxRateShippingOptionsReq } from "./AdminDeleteTaxRatesTaxRateShippingOptionsReq" +export type { AdminDeleteUploadsReq } from "./AdminDeleteUploadsReq" +export type { AdminDeleteUploadsRes } from "./AdminDeleteUploadsRes" +export type { AdminDeleteUserRes } from "./AdminDeleteUserRes" +export type { AdminDiscountConditionsDeleteRes } from "./AdminDiscountConditionsDeleteRes" +export type { AdminDiscountConditionsRes } from "./AdminDiscountConditionsRes" +export type { AdminDiscountsDeleteRes } from "./AdminDiscountsDeleteRes" +export type { AdminDiscountsListRes } from "./AdminDiscountsListRes" +export type { AdminDiscountsRes } from "./AdminDiscountsRes" +export type { AdminDraftOrdersDeleteRes } from "./AdminDraftOrdersDeleteRes" +export type { AdminDraftOrdersListRes } from "./AdminDraftOrdersListRes" +export type { AdminDraftOrdersRes } from "./AdminDraftOrdersRes" +export type { AdminExtendedStoresRes } from "./AdminExtendedStoresRes" +export type { AdminGetBatchParams } from "./AdminGetBatchParams" +export type { AdminGetCollectionsParams } from "./AdminGetCollectionsParams" +export type { AdminGetCurrenciesParams } from "./AdminGetCurrenciesParams" +export type { AdminGetCustomerGroupsGroupParams } from "./AdminGetCustomerGroupsGroupParams" +export type { AdminGetCustomerGroupsParams } from "./AdminGetCustomerGroupsParams" +export type { AdminGetCustomersParams } from "./AdminGetCustomersParams" +export type { AdminGetDiscountParams } from "./AdminGetDiscountParams" +export type { AdminGetDiscountsDiscountCodeParams } from "./AdminGetDiscountsDiscountCodeParams" +export type { AdminGetDiscountsDiscountConditionsConditionParams } from "./AdminGetDiscountsDiscountConditionsConditionParams" +export type { AdminGetDiscountsParams } from "./AdminGetDiscountsParams" +export type { AdminGetDraftOrdersParams } from "./AdminGetDraftOrdersParams" +export type { AdminGetGiftCardsParams } from "./AdminGetGiftCardsParams" +export type { AdminGetGroupsGroupCustomersParams } from "./AdminGetGroupsGroupCustomersParams" +export type { AdminGetInventoryItemsItemLocationLevelsParams } from "./AdminGetInventoryItemsItemLocationLevelsParams" +export type { AdminGetInventoryItemsItemParams } from "./AdminGetInventoryItemsItemParams" +export type { AdminGetInventoryItemsParams } from "./AdminGetInventoryItemsParams" +export type { AdminGetNotesParams } from "./AdminGetNotesParams" +export type { AdminGetNotificationsParams } from "./AdminGetNotificationsParams" +export type { AdminGetOrdersOrderParams } from "./AdminGetOrdersOrderParams" +export type { AdminGetOrdersParams } from "./AdminGetOrdersParams" +export type { AdminGetPaymentCollectionsParams } from "./AdminGetPaymentCollectionsParams" +export type { AdminGetPriceListPaginationParams } from "./AdminGetPriceListPaginationParams" +export type { AdminGetPriceListsPriceListProductsParams } from "./AdminGetPriceListsPriceListProductsParams" +export type { AdminGetProductCategoriesParams } from "./AdminGetProductCategoriesParams" +export type { AdminGetProductCategoryParams } from "./AdminGetProductCategoryParams" +export type { AdminGetProductsParams } from "./AdminGetProductsParams" +export type { AdminGetProductsVariantsParams } from "./AdminGetProductsVariantsParams" +export type { AdminGetProductTagsParams } from "./AdminGetProductTagsParams" +export type { AdminGetProductTypesParams } from "./AdminGetProductTypesParams" +export type { AdminGetRegionsParams } from "./AdminGetRegionsParams" +export type { AdminGetRegionsRegionFulfillmentOptionsRes } from "./AdminGetRegionsRegionFulfillmentOptionsRes" +export type { AdminGetReservationsParams } from "./AdminGetReservationsParams" +export type { AdminGetReturnsParams } from "./AdminGetReturnsParams" +export type { AdminGetSalesChannelsParams } from "./AdminGetSalesChannelsParams" +export type { AdminGetShippingOptionsParams } from "./AdminGetShippingOptionsParams" +export type { AdminGetStockLocationsLocationParams } from "./AdminGetStockLocationsLocationParams" +export type { AdminGetStockLocationsParams } from "./AdminGetStockLocationsParams" +export type { AdminGetSwapsParams } from "./AdminGetSwapsParams" +export type { AdminGetTaxRatesParams } from "./AdminGetTaxRatesParams" +export type { AdminGetTaxRatesTaxRateParams } from "./AdminGetTaxRatesTaxRateParams" +export type { AdminGetVariantParams } from "./AdminGetVariantParams" +export type { AdminGetVariantsParams } from "./AdminGetVariantsParams" +export type { AdminGetVariantsVariantInventoryRes } from "./AdminGetVariantsVariantInventoryRes" +export type { AdminGiftCardsDeleteRes } from "./AdminGiftCardsDeleteRes" +export type { AdminGiftCardsListRes } from "./AdminGiftCardsListRes" +export type { AdminGiftCardsRes } from "./AdminGiftCardsRes" +export type { AdminInventoryItemsDeleteRes } from "./AdminInventoryItemsDeleteRes" +export type { AdminInventoryItemsListRes } from "./AdminInventoryItemsListRes" +export type { AdminInventoryItemsListWithVariantsAndLocationLevelsRes } from "./AdminInventoryItemsListWithVariantsAndLocationLevelsRes" +export type { AdminInventoryItemsLocationLevelsRes } from "./AdminInventoryItemsLocationLevelsRes" +export type { AdminInventoryItemsRes } from "./AdminInventoryItemsRes" +export type { AdminInviteDeleteRes } from "./AdminInviteDeleteRes" +export type { AdminListInvitesRes } from "./AdminListInvitesRes" +export type { AdminNotesDeleteRes } from "./AdminNotesDeleteRes" +export type { AdminNotesListRes } from "./AdminNotesListRes" +export type { AdminNotesRes } from "./AdminNotesRes" +export type { AdminNotificationsListRes } from "./AdminNotificationsListRes" +export type { AdminNotificationsRes } from "./AdminNotificationsRes" +export type { AdminOrderEditDeleteRes } from "./AdminOrderEditDeleteRes" +export type { AdminOrderEditItemChangeDeleteRes } from "./AdminOrderEditItemChangeDeleteRes" +export type { AdminOrderEditsListRes } from "./AdminOrderEditsListRes" +export type { AdminOrderEditsRes } from "./AdminOrderEditsRes" +export type { AdminOrdersListRes } from "./AdminOrdersListRes" +export type { AdminOrdersOrderLineItemReservationReq } from "./AdminOrdersOrderLineItemReservationReq" +export type { AdminOrdersRes } from "./AdminOrdersRes" +export type { AdminPaymentCollectionDeleteRes } from "./AdminPaymentCollectionDeleteRes" +export type { AdminPaymentCollectionsRes } from "./AdminPaymentCollectionsRes" +export type { AdminPaymentProvidersList } from "./AdminPaymentProvidersList" +export type { AdminPaymentRes } from "./AdminPaymentRes" +export type { AdminPostAppsReq } from "./AdminPostAppsReq" +export type { AdminPostAuthReq } from "./AdminPostAuthReq" +export type { AdminPostBatchesReq } from "./AdminPostBatchesReq" +export type { AdminPostCollectionsCollectionReq } from "./AdminPostCollectionsCollectionReq" +export type { AdminPostCollectionsReq } from "./AdminPostCollectionsReq" +export type { AdminPostCurrenciesCurrencyReq } from "./AdminPostCurrenciesCurrencyReq" +export type { AdminPostCustomerGroupsGroupCustomersBatchReq } from "./AdminPostCustomerGroupsGroupCustomersBatchReq" +export type { AdminPostCustomerGroupsGroupReq } from "./AdminPostCustomerGroupsGroupReq" +export type { AdminPostCustomerGroupsReq } from "./AdminPostCustomerGroupsReq" +export type { AdminPostCustomersCustomerReq } from "./AdminPostCustomersCustomerReq" +export type { AdminPostCustomersReq } from "./AdminPostCustomersReq" +export type { AdminPostDiscountsDiscountConditions } from "./AdminPostDiscountsDiscountConditions" +export type { AdminPostDiscountsDiscountConditionsCondition } from "./AdminPostDiscountsDiscountConditionsCondition" +export type { AdminPostDiscountsDiscountConditionsConditionBatchParams } from "./AdminPostDiscountsDiscountConditionsConditionBatchParams" +export type { AdminPostDiscountsDiscountConditionsConditionBatchReq } from "./AdminPostDiscountsDiscountConditionsConditionBatchReq" +export type { AdminPostDiscountsDiscountConditionsConditionParams } from "./AdminPostDiscountsDiscountConditionsConditionParams" +export type { AdminPostDiscountsDiscountConditionsParams } from "./AdminPostDiscountsDiscountConditionsParams" +export type { AdminPostDiscountsDiscountDynamicCodesReq } from "./AdminPostDiscountsDiscountDynamicCodesReq" +export type { AdminPostDiscountsDiscountParams } from "./AdminPostDiscountsDiscountParams" +export type { AdminPostDiscountsDiscountReq } from "./AdminPostDiscountsDiscountReq" +export type { AdminPostDiscountsParams } from "./AdminPostDiscountsParams" +export type { AdminPostDiscountsReq } from "./AdminPostDiscountsReq" +export type { AdminPostDraftOrdersDraftOrderLineItemsItemReq } from "./AdminPostDraftOrdersDraftOrderLineItemsItemReq" +export type { AdminPostDraftOrdersDraftOrderLineItemsReq } from "./AdminPostDraftOrdersDraftOrderLineItemsReq" +export type { AdminPostDraftOrdersDraftOrderRegisterPaymentRes } from "./AdminPostDraftOrdersDraftOrderRegisterPaymentRes" +export type { AdminPostDraftOrdersDraftOrderReq } from "./AdminPostDraftOrdersDraftOrderReq" +export type { AdminPostDraftOrdersReq } from "./AdminPostDraftOrdersReq" +export type { AdminPostGiftCardsGiftCardReq } from "./AdminPostGiftCardsGiftCardReq" +export type { AdminPostGiftCardsReq } from "./AdminPostGiftCardsReq" +export type { AdminPostInventoryItemsInventoryItemParams } from "./AdminPostInventoryItemsInventoryItemParams" +export type { AdminPostInventoryItemsInventoryItemReq } from "./AdminPostInventoryItemsInventoryItemReq" +export type { AdminPostInventoryItemsItemLocationLevelsLevelParams } from "./AdminPostInventoryItemsItemLocationLevelsLevelParams" +export type { AdminPostInventoryItemsItemLocationLevelsLevelReq } from "./AdminPostInventoryItemsItemLocationLevelsLevelReq" +export type { AdminPostInventoryItemsItemLocationLevelsParams } from "./AdminPostInventoryItemsItemLocationLevelsParams" +export type { AdminPostInventoryItemsItemLocationLevelsReq } from "./AdminPostInventoryItemsItemLocationLevelsReq" +export type { AdminPostInventoryItemsParams } from "./AdminPostInventoryItemsParams" +export type { AdminPostInventoryItemsReq } from "./AdminPostInventoryItemsReq" +export type { AdminPostInvitesInviteAcceptReq } from "./AdminPostInvitesInviteAcceptReq" +export type { AdminPostInvitesReq } from "./AdminPostInvitesReq" +export type { AdminPostNotesNoteReq } from "./AdminPostNotesNoteReq" +export type { AdminPostNotesReq } from "./AdminPostNotesReq" +export type { AdminPostNotificationsNotificationResendReq } from "./AdminPostNotificationsNotificationResendReq" +export type { AdminPostOrderEditsEditLineItemsLineItemReq } from "./AdminPostOrderEditsEditLineItemsLineItemReq" +export type { AdminPostOrderEditsEditLineItemsReq } from "./AdminPostOrderEditsEditLineItemsReq" +export type { AdminPostOrderEditsOrderEditReq } from "./AdminPostOrderEditsOrderEditReq" +export type { AdminPostOrderEditsReq } from "./AdminPostOrderEditsReq" +export type { AdminPostOrdersOrderClaimsClaimFulfillmentsReq } from "./AdminPostOrdersOrderClaimsClaimFulfillmentsReq" +export type { AdminPostOrdersOrderClaimsClaimReq } from "./AdminPostOrdersOrderClaimsClaimReq" +export type { AdminPostOrdersOrderClaimsClaimShipmentsReq } from "./AdminPostOrdersOrderClaimsClaimShipmentsReq" +export type { AdminPostOrdersOrderClaimsReq } from "./AdminPostOrdersOrderClaimsReq" +export type { AdminPostOrdersOrderFulfillmentsReq } from "./AdminPostOrdersOrderFulfillmentsReq" +export type { AdminPostOrdersOrderRefundsReq } from "./AdminPostOrdersOrderRefundsReq" +export type { AdminPostOrdersOrderReq } from "./AdminPostOrdersOrderReq" +export type { AdminPostOrdersOrderReturnsReq } from "./AdminPostOrdersOrderReturnsReq" +export type { AdminPostOrdersOrderShipmentReq } from "./AdminPostOrdersOrderShipmentReq" +export type { AdminPostOrdersOrderShippingMethodsReq } from "./AdminPostOrdersOrderShippingMethodsReq" +export type { AdminPostOrdersOrderSwapsParams } from "./AdminPostOrdersOrderSwapsParams" +export type { AdminPostOrdersOrderSwapsReq } from "./AdminPostOrdersOrderSwapsReq" +export type { AdminPostOrdersOrderSwapsSwapFulfillmentsReq } from "./AdminPostOrdersOrderSwapsSwapFulfillmentsReq" +export type { AdminPostOrdersOrderSwapsSwapShipmentsReq } from "./AdminPostOrdersOrderSwapsSwapShipmentsReq" +export type { AdminPostPaymentRefundsReq } from "./AdminPostPaymentRefundsReq" +export type { AdminPostPriceListPricesPricesReq } from "./AdminPostPriceListPricesPricesReq" +export type { AdminPostPriceListsPriceListPriceListReq } from "./AdminPostPriceListsPriceListPriceListReq" +export type { AdminPostPriceListsPriceListReq } from "./AdminPostPriceListsPriceListReq" +export type { AdminPostProductCategoriesCategoryParams } from "./AdminPostProductCategoriesCategoryParams" +export type { AdminPostProductCategoriesCategoryProductsBatchParams } from "./AdminPostProductCategoriesCategoryProductsBatchParams" +export type { AdminPostProductCategoriesCategoryProductsBatchReq } from "./AdminPostProductCategoriesCategoryProductsBatchReq" +export type { AdminPostProductCategoriesCategoryReq } from "./AdminPostProductCategoriesCategoryReq" +export type { AdminPostProductCategoriesParams } from "./AdminPostProductCategoriesParams" +export type { AdminPostProductCategoriesReq } from "./AdminPostProductCategoriesReq" +export type { AdminPostProductsProductMetadataReq } from "./AdminPostProductsProductMetadataReq" +export type { AdminPostProductsProductOptionsOption } from "./AdminPostProductsProductOptionsOption" +export type { AdminPostProductsProductOptionsReq } from "./AdminPostProductsProductOptionsReq" +export type { AdminPostProductsProductReq } from "./AdminPostProductsProductReq" +export type { AdminPostProductsProductVariantsReq } from "./AdminPostProductsProductVariantsReq" +export type { AdminPostProductsProductVariantsVariantReq } from "./AdminPostProductsProductVariantsVariantReq" +export type { AdminPostProductsReq } from "./AdminPostProductsReq" +export type { AdminPostProductsToCollectionReq } from "./AdminPostProductsToCollectionReq" +export type { AdminPostPublishableApiKeySalesChannelsBatchReq } from "./AdminPostPublishableApiKeySalesChannelsBatchReq" +export type { AdminPostPublishableApiKeysPublishableApiKeyReq } from "./AdminPostPublishableApiKeysPublishableApiKeyReq" +export type { AdminPostPublishableApiKeysReq } from "./AdminPostPublishableApiKeysReq" +export type { AdminPostRegionsRegionCountriesReq } from "./AdminPostRegionsRegionCountriesReq" +export type { AdminPostRegionsRegionFulfillmentProvidersReq } from "./AdminPostRegionsRegionFulfillmentProvidersReq" +export type { AdminPostRegionsRegionPaymentProvidersReq } from "./AdminPostRegionsRegionPaymentProvidersReq" +export type { AdminPostRegionsRegionReq } from "./AdminPostRegionsRegionReq" +export type { AdminPostRegionsReq } from "./AdminPostRegionsReq" +export type { AdminPostReservationsReq } from "./AdminPostReservationsReq" +export type { AdminPostReservationsReservationReq } from "./AdminPostReservationsReservationReq" +export type { AdminPostReturnReasonsReasonReq } from "./AdminPostReturnReasonsReasonReq" +export type { AdminPostReturnReasonsReq } from "./AdminPostReturnReasonsReq" +export type { AdminPostReturnsReturnReceiveReq } from "./AdminPostReturnsReturnReceiveReq" +export type { AdminPostSalesChannelsChannelProductsBatchReq } from "./AdminPostSalesChannelsChannelProductsBatchReq" +export type { AdminPostSalesChannelsChannelStockLocationsReq } from "./AdminPostSalesChannelsChannelStockLocationsReq" +export type { AdminPostSalesChannelsReq } from "./AdminPostSalesChannelsReq" +export type { AdminPostSalesChannelsSalesChannelReq } from "./AdminPostSalesChannelsSalesChannelReq" +export type { AdminPostShippingOptionsOptionReq } from "./AdminPostShippingOptionsOptionReq" +export type { AdminPostShippingOptionsReq } from "./AdminPostShippingOptionsReq" +export type { AdminPostShippingProfilesProfileReq } from "./AdminPostShippingProfilesProfileReq" +export type { AdminPostShippingProfilesReq } from "./AdminPostShippingProfilesReq" +export type { AdminPostStockLocationsLocationReq } from "./AdminPostStockLocationsLocationReq" +export type { AdminPostStockLocationsReq } from "./AdminPostStockLocationsReq" +export type { AdminPostStoreReq } from "./AdminPostStoreReq" +export type { AdminPostTaxRatesParams } from "./AdminPostTaxRatesParams" +export type { AdminPostTaxRatesReq } from "./AdminPostTaxRatesReq" +export type { AdminPostTaxRatesTaxRateParams } from "./AdminPostTaxRatesTaxRateParams" +export type { AdminPostTaxRatesTaxRateProductsParams } from "./AdminPostTaxRatesTaxRateProductsParams" +export type { AdminPostTaxRatesTaxRateProductsReq } from "./AdminPostTaxRatesTaxRateProductsReq" +export type { AdminPostTaxRatesTaxRateProductTypesParams } from "./AdminPostTaxRatesTaxRateProductTypesParams" +export type { AdminPostTaxRatesTaxRateProductTypesReq } from "./AdminPostTaxRatesTaxRateProductTypesReq" +export type { AdminPostTaxRatesTaxRateReq } from "./AdminPostTaxRatesTaxRateReq" +export type { AdminPostTaxRatesTaxRateShippingOptionsParams } from "./AdminPostTaxRatesTaxRateShippingOptionsParams" +export type { AdminPostTaxRatesTaxRateShippingOptionsReq } from "./AdminPostTaxRatesTaxRateShippingOptionsReq" +export type { AdminPostUploadsDownloadUrlReq } from "./AdminPostUploadsDownloadUrlReq" +export type { AdminPriceListDeleteBatchRes } from "./AdminPriceListDeleteBatchRes" +export type { AdminPriceListDeleteProductPricesRes } from "./AdminPriceListDeleteProductPricesRes" +export type { AdminPriceListDeleteRes } from "./AdminPriceListDeleteRes" +export type { AdminPriceListDeleteVariantPricesRes } from "./AdminPriceListDeleteVariantPricesRes" +export type { AdminPriceListRes } from "./AdminPriceListRes" +export type { AdminPriceListsListRes } from "./AdminPriceListsListRes" +export type { AdminPriceListsProductsListRes } from "./AdminPriceListsProductsListRes" +export type { AdminProductCategoriesCategoryDeleteRes } from "./AdminProductCategoriesCategoryDeleteRes" +export type { AdminProductCategoriesCategoryRes } from "./AdminProductCategoriesCategoryRes" +export type { AdminProductCategoriesListRes } from "./AdminProductCategoriesListRes" +export type { AdminProductsDeleteOptionRes } from "./AdminProductsDeleteOptionRes" +export type { AdminProductsDeleteRes } from "./AdminProductsDeleteRes" +export type { AdminProductsDeleteVariantRes } from "./AdminProductsDeleteVariantRes" +export type { AdminProductsListRes } from "./AdminProductsListRes" +export type { AdminProductsListTagsRes } from "./AdminProductsListTagsRes" +export type { AdminProductsListTypesRes } from "./AdminProductsListTypesRes" +export type { AdminProductsListVariantsRes } from "./AdminProductsListVariantsRes" +export type { AdminProductsRes } from "./AdminProductsRes" +export type { AdminProductTagsListRes } from "./AdminProductTagsListRes" +export type { AdminProductTypesListRes } from "./AdminProductTypesListRes" +export type { AdminPublishableApiKeyDeleteRes } from "./AdminPublishableApiKeyDeleteRes" +export type { AdminPublishableApiKeysListRes } from "./AdminPublishableApiKeysListRes" +export type { AdminPublishableApiKeysListSalesChannelsRes } from "./AdminPublishableApiKeysListSalesChannelsRes" +export type { AdminPublishableApiKeysRes } from "./AdminPublishableApiKeysRes" +export type { AdminRefundRes } from "./AdminRefundRes" +export type { AdminRegionsDeleteRes } from "./AdminRegionsDeleteRes" +export type { AdminRegionsListRes } from "./AdminRegionsListRes" +export type { AdminRegionsRes } from "./AdminRegionsRes" +export type { AdminReservationsDeleteRes } from "./AdminReservationsDeleteRes" +export type { AdminReservationsListRes } from "./AdminReservationsListRes" +export type { AdminReservationsRes } from "./AdminReservationsRes" +export type { AdminResetPasswordRequest } from "./AdminResetPasswordRequest" +export type { AdminResetPasswordTokenRequest } from "./AdminResetPasswordTokenRequest" +export type { AdminReturnReasonsDeleteRes } from "./AdminReturnReasonsDeleteRes" +export type { AdminReturnReasonsListRes } from "./AdminReturnReasonsListRes" +export type { AdminReturnReasonsRes } from "./AdminReturnReasonsRes" +export type { AdminReturnsCancelRes } from "./AdminReturnsCancelRes" +export type { AdminReturnsListRes } from "./AdminReturnsListRes" +export type { AdminReturnsRes } from "./AdminReturnsRes" +export type { AdminSalesChannelsDeleteLocationRes } from "./AdminSalesChannelsDeleteLocationRes" +export type { AdminSalesChannelsDeleteRes } from "./AdminSalesChannelsDeleteRes" +export type { AdminSalesChannelsListRes } from "./AdminSalesChannelsListRes" +export type { AdminSalesChannelsRes } from "./AdminSalesChannelsRes" +export type { AdminShippingOptionsDeleteRes } from "./AdminShippingOptionsDeleteRes" +export type { AdminShippingOptionsListRes } from "./AdminShippingOptionsListRes" +export type { AdminShippingOptionsRes } from "./AdminShippingOptionsRes" +export type { AdminShippingProfilesListRes } from "./AdminShippingProfilesListRes" +export type { AdminShippingProfilesRes } from "./AdminShippingProfilesRes" +export type { AdminStockLocationsDeleteRes } from "./AdminStockLocationsDeleteRes" +export type { AdminStockLocationsListRes } from "./AdminStockLocationsListRes" +export type { AdminStockLocationsRes } from "./AdminStockLocationsRes" +export type { AdminStoresRes } from "./AdminStoresRes" +export type { AdminSwapsListRes } from "./AdminSwapsListRes" +export type { AdminSwapsRes } from "./AdminSwapsRes" +export type { AdminTaxProvidersList } from "./AdminTaxProvidersList" +export type { AdminTaxRatesDeleteRes } from "./AdminTaxRatesDeleteRes" +export type { AdminTaxRatesListRes } from "./AdminTaxRatesListRes" +export type { AdminTaxRatesRes } from "./AdminTaxRatesRes" +export type { AdminUpdatePaymentCollectionsReq } from "./AdminUpdatePaymentCollectionsReq" +export type { AdminUpdateUserRequest } from "./AdminUpdateUserRequest" +export type { AdminUploadsDownloadUrlRes } from "./AdminUploadsDownloadUrlRes" +export type { AdminUploadsRes } from "./AdminUploadsRes" +export type { AdminUserRes } from "./AdminUserRes" +export type { AdminUsersListRes } from "./AdminUsersListRes" +export type { AdminVariantsListRes } from "./AdminVariantsListRes" +export type { AdminVariantsRes } from "./AdminVariantsRes" +export type { BatchJob } from "./BatchJob" +export type { Cart } from "./Cart" +export type { ClaimImage } from "./ClaimImage" +export type { ClaimItem } from "./ClaimItem" +export type { ClaimOrder } from "./ClaimOrder" +export type { ClaimTag } from "./ClaimTag" +export type { Country } from "./Country" +export type { CreateStockLocationInput } from "./CreateStockLocationInput" +export type { Currency } from "./Currency" +export type { Customer } from "./Customer" +export type { CustomerGroup } from "./CustomerGroup" +export type { CustomShippingOption } from "./CustomShippingOption" +export type { Discount } from "./Discount" +export type { DiscountCondition } from "./DiscountCondition" +export type { DiscountConditionCustomerGroup } from "./DiscountConditionCustomerGroup" +export type { DiscountConditionProduct } from "./DiscountConditionProduct" +export type { DiscountConditionProductCollection } from "./DiscountConditionProductCollection" +export type { DiscountConditionProductTag } from "./DiscountConditionProductTag" +export type { DiscountConditionProductType } from "./DiscountConditionProductType" +export type { DiscountRule } from "./DiscountRule" +export type { DraftOrder } from "./DraftOrder" +export type { Error } from "./Error" +export type { ExtendedStoreDTO } from "./ExtendedStoreDTO" +export type { FeatureFlagsResponse } from "./FeatureFlagsResponse" +export type { Fulfillment } from "./Fulfillment" +export type { FulfillmentItem } from "./FulfillmentItem" +export type { FulfillmentProvider } from "./FulfillmentProvider" +export type { GetOrderEditsOrderEditParams } from "./GetOrderEditsOrderEditParams" +export type { GetOrderEditsParams } from "./GetOrderEditsParams" +export type { GetPaymentsParams } from "./GetPaymentsParams" +export type { GetPublishableApiKeySalesChannelsParams } from "./GetPublishableApiKeySalesChannelsParams" +export type { GetPublishableApiKeysParams } from "./GetPublishableApiKeysParams" +export type { GiftCard } from "./GiftCard" +export type { GiftCardTransaction } from "./GiftCardTransaction" +export type { IdempotencyKey } from "./IdempotencyKey" +export type { Image } from "./Image" +export type { InventoryItemDTO } from "./InventoryItemDTO" +export type { InventoryLevelDTO } from "./InventoryLevelDTO" +export type { Invite } from "./Invite" +export type { LineItem } from "./LineItem" +export type { LineItemAdjustment } from "./LineItemAdjustment" +export type { LineItemTaxLine } from "./LineItemTaxLine" +export type { ModulesResponse } from "./ModulesResponse" +export type { MoneyAmount } from "./MoneyAmount" +export type { MultipleErrors } from "./MultipleErrors" +export type { Note } from "./Note" +export type { Notification } from "./Notification" +export type { NotificationProvider } from "./NotificationProvider" +export type { OAuth } from "./OAuth" +export type { Order } from "./Order" +export type { OrderEdit } from "./OrderEdit" +export type { OrderItemChange } from "./OrderItemChange" +export type { Payment } from "./Payment" +export type { PaymentCollection } from "./PaymentCollection" +export type { PaymentProvider } from "./PaymentProvider" +export type { PaymentSession } from "./PaymentSession" +export type { PricedProduct } from "./PricedProduct" +export type { PricedShippingOption } from "./PricedShippingOption" +export type { PricedVariant } from "./PricedVariant" +export type { PriceList } from "./PriceList" +export type { Product } from "./Product" +export type { ProductCategory } from "./ProductCategory" +export type { ProductCollection } from "./ProductCollection" +export type { ProductOption } from "./ProductOption" +export type { ProductOptionValue } from "./ProductOptionValue" +export type { ProductTag } from "./ProductTag" +export type { ProductTaxRate } from "./ProductTaxRate" +export type { ProductType } from "./ProductType" +export type { ProductTypeTaxRate } from "./ProductTypeTaxRate" +export type { ProductVariant } from "./ProductVariant" +export type { ProductVariantInventoryItem } from "./ProductVariantInventoryItem" +export type { PublishableApiKey } from "./PublishableApiKey" +export type { PublishableApiKeySalesChannel } from "./PublishableApiKeySalesChannel" +export type { Refund } from "./Refund" +export type { Region } from "./Region" +export type { ReservationItemDTO } from "./ReservationItemDTO" +export type { ResponseInventoryItem } from "./ResponseInventoryItem" +export type { Return } from "./Return" +export type { ReturnItem } from "./ReturnItem" +export type { ReturnReason } from "./ReturnReason" +export type { SalesChannel } from "./SalesChannel" +export type { SalesChannelLocation } from "./SalesChannelLocation" +export type { ShippingMethod } from "./ShippingMethod" +export type { ShippingMethodTaxLine } from "./ShippingMethodTaxLine" +export type { ShippingOption } from "./ShippingOption" +export type { ShippingOptionRequirement } from "./ShippingOptionRequirement" +export type { ShippingProfile } from "./ShippingProfile" +export type { ShippingTaxRate } from "./ShippingTaxRate" +export type { StagedJob } from "./StagedJob" +export type { StockLocationAddressDTO } from "./StockLocationAddressDTO" +export type { StockLocationAddressInput } from "./StockLocationAddressInput" +export type { StockLocationDTO } from "./StockLocationDTO" +export type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO" +export type { Store } from "./Store" +export type { StoreAuthRes } from "./StoreAuthRes" +export type { StoreCartShippingOptionsListRes } from "./StoreCartShippingOptionsListRes" +export type { StoreCartsRes } from "./StoreCartsRes" +export type { StoreCollectionsListRes } from "./StoreCollectionsListRes" +export type { StoreCollectionsRes } from "./StoreCollectionsRes" +export type { StoreCompleteCartRes } from "./StoreCompleteCartRes" +export type { StoreCustomersListOrdersRes } from "./StoreCustomersListOrdersRes" +export type { StoreCustomersListPaymentMethodsRes } from "./StoreCustomersListPaymentMethodsRes" +export type { StoreCustomersRes } from "./StoreCustomersRes" +export type { StoreCustomersResetPasswordRes } from "./StoreCustomersResetPasswordRes" +export type { StoreGetAuthEmailRes } from "./StoreGetAuthEmailRes" +export type { StoreGetCollectionsParams } from "./StoreGetCollectionsParams" +export type { StoreGetCustomersCustomerOrdersParams } from "./StoreGetCustomersCustomerOrdersParams" +export type { StoreGetOrdersParams } from "./StoreGetOrdersParams" +export type { StoreGetPaymentCollectionsParams } from "./StoreGetPaymentCollectionsParams" +export type { StoreGetProductCategoriesCategoryParams } from "./StoreGetProductCategoriesCategoryParams" +export type { StoreGetProductCategoriesCategoryRes } from "./StoreGetProductCategoriesCategoryRes" +export type { StoreGetProductCategoriesParams } from "./StoreGetProductCategoriesParams" +export type { StoreGetProductCategoriesRes } from "./StoreGetProductCategoriesRes" +export type { StoreGetProductsParams } from "./StoreGetProductsParams" +export type { StoreGetProductsProductParams } from "./StoreGetProductsProductParams" +export type { StoreGetProductTagsParams } from "./StoreGetProductTagsParams" +export type { StoreGetProductTypesParams } from "./StoreGetProductTypesParams" +export type { StoreGetRegionsParams } from "./StoreGetRegionsParams" +export type { StoreGetShippingOptionsParams } from "./StoreGetShippingOptionsParams" +export type { StoreGetVariantsParams } from "./StoreGetVariantsParams" +export type { StoreGetVariantsVariantParams } from "./StoreGetVariantsVariantParams" +export type { StoreGiftCardsRes } from "./StoreGiftCardsRes" +export type { StoreOrderEditsRes } from "./StoreOrderEditsRes" +export type { StoreOrdersRes } from "./StoreOrdersRes" +export type { StorePaymentCollectionSessionsReq } from "./StorePaymentCollectionSessionsReq" +export type { StorePaymentCollectionsRes } from "./StorePaymentCollectionsRes" +export type { StorePaymentCollectionsSessionRes } from "./StorePaymentCollectionsSessionRes" +export type { StorePostAuthReq } from "./StorePostAuthReq" +export type { StorePostCartReq } from "./StorePostCartReq" +export type { StorePostCartsCartLineItemsItemReq } from "./StorePostCartsCartLineItemsItemReq" +export type { StorePostCartsCartLineItemsReq } from "./StorePostCartsCartLineItemsReq" +export type { StorePostCartsCartPaymentSessionReq } from "./StorePostCartsCartPaymentSessionReq" +export type { StorePostCartsCartPaymentSessionUpdateReq } from "./StorePostCartsCartPaymentSessionUpdateReq" +export type { StorePostCartsCartReq } from "./StorePostCartsCartReq" +export type { StorePostCartsCartShippingMethodReq } from "./StorePostCartsCartShippingMethodReq" +export type { StorePostCustomersCustomerAcceptClaimReq } from "./StorePostCustomersCustomerAcceptClaimReq" +export type { StorePostCustomersCustomerAddressesAddressReq } from "./StorePostCustomersCustomerAddressesAddressReq" +export type { StorePostCustomersCustomerAddressesReq } from "./StorePostCustomersCustomerAddressesReq" +export type { StorePostCustomersCustomerOrderClaimReq } from "./StorePostCustomersCustomerOrderClaimReq" +export type { StorePostCustomersCustomerPasswordTokenReq } from "./StorePostCustomersCustomerPasswordTokenReq" +export type { StorePostCustomersCustomerReq } from "./StorePostCustomersCustomerReq" +export type { StorePostCustomersReq } from "./StorePostCustomersReq" +export type { StorePostCustomersResetPasswordReq } from "./StorePostCustomersResetPasswordReq" +export type { StorePostOrderEditsOrderEditDecline } from "./StorePostOrderEditsOrderEditDecline" +export type { StorePostPaymentCollectionsBatchSessionsAuthorizeReq } from "./StorePostPaymentCollectionsBatchSessionsAuthorizeReq" +export type { StorePostPaymentCollectionsBatchSessionsReq } from "./StorePostPaymentCollectionsBatchSessionsReq" +export type { StorePostReturnsReq } from "./StorePostReturnsReq" +export type { StorePostSearchReq } from "./StorePostSearchReq" +export type { StorePostSearchRes } from "./StorePostSearchRes" +export type { StorePostSwapsReq } from "./StorePostSwapsReq" +export type { StoreProductsListRes } from "./StoreProductsListRes" +export type { StoreProductsRes } from "./StoreProductsRes" +export type { StoreProductTagsListRes } from "./StoreProductTagsListRes" +export type { StoreProductTypesListRes } from "./StoreProductTypesListRes" +export type { StoreRegionsListRes } from "./StoreRegionsListRes" +export type { StoreRegionsRes } from "./StoreRegionsRes" +export type { StoreReturnReasonsListRes } from "./StoreReturnReasonsListRes" +export type { StoreReturnReasonsRes } from "./StoreReturnReasonsRes" +export type { StoreReturnsRes } from "./StoreReturnsRes" +export type { StoreShippingOptionsListRes } from "./StoreShippingOptionsListRes" +export type { StoreSwapsRes } from "./StoreSwapsRes" +export type { StoreVariantsListRes } from "./StoreVariantsListRes" +export type { StoreVariantsRes } from "./StoreVariantsRes" +export type { Swap } from "./Swap" +export type { TaxLine } from "./TaxLine" +export type { TaxProvider } from "./TaxProvider" +export type { TaxRate } from "./TaxRate" +export type { TrackingLink } from "./TrackingLink" +export type { UpdateStockLocationInput } from "./UpdateStockLocationInput" +export type { User } from "./User" +export type { VariantInventory } from "./VariantInventory" diff --git a/scripts/assert-codegen-build-committed-actions.sh b/scripts/assert-codegen-build-committed-actions.sh new file mode 100755 index 0000000000..7312f4b016 --- /dev/null +++ b/scripts/assert-codegen-build-committed-actions.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +# Stackoverflow: How do I programmatically determine if there are uncommitted changes? +# https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes + +IS_CI="${CI:-false}" + +if [ "$IS_CI" = true ]; then + git config --local url."https://github.com/".insteadOf git@github.com: + git config --local user.name "Medusajs Bot" + git config --local user.email "core@medusa-commerce.com" +fi + +FILE_CHANGES=$(git status --porcelain=v1 | grep 'packages/generated') +FILE_CHANGES_COUNT=$(git status --porcelain=v1 | grep 'packages/generated' | wc -l) + +if [ "$IS_CI" = true ]; then + git config --local --unset user.name + git config --local --unset user.email + git config --local --unset url."https://github.com/".insteadOf +fi + +if [ "$FILE_CHANGES_COUNT" -ne 0 ]; then + echo "$FILE_CHANGES" + echo "Latest codegen build was not committed. Run 'yarn build' and commit generated files." + exit 1 +else + echo "All has been committed." + exit 0 +fi \ No newline at end of file