chore: remove generated client types (#7259)

* chores: rm generated client types

* chores: rm generated client types

* update lock file

* fix yarn
This commit is contained in:
Adrien de Peretti
2024-05-07 15:36:29 +02:00
committed by GitHub
parent 71f4f46cb9
commit 8db62827ac
490 changed files with 20 additions and 20441 deletions
@@ -7,7 +7,8 @@ import {
ProductHeader,
} from "../../../../../components/table/table-cells/product/product-cell"
import { MoneyAmountCell } from "../../../../../components/table/table-cells/common/money-amount-cell"
import { PricedVariant } from "@medusajs/client-types"
type PricedVariant = any // TODO: PricedVariant
const columnHelper = createColumnHelper<PricedVariant>()
@@ -1,5 +1,3 @@
import { PricedVariant } from "@medusajs/client-types"
import { Order } from "@medusajs/medusa"
import { Button } from "@medusajs/ui"
import { OnChangeFn, RowSelectionState } from "@tanstack/react-table"
import { useAdminVariants } from "medusa-react"
@@ -14,6 +12,9 @@ import { useVariantTableColumns } from "./use-variant-table-columns"
import { useVariantTableFilters } from "./use-variant-table-filters"
import { useVariantTableQuery } from "./use-variant-table-query"
type Order = any // TODO: Order
type PricedVariant = any // TODO: Order
const PAGE_SIZE = 50
export type Option = {
@@ -1,2 +0,0 @@
node_modules
/dist
@@ -1,130 +0,0 @@
# @medusajs/client-types
## 0.2.11
### Patch Changes
- [#6812](https://github.com/medusajs/medusa/pull/6812) [`e005987adf`](https://github.com/medusajs/medusa/commit/e005987adf2a2dd8c2748e7abc360cc93e7c05ad) Thanks [@shahednasser](https://github.com/shahednasser)! - fix(medusa-oas-cli): fix tool not working in Medusa backends
- [#6680](https://github.com/medusajs/medusa/pull/6680) [`26531c5a38`](https://github.com/medusajs/medusa/commit/26531c5a38bf09ab3e77a1444cefd65a073ae713) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - feat(ui-preset): Pull latest styles from Figma.
fix(ui): Fix invalid state styling of Select, so it correctly shows when aria-invalid is true.
fix(medusa): Align query params between `/admin/products/:id/variants` and `/admin/variants`.
chore(client-types): Update `medusa` client types to reflect changes to the API.
## 0.2.10
### Patch Changes
- [#6633](https://github.com/medusajs/medusa/pull/6633) [`e124762873`](https://github.com/medusajs/medusa/commit/e124762873cd43af8eefa9fee4698450fdf8c30f) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Allows to filter price list products by multiple ids.
- [#6550](https://github.com/medusajs/medusa/pull/6550) [`fb25471e92`](https://github.com/medusajs/medusa/commit/fb25471e927c0cc91525f5e0134b935cd36596b5) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Adds updated_at query param to list-reservations. Fixes OAS for list-inventory-items.
- [#6606](https://github.com/medusajs/medusa/pull/6606) [`c2d56ca12b`](https://github.com/medusajs/medusa/commit/c2d56ca12b89af078b885a0acced20e29bf6f8f5) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Fixes pagination on list Tax Rate endpoint, and also adds missing query params like order, search and filters.
- [#6658](https://github.com/medusajs/medusa/pull/6658) [`78e5ec459a`](https://github.com/medusajs/medusa/commit/78e5ec459a637946482a3ee9f8b437656686988f) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Add missing query params to draft order list endpoint
- [#6380](https://github.com/medusajs/medusa/pull/6380) [`d37ff8024d`](https://github.com/medusajs/medusa/commit/d37ff8024d8affbe84db3c0b6d79cd41016bfac4) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa,ui): Fixes list query params for the following endpoints: "/admin/customers", "/admin/customer-groups", "/admin/gift-cards", and "/admin/collections".
- [#6483](https://github.com/medusajs/medusa/pull/6483) [`e076590ff2`](https://github.com/medusajs/medusa/commit/e076590ff2a9587d66ffdac672bdd254cb9918f1) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Add query params to Pub. API key endpoint
- [#6428](https://github.com/medusajs/medusa/pull/6428) [`44d43e8155`](https://github.com/medusajs/medusa/commit/44d43e8155d1b1ca0af5e900787411c7d0b027c0) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - feat(medusa,medusa-js,medusa-react,icons): Fixes GET /admin/products/:id/variants endpoint in the core, and medusa-js and medusa-react. Pulls latest icons from Figma into `@medusajs/icons`.
## 0.2.9
### Patch Changes
- [#6258](https://github.com/medusajs/medusa/pull/6258) [`90cff0777`](https://github.com/medusajs/medusa/commit/90cff0777fd351771f3713bf84f4c327c64d276c) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Adds support for ordering GET /admin/orders
## 0.2.8
### Patch Changes
- [#6201](https://github.com/medusajs/medusa/pull/6201) [`489b7effb`](https://github.com/medusajs/medusa/commit/489b7effb013b2ffb38693ace14fb8cce2dd7ab4) Thanks [@olivermrbl](https://github.com/olivermrbl)! - fix(medusa): Support q search in currencies
- [#6208](https://github.com/medusajs/medusa/pull/6208) [`134af7766`](https://github.com/medusajs/medusa/commit/134af77667c278622e3731ba41602d297852fedb) Thanks [@kasperkristensen](https://github.com/kasperkristensen)! - fix(medusa): Enable pagination, search and ordering of shipping option list endpoint
## 0.2.7
### Patch Changes
- [#5599](https://github.com/medusajs/medusa/pull/5599) [`b3093c3e3`](https://github.com/medusajs/medusa/commit/b3093c3e3d64e4c024a04d76fb0f727c1c38108b) Thanks [@bqst](https://github.com/bqst)! - feat(medusa): Add `metadata` to Product Category
## 0.2.6
### Patch Changes
- [#5582](https://github.com/medusajs/medusa/pull/5582) [`91615f9c4`](https://github.com/medusajs/medusa/commit/91615f9c459a2d8cb842561c5edb335680d30298) Thanks [@shahednasser](https://github.com/shahednasser)! - fix(@medusajs/client-types): Fix types and TSDocs
fix(medusa-react): Fix response type of Publishable API Key's list sales channels.
fix(@medusajs/medusa-js): Fix incorrect parameter and response types.
fix(@medusajs/medusa): Fix incorrect types and add TSDocs
fix(@medusajs/types): Fix incorrect types and add TSDocs
## 0.2.5
### Patch Changes
- [#4953](https://github.com/medusajs/medusa/pull/4953) [`9781089ca`](https://github.com/medusajs/medusa/commit/9781089ca301221011c58423add3bf81b74b068b) Thanks [@shahednasser](https://github.com/shahednasser)! - fix(medusa): fix types for upload endpoints
## 0.2.4
### Patch Changes
- [#4230](https://github.com/medusajs/medusa/pull/4230) [`2f283996f`](https://github.com/medusajs/medusa/commit/2f283996f80313b074b96c690bcd953c67665c1b) Thanks [@erikengervall](https://github.com/erikengervall)! - feat(medusa): Add `metadata` to `StorePostCartsCartLineItemsItemReq`
## 0.2.3
### Patch Changes
- [#4066](https://github.com/medusajs/medusa/pull/4066) [`4fb443c0e`](https://github.com/medusajs/medusa/commit/4fb443c0ea38bde3148bce059c0ee3b91dfff3d4) Thanks [@pKorsholm](https://github.com/pKorsholm)! - feat(medusa,client-types): add location_id filtering to list-location levels
- [#3979](https://github.com/medusajs/medusa/pull/3979) [`3a38c84f8`](https://github.com/medusajs/medusa/commit/3a38c84f88b05f74ee0a172af3e3f78b2ec8c2d2) Thanks [@pKorsholm](https://github.com/pKorsholm)! - feat(client-types, inventory, medusa, types): add additional filtering capabilities to list-reservations
- [#4081](https://github.com/medusajs/medusa/pull/4081) [`4f3c8f5d7`](https://github.com/medusajs/medusa/commit/4f3c8f5d70b5ae4a11e9d4a2fea4a8410b2daf47) Thanks [@pKorsholm](https://github.com/pKorsholm)! - feat(medusa,client-types,medusa-js,admin-ui,medusa-react): add reservation table and creation
## 0.2.2
### Patch Changes
- [#3924](https://github.com/medusajs/medusa/pull/3924) [`cfcd2d54f`](https://github.com/medusajs/medusa/commit/cfcd2d54fd281fd98de881fc6dfbcc6b1b47c855) Thanks [@pevey](https://github.com/pevey)! - Add separator after tmpdir base
## 0.2.1
### Patch Changes
- [#3971](https://github.com/medusajs/medusa/pull/3971) [`7fd22ecb4`](https://github.com/medusajs/medusa/commit/7fd22ecb4d5190e92c6750a9fbf2d8534bb9f4ab) Thanks [@pKorsholm](https://github.com/pKorsholm)! - Feat(client-types, inventory, medusa, types): add `title`, `thumbnail` and `description to inventory item and `description` to reservation item.
## 0.2.0
### Minor Changes
- [#3477](https://github.com/medusajs/medusa/pull/3477) [`826d4bedf`](https://github.com/medusajs/medusa/commit/826d4bedfe1b6459163711d5173eb8eadfdea26e) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(codegen,types): SetRelation on expanded types
### Patch Changes
- [#3483](https://github.com/medusajs/medusa/pull/3483) [`13f40d721`](https://github.com/medusajs/medusa/commit/13f40d721702fbcdf6c131354ec9a81322d4a662) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(oas): declare x-expanded-relations - Admin
- [#3482](https://github.com/medusajs/medusa/pull/3482) [`522e306e2`](https://github.com/medusajs/medusa/commit/522e306e2e9abf4afce63f30714389eba32bef7f) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(oas): declare x-expanded-relations - Store
- [#3492](https://github.com/medusajs/medusa/pull/3492) [`e6e529152`](https://github.com/medusajs/medusa/commit/e6e529152792e63a71664fb88567276a820e9908) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(codegen): commit generated client types to codebase
- [#3452](https://github.com/medusajs/medusa/pull/3452) [`55febef7f`](https://github.com/medusajs/medusa/commit/55febef7f1e74a07e76039d1ffbcb721c08adeb2) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(types): package scaffolding for generated types
- [#3478](https://github.com/medusajs/medusa/pull/3478) [`6748877c6`](https://github.com/medusajs/medusa/commit/6748877c694c1433f666c6987f20af76b201b495) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - fix(oas,js,react): use AdminExtendedStoresRes instead of AdminStoresRes
## 0.2.0-rc.0
### Minor Changes
- [#3477](https://github.com/medusajs/medusa/pull/3477) [`826d4bedf`](https://github.com/medusajs/medusa/commit/826d4bedfe1b6459163711d5173eb8eadfdea26e) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(codegen,types): SetRelation on expanded types
### Patch Changes
- [#3483](https://github.com/medusajs/medusa/pull/3483) [`13f40d721`](https://github.com/medusajs/medusa/commit/13f40d721702fbcdf6c131354ec9a81322d4a662) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(oas): declare x-expanded-relations - Admin
- [#3482](https://github.com/medusajs/medusa/pull/3482) [`522e306e2`](https://github.com/medusajs/medusa/commit/522e306e2e9abf4afce63f30714389eba32bef7f) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(oas): declare x-expanded-relations - Store
- [#3492](https://github.com/medusajs/medusa/pull/3492) [`e6e529152`](https://github.com/medusajs/medusa/commit/e6e529152792e63a71664fb88567276a820e9908) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(codegen): commit generated client types to codebase
- [#3452](https://github.com/medusajs/medusa/pull/3452) [`55febef7f`](https://github.com/medusajs/medusa/commit/55febef7f1e74a07e76039d1ffbcb721c08adeb2) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - feat(types): package scaffolding for generated types
- [#3478](https://github.com/medusajs/medusa/pull/3478) [`6748877c6`](https://github.com/medusajs/medusa/commit/6748877c694c1433f666c6987f20af76b201b495) Thanks [@patrick-medusajs](https://github.com/patrick-medusajs)! - fix(oas,js,react): use AdminExtendedStoresRes instead of AdminStoresRes
-19
View File
@@ -1,19 +0,0 @@
# Medusa Client Types
TypeScript types derived from the OpenAPI Spec (OAS) to be used in API clients.
The source code is generated using the `medusa-oas` CLI tooling.
## Install
`yarn add --dev @medusa/client-types`
## How to use
Import in the client.
```typescript
import type { AdminCustomersRes } from "@medusajs/client-types"
import type { Customer } from "@medusajs/client-types"
import type { StoreGetProductCategoryParams } from "@medusajs/client-types"
```
@@ -1,35 +0,0 @@
{
"name": "@medusajs/client-types",
"version": "0.2.11",
"description": "Client types for Medusa Commerce Rest API",
"main": "dist/index.js",
"files": [
"dist"
],
"scripts": {
"prepublishOnly": "cross-env NODE_ENV=production tsc --build",
"build": "echo ''",
"prebuild": "ts-node ./scripts/build.ts && yarn prettier",
"prettier": "prettier --write --loglevel warn ./src/lib",
"test": "jest --passWithNoTests"
},
"author": "Medusa",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/medusajs/medusa",
"directory": "packages/generate/client-types"
},
"bugs": {
"url": "https://github.com/medusajs/medusa/issues"
},
"devDependencies": {
"@medusajs/medusa-oas-cli": "0.3.2",
"cross-env": "^7.0.3",
"execa": "^5.1.1",
"jest": "^27.4.7",
"prettier": "^2.7.1",
"ts-node": "^10.9.1",
"typescript": "^4.9.5"
}
}
@@ -1,60 +0,0 @@
import execa from "execa"
import os from "os"
import fs from "fs/promises"
import path from "path"
import { sep } from "path"
const basePath = path.resolve(__dirname, `../`)
async function run() {
const tmpDirPath = await getTmpDirectory()
await generateOASSources(tmpDirPath)
const oasFilePath = path.resolve(tmpDirPath, `combined.oas.json`)
const outDirPath = path.resolve(basePath, "src/lib/")
await generateClientTypes(oasFilePath, outDirPath, true)
}
const generateOASSources = async (outDir: string) => {
const params = ["oas", `--out-dir=${outDir}`, "--type=combined", "--local"]
const { all: logs } = await execa("medusa-oas", params, {
cwd: basePath,
all: true,
})
console.log(logs)
}
const generateClientTypes = async (
srcFile: string,
outDir: string,
clean = false
) => {
const params = [
"client",
`--src-file=${srcFile}`,
`--out-dir=${outDir}`,
"--type=combined",
"--component=types",
]
if (clean) {
params.push("--clean")
}
const { all: logs } = await execa("medusa-oas", params, {
cwd: basePath,
all: true,
})
console.log(logs)
}
const getTmpDirectory = async () => {
/**
* RUNNER_TEMP: GitHub action, the path to a temporary directory on the runner.
*/
const tmpDir = process.env["RUNNER_TEMP"] ?? os.tmpdir()
return await fs.mkdtemp(`${tmpDir}${sep}`)
}
void (async () => {
await run()
})()
@@ -1,6 +0,0 @@
{
"extends": "../tsconfig.json",
"include": [
"./**/*"
]
}
@@ -1,7 +0,0 @@
export * from "./lib"
export {
Merge,
SetNonNullable,
SetRelation,
SetRequired,
} from "./lib/core/ModelUtils"
@@ -1,121 +0,0 @@
/* 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<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true
? never
: KeyType extends ExcludeType
? never
: KeyType
// https://github.com/sindresorhus/type-fest/blob/main/source/enforce-optional.d.ts
type RequiredFilter<Type, Key extends keyof Type> = undefined extends Type[Key]
? Type[Key] extends undefined
? Key
: never
: Key
type OptionalFilter<Type, Key extends keyof Type> = 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<Destination, Source> = {
[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<T> = { [KeyType in keyof T]: T[KeyType] } & {}
export type IsEqual<A, B> = (<G>() => G extends A ? 1 : 2) extends <
G
>() => G extends B ? 1 : 2
? true
: false
export type Except<ObjectType, KeysType extends keyof ObjectType> = {
[KeyType in keyof ObjectType as Filter<
KeyType,
KeysType
>]: ObjectType[KeyType]
}
export type OmitIndexSignature<ObjectType> = {
[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
? never
: KeyType]: ObjectType[KeyType]
}
export type PickIndexSignature<ObjectType> = {
[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
? KeyType
: never]: ObjectType[KeyType]
}
export type EnforceOptional<ObjectType> = Simplify<
{
[Key in keyof ObjectType as RequiredFilter<
ObjectType,
Key
>]: ObjectType[Key]
} & {
[Key in keyof ObjectType as OptionalFilter<ObjectType, Key>]?: Exclude<
ObjectType[Key],
undefined
>
}
>
/**
* SetRequired
*/
export type SetRequired<BaseType, Keys extends keyof BaseType> = Simplify<
// Pick just the keys that are optional from the base type.
Except<BaseType, Keys> &
// Pick the keys that should be required from the base type and make them required.
Required<Pick<BaseType, Keys>>
>
/**
* SetNonNullable
*/
export type SetNonNullable<
BaseType,
Keys extends keyof BaseType = keyof BaseType
> = {
[Key in keyof BaseType]: Key extends Keys
? NonNullable<BaseType[Key]>
: BaseType[Key]
}
/**
* Merge
*/
export type Merge<Destination, Source> = EnforceOptional<
SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>> &
SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>
>
/**
* SetRelation
* Alias combining SetRequire and SetNonNullable.
*/
export type SetRelation<BaseType, Keys extends keyof BaseType> = SetRequired<
SetNonNullable<BaseType, Keys>,
Keys
>
@@ -1,5 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
export * from "./models"
@@ -1,85 +0,0 @@
/* 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 is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
*/
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.
*/
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<string, any> | null
}
@@ -1,51 +0,0 @@
/* 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<string, any>
}
@@ -1,54 +0,0 @@
/* 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
*/
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<string, any>
}
@@ -1,13 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { OAuth } from "./OAuth"
export interface AdminAppsListRes {
/**
* An array of app details.
*/
apps: Array<OAuth>
}
@@ -1,13 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { OAuth } from "./OAuth"
export interface AdminAppsRes {
/**
* App details.
*/
apps: OAuth
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { User } from "./User"
/**
* The user's details.
*/
export interface AdminAuthRes {
/**
* User details.
*/
user: User
}
@@ -1,25 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { BatchJob } from "./BatchJob"
export interface AdminBatchJobListRes {
/**
* An array of batch job details.
*/
batch_jobs: Array<BatchJob>
/**
* The total number of items available
*/
count: number
/**
* The number of batch jobs skipped when retrieving the batch jobs.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { BatchJob } from "./BatchJob"
/**
* The batch job's details.
*/
export interface AdminBatchJobRes {
/**
* Batch job details.
*/
batch_job: BatchJob
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The access token of the user, if they're authenticated successfully.
*/
export interface AdminBearerAuthRes {
/**
* Access token that can be used to send authenticated requests.
*/
access_token?: string
}
@@ -1,19 +0,0 @@
/* 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
}
@@ -1,25 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { ProductCollection } from "./ProductCollection"
export interface AdminCollectionsListRes {
/**
* an array of collection details
*/
collections: Array<ProductCollection>
/**
* The total number of items available
*/
count: number
/**
* The number of product collections skipped when retrieving the product collections.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { ProductCollection } from "./ProductCollection"
/**
* The collection's details.
*/
export interface AdminCollectionsRes {
/**
* Product Collection details.
*/
collection: SetRelation<ProductCollection, "products">
}
@@ -1,27 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminCreateUserRequest {
/**
* The User's email.
*/
email: string
/**
* The first name of the User.
*/
first_name?: string
/**
* The last name of the User.
*/
last_name?: string
/**
* The role assigned to the user. These roles don't provide any different privileges.
*/
role?: "admin" | "member" | "developer"
/**
* The User's password.
*/
password: string
}
@@ -1,28 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { Currency } from "./Currency"
/**
* List of currencies with pagination fields.
*/
export interface AdminCurrenciesListRes {
/**
* An array of currency details.
*/
currencies: Array<Currency>
/**
* The total number of items available
*/
count: number
/**
* The number of currencies skipped when retrieving the currencies.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { Currency } from "./Currency"
/**
* A currency's details.
*/
export interface AdminCurrenciesRes {
/**
* Currency details.
*/
currency: Currency
}
@@ -1,19 +0,0 @@
/* 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
}
@@ -1,25 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { CustomerGroup } from "./CustomerGroup"
export interface AdminCustomerGroupsListRes {
/**
* An array of customer group details.
*/
customer_groups: Array<CustomerGroup>
/**
* The total number of items available
*/
count: number
/**
* The number of customer groups skipped when retrieving the customer groups.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { CustomerGroup } from "./CustomerGroup"
/**
* The customer group's details.
*/
export interface AdminCustomerGroupsRes {
/**
* Customer group details.
*/
customer_group: CustomerGroup
}
@@ -1,28 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { Customer } from "./Customer"
/**
* The list of customers with pagination fields.
*/
export interface AdminCustomersListRes {
/**
* An array of customer details.
*/
customers: Array<Customer>
/**
* The total number of items available
*/
count: number
/**
* The number of customers skipped when retrieving the customers.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { Customer } from "./Customer"
/**
* The customer's details.
*/
export interface AdminCustomersRes {
/**
* Customer details.
*/
customer: SetRelation<Customer, "orders" | "shipping_addresses">
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The customers to remove from the customer group.
*/
export interface AdminDeleteCustomerGroupsGroupCustomerBatchReq {
/**
* The ids of the customers to remove
*/
customer_ids: Array<{
/**
* ID of the customer
*/
id: string
}>
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The resources to remove.
*/
export interface AdminDeleteDiscountsDiscountConditionsConditionBatchReq {
/**
* The resources to be removed from the discount condition
*/
resources: Array<{
/**
* The id of the item
*/
id: string
}>
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminDeleteDiscountsDiscountConditionsConditionParams {
/**
* Comma-separated relations that should be expanded in the returned discount.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned discount.
*/
fields?: string
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the prices to delete.
*/
export interface AdminDeletePriceListPricesPricesReq {
/**
* The IDs of the prices to delete.
*/
price_ids?: Array<string>
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the products' prices to delete.
*/
export interface AdminDeletePriceListsPriceListProductsPricesBatchReq {
/**
* The IDs of the products to delete their associated prices.
*/
product_ids?: Array<string>
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminDeleteProductCategoriesCategoryProductsBatchParams {
/**
* Comma-separated relations that should be expanded in the returned product category.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned product category.
*/
fields?: string
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the products to delete from the product category.
*/
export interface AdminDeleteProductCategoriesCategoryProductsBatchReq {
/**
* The IDs of the products to delete from the product category.
*/
product_ids: Array<{
/**
* The ID of a product
*/
id: string
}>
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the products to remove from the collection.
*/
export interface AdminDeleteProductsFromCollectionReq {
/**
* An array of Product IDs to remove from the Product Collection.
*/
product_ids: Array<string>
}
@@ -1,22 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* Deletion operation details
*/
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<string>
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the sales channels to remove from the publishable API key.
*/
export interface AdminDeletePublishableApiKeySalesChannelsBatchReq {
/**
* The IDs of the sales channels to remove from the publishable API key
*/
sales_channel_ids: Array<{
/**
* The ID of the sales channel
*/
id: string
}>
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the products to delete from the sales channel.
*/
export interface AdminDeleteSalesChannelsChannelProductsBatchReq {
/**
* The IDs of the products to remove from the sales channel.
*/
product_ids: Array<{
/**
* The ID of a product
*/
id: string
}>
}
@@ -1,11 +0,0 @@
/* 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
}
@@ -1,19 +0,0 @@
/* 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
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminDeleteTaxRatesTaxRateProductTypesParams {
/**
* Comma-separated fields that should be included in the returned tax rate.
*/
fields?: Array<string>
/**
* Comma-separated relations that should be expanded in the returned tax rate.
*/
expand?: Array<string>
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* Product types to remove from the tax rates.
*/
export interface AdminDeleteTaxRatesTaxRateProductTypesReq {
/**
* The IDs of the product types to remove their association with this tax rate.
*/
product_types: Array<string>
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminDeleteTaxRatesTaxRateProductsParams {
/**
* Comma-separated fields that should be included in the returned tax rate.
*/
fields?: Array<string>
/**
* Comma-separated relations that should be expanded in the returned tax rate.
*/
expand?: Array<string>
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the products to remove their associated with the tax rate.
*/
export interface AdminDeleteTaxRatesTaxRateProductsReq {
/**
* The IDs of the products to remove their association with this tax rate.
*/
products: Array<string>
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminDeleteTaxRatesTaxRateShippingOptionsParams {
/**
* Comma-separated fields that should be included in the returned tax rate.
*/
fields?: Array<string>
/**
* Comma-separated relations that should be expanded in the returned tax rate.
*/
expand?: Array<string>
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the shipping options to remove their associate with the tax rate.
*/
export interface AdminDeleteTaxRatesTaxRateShippingOptionsReq {
/**
* The IDs of the shipping options to remove their association with this tax rate.
*/
shipping_options: Array<string>
}
@@ -1,14 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The details of the file to delete.
*/
export interface AdminDeleteUploadsReq {
/**
* key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly.
*/
file_key: string
}
@@ -1,19 +0,0 @@
/* 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
}
@@ -1,19 +0,0 @@
/* 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
}
@@ -1,25 +0,0 @@
/* 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 Discount Condition
*/
id: string
/**
* The type of the object that was deleted.
*/
object: string
/**
* Whether the discount condition was deleted successfully.
*/
deleted: boolean
/**
* The Discount to which the condition used to belong to.
*/
discount: Discount
}
@@ -1,13 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { DiscountCondition } from "./DiscountCondition"
export interface AdminDiscountConditionsRes {
/**
* Discount condition details.
*/
discount_condition: SetRelation<DiscountCondition, "discount_rule">
}
@@ -1,19 +0,0 @@
/* 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.
*/
deleted: boolean
}
@@ -1,36 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { Discount } from "./Discount"
import type { DiscountRule } from "./DiscountRule"
/**
* The list of discounts with pagination fields.
*/
export interface AdminDiscountsListRes {
/**
* The list of discounts.
*/
discounts: Array<
Merge<
SetRelation<Discount, "parent_discount" | "regions" | "rule">,
{
rule: SetRelation<DiscountRule, "conditions">
}
>
>
/**
* The total number of items available
*/
count: number
/**
* The number of discounts skipped when retrieving the discounts.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,26 +0,0 @@
/* 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"
/**
* The discount's details.
*/
export interface AdminDiscountsRes {
/**
* Discount details.
*/
discount: Merge<
SetRelation<Discount, "parent_discount" | "regions" | "rule">,
{
regions: Array<
SetRelation<Region, "fulfillment_providers" | "payment_providers">
>
rule: SetRelation<DiscountRule, "conditions">
}
>
}
@@ -1,19 +0,0 @@
/* 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.
*/
deleted: boolean
}
@@ -1,42 +0,0 @@
/* 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"
/**
* The list of draft orders with pagination fields.
*/
export interface AdminDraftOrdersListRes {
/**
* An array of draft order's details.
*/
draft_orders: Array<
Merge<
SetRelation<DraftOrder, "order" | "cart">,
{
cart: Merge<
SetRelation<Cart, "items">,
{
items: Array<SetRelation<LineItem, "adjustments">>
}
>
}
>
>
/**
* The total number of items available
*/
count: number
/**
* The number of draft orders skipped when retrieving the draft orders.
*/
offset: number
/**
* The number of items per page
*/
limit: number
}
@@ -1,89 +0,0 @@
/* 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 { Product } from "./Product"
import type { ProductVariant } from "./ProductVariant"
import type { Region } from "./Region"
import type { ShippingMethod } from "./ShippingMethod"
/**
* The list of draft orders.
*/
export interface AdminDraftOrdersRes {
/**
* Draft order's details.
*/
draft_order: Merge<
SetRelation<DraftOrder, "order" | "cart">,
{
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: Merge<
SetRelation<ProductVariant, "product">,
{
product: SetRelation<Product, "profiles">
}
>
}
>
>
discounts: Array<SetRelation<Discount, "rule">>
region: SetRelation<
Region,
"payment_providers" | "tax_rates" | "fulfillment_providers"
>
shipping_methods: Array<
SetRelation<ShippingMethod, "shipping_option" | "tax_lines">
>
}
>
}
>
}
@@ -1,16 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
import type { ExtendedStoreDTO } from "./ExtendedStoreDTO"
/**
* The store's details with additional details like payment and tax providers.
*/
export interface AdminExtendedStoresRes {
/**
* Store details.
*/
store: SetRelation<ExtendedStoreDTO, "currencies" | "default_currency">
}
@@ -1,182 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetBatchParams {
/**
* Limit the number of batch jobs returned.
*/
limit?: number
/**
* The number of batch jobs to skip when retrieving the batch jobs.
*/
offset?: number
/**
* Filter by the batch ID
*/
id?: string | Array<string>
/**
* Filter by the batch type
*/
type?: Array<string>
/**
* Filter by a confirmation date range.
*/
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
}
/**
* Filter by a pre-processing date range.
*/
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
}
/**
* Filter by a completion date range.
*/
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
}
/**
* Filter by a failure date range.
*/
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
}
/**
* Filter by a cancelation date range.
*/
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
}
/**
* A batch-job field to sort-order the retrieved batch jobs by.
*/
order?: string
/**
* Comma-separated relations that should be expanded in the returned batch jobs.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned batch jobs.
*/
fields?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
}
@@ -1,98 +0,0 @@
/* 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 when retrieving the collections.
*/
offset?: number
/**
* Filter collections by their title.
*/
title?: string
/**
* Filter collections by their handle.
*/
handle?: string
/**
* a term to search collections by their title or handle.
*/
q?: string
/**
* A field to sort-order the retrieved collections by.
*/
order?: string
/**
* Filter collections by a discount condition ID associated with them.
*/
discount_condition_id?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
}
@@ -1,31 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetCurrenciesParams {
/**
* filter by currency code.
*/
code?: string
/**
* filter currencies by whether they include taxes or not.
*/
includes_tax?: boolean
/**
* A field to sort order the retrieved currencies by.
*/
order?: string
/**
* Term used to search currencies' name and code.
*/
q?: string
/**
* The number of currencies to skip when retrieving the currencies.
*/
offset?: number
/**
* The number of currencies to return.
*/
limit?: number
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetCustomerGroupsGroupParams {
/**
* Comma-separated relations that should be expanded in the returned customer group.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned customer group.
*/
fields?: string
}
@@ -1,105 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetCustomerGroupsParams {
/**
* term to search customer groups by name.
*/
q?: string
/**
* The number of customer groups to skip when retrieving the customer groups.
*/
offset?: number
/**
* A field to sort order the retrieved customer groups by.
*/
order?: string
/**
* Filter by discount condition ID.
*/
discount_condition_id?: string
/**
* Filter by the customer group ID
*/
id?:
| string
| Array<string>
| {
/**
* 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<string>
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* The number of customer groups to return.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned customer groups.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned customer groups.
*/
fields?: string
}
@@ -1,81 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetCustomersParams {
/**
* The number of customers to return.
*/
limit?: number
/**
* The number of customers to skip when retrieving the customers.
*/
offset?: number
/**
* Comma-separated relations that should be expanded in the returned customers.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned customers.
*/
fields?: string
/**
* term to search customers' email, first_name, and last_name fields.
*/
q?: string
/**
* Filter customers by whether they have an account.
*/
has_account?: boolean
/**
* A field to sort-order the retrieved customers by.
*/
order?: string
/**
* Filter by customer group IDs.
*/
groups?: Array<string>
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetDiscountParams {
/**
* Comma-separated relations that should be expanded in the returned discount.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned discount.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetDiscountsDiscountCodeParams {
/**
* Comma-separated relations that should be expanded in the returned discount.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned discount.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetDiscountsDiscountConditionsConditionParams {
/**
* Comma-separated relations that should be expanded in the returned discount condition.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned discount condition.
*/
fields?: string
}
@@ -1,90 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetDiscountsParams {
/**
* term to search discounts' code field.
*/
q?: string
/**
* Filter discounts by rule fields.
*/
rule?: {
/**
* Filter discounts by type.
*/
type?: "fixed" | "percentage" | "free_shipping"
/**
* Filter discounts by allocation type.
*/
allocation?: "total" | "item"
}
/**
* Filter discounts by whether they're dynamic or not.
*/
is_dynamic?: boolean
/**
* Filter discounts by whether they're disabled or not.
*/
is_disabled?: boolean
/**
* The number of discounts to return
*/
limit?: number
/**
* The number of discounts to skip when retrieving the discounts.
*/
offset?: number
/**
* Comma-separated relations that should be expanded in each returned discount.
*/
expand?: string
/**
* A discount field to sort-order the retrieved discounts by.
*/
order?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
}
@@ -1,77 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetDraftOrdersParams {
/**
* The number of draft orders to skip when retrieving the draft orders.
*/
offset?: number
/**
* Limit the number of draft orders returned.
*/
limit?: number
/**
* a term to search draft orders' display IDs and emails in the draft order's cart
*/
q?: string
/**
* Field to sort retrieved draft orders by.
*/
order?: string
/**
* A comma-separated list of fields to expand.
*/
expand?: string
/**
* A comma-separated list of fields to include in the response.
*/
fields?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by status
*/
status?: Array<"open" | "completed">
}
@@ -1,23 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetGiftCardsParams {
/**
* The number of gift cards to skip when retrieving the gift cards.
*/
offset?: number
/**
* Limit the number of gift cards returned.
*/
limit?: number
/**
* a term to search gift cards' code or display ID
*/
q?: string
/**
* A gift card field to sort-order the retrieved gift cards by.
*/
order?: string
}
@@ -1,23 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetGroupsGroupCustomersParams {
/**
* The number of customers to return.
*/
limit?: number
/**
* The number of customers to skip when retrieving the customers.
*/
offset?: number
/**
* Comma-separated relations that should be expanded in the returned customers.
*/
expand?: string
/**
* a term to search customers by email, first_name, and last_name.
*/
q?: string
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetInventoryItemsItemLocationLevelsParams {
/**
* Filter by location IDs.
*/
location_id?: Array<string>
/**
* Comma-separated relations that should be expanded in the returned inventory levels.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned inventory levels.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetInventoryItemsItemParams {
/**
* Comma-separated relations that should be expanded in the returned inventory item.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned inventory item.
*/
fields?: string
}
@@ -1,79 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetInventoryItemsParams {
/**
* The number of inventory items to skip when retrieving the inventory items.
*/
offset?: number
/**
* Limit the number of inventory items returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in each returned inventory item.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned inventory item.
*/
fields?: string
/**
* term to search inventory item's sku, title, and description.
*/
q?: string
/**
* Field to sort-order inventory items by.
*/
order?: string
/**
* Filter by location IDs.
*/
location_id?: Array<string>
/**
* Filter by the inventory ID
*/
id?: string | Array<string>
/**
* Filter by SKU
*/
sku?: string
/**
* Filter by origin country
*/
origin_country?: string
/**
* Filter by MID code
*/
mid_code?: string
/**
* Filter by material
*/
material?: string
/**
* Filter by HS Code
*/
hs_code?: string
/**
* Filter by weight
*/
weight?: string
/**
* Filter by length
*/
length?: string
/**
* Filter by height
*/
height?: string
/**
* Filter by width
*/
width?: string
/**
* Filter by whether the item requires shipping
*/
requires_shipping?: string
}
@@ -1,19 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetNotesParams {
/**
* Limit the number of notes returned.
*/
limit?: number
/**
* The number of notes to skip when retrieving the notes.
*/
offset?: number
/**
* Filter by resource ID
*/
resource_id?: string
}
@@ -1,43 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetNotificationsParams {
/**
* The number of inventory items to skip when retrieving the inventory items.
*/
offset?: number
/**
* Limit the number of notifications returned.
*/
limit?: number
/**
* Comma-separated fields that should be included in each returned notification.
*/
fields?: string
/**
* Comma-separated relations that should be expanded in each returned notification.
*/
expand?: string
/**
* Filter by the name of the event that triggered sending this notification.
*/
event_name?: string
/**
* Filter by the resource type.
*/
resource_type?: string
/**
* Filter by the resource ID.
*/
resource_id?: string
/**
* Filter by the address that the Notification was sent to. This will usually be an email address, but it can also 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
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetOrdersOrderParams {
/**
* Comma-separated relations that should be expanded in the returned order.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned order.
*/
fields?: string
}
@@ -1,162 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetOrdersParams {
/**
* term to search orders' shipping address, first name, email, and display ID
*/
q?: string
/**
* Filter by ID.
*/
id?: string
/**
* Filter by status
*/
status?: Array<
"pending" | "completed" | "archived" | "canceled" | "requires_action"
>
/**
* Filter by fulfillment status
*/
fulfillment_status?: Array<
| "not_fulfilled"
| "fulfilled"
| "partially_fulfilled"
| "shipped"
| "partially_shipped"
| "canceled"
| "returned"
| "partially_returned"
| "requires_action"
>
/**
* Filter by payment status
*/
payment_status?: Array<
| "captured"
| "awaiting"
| "not_paid"
| "refunded"
| "partially_refunded"
| "canceled"
| "requires_action"
>
/**
* Filter by display ID
*/
display_id?: string
/**
* Filter by cart ID
*/
cart_id?: string
/**
* Filter by customer ID
*/
customer_id?: string
/**
* Filter by email
*/
email?: string
/**
* Filter by region IDs.
*/
region_id?: string | Array<string>
/**
* Filter by currency codes.
*/
currency_code?: string
/**
* Filter by tax rate.
*/
tax_rate?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a cancelation date range.
*/
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 Channel IDs
*/
sales_channel_id?: Array<string>
/**
* The number of orders to skip when retrieving the orders.
*/
offset?: number
/**
* Limit the number of orders returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned order.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned order.
*/
fields?: string
/**
* Field to sort retrieved orders by.
*/
order?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetPaymentCollectionsParams {
/**
* Comma-separated relations that should be expanded in the returned payment collection.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned payment collection.
*/
fields?: string
}
@@ -1,114 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetPriceListPaginationParams {
/**
* Limit the number of price lists returned.
*/
limit?: number
/**
* The number of price lists to skip when retrieving the price lists.
*/
offset?: number
/**
* Comma-separated relations that should be expanded in the returned price lists.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned price lists.
*/
fields?: string
/**
* A price-list field to sort-order the retrieved price lists by.
*/
order?: string
/**
* Filter by ID
*/
id?: string
/**
* term to search price lists' description, name, and customer group's name.
*/
q?: string
/**
* Filter by status.
*/
status?: Array<"active" | "draft">
/**
* Filter by name
*/
name?: string
/**
* Filter by customer-group IDs.
*/
customer_groups?: Array<string>
/**
* Filter by type.
*/
type?: Array<"sale" | "override">
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
}
@@ -1,130 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetPriceListsPriceListProductsParams {
/**
* term used to search products' title, description, product variant's title and sku, and product collection's title.
*/
q?: string
/**
* Filter by product IDs.
*/
id?: string | Array<string>
/**
* Filter by product status
*/
status?: Array<"draft" | "proposed" | "published" | "rejected">
/**
* Filter by product collection ID. Only products in the specified collections are retrieved.
*/
collection_id?: Array<string>
/**
* Filter by tag IDs. Only products having the specified tags are retrieved.
*/
tags?: Array<string>
/**
* Filter by title
*/
title?: string
/**
* Filter by description
*/
description?: string
/**
* Filter by handle
*/
handle?: string
/**
* A boolean value to filter by whether the product is a gift card or not.
*/
is_giftcard?: boolean
/**
* Filter product type.
*/
type?: string
/**
* A product field to sort-order the retrieved products by.
*/
order?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
/**
* The number of products to skip when retrieving the products.
*/
offset?: number
/**
* Limit the number of products returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned products.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned products.
*/
fields?: string
}
@@ -1,47 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetProductCategoriesParams {
/**
* term to search product categories' names and handles.
*/
q?: string
/**
* Filter by handle.
*/
handle?: string
/**
* Filter by whether the category is internal or not.
*/
is_internal?: boolean
/**
* Filter by whether the category is active or not.
*/
is_active?: boolean
/**
* If set to `true`, all nested descendants of a category are included in the response.
*/
include_descendants_tree?: boolean
/**
* Filter by the ID of a parent category.
*/
parent_category_id?: string
/**
* The number of product categories to skip when retrieving the product categories.
*/
offset?: number
/**
* Limit the number of product categories returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned product categories.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned product categories.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetProductCategoryParams {
/**
* Comma-separated relations that should be expanded in the returned product category.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned product category.
*/
fields?: string
}
@@ -1,77 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetProductTagsParams {
/**
* Limit the number of product tags returned.
*/
limit?: number
/**
* The number of product tags to skip when retrieving the product tags.
*/
offset?: number
/**
* A product tag field to sort-order the retrieved product tags by.
*/
order?: string
/**
* Filter by the ID of a discount condition. Only product tags that this discount condition is applied to will be retrieved.
*/
discount_condition_id?: string
/**
* Filter by tag value.
*/
value?: Array<string>
/**
* term to search product tags' values.
*/
q?: string
/**
* Filter by tag IDs.
*/
id?: Array<string>
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
}
@@ -1,77 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetProductTypesParams {
/**
* Limit the number of product types returned.
*/
limit?: number
/**
* The number of product types to skip when retrieving the product types.
*/
offset?: number
/**
* A product type field to sort-order the retrieved product types by.
*/
order?: string
/**
* Filter by the ID of a discount condition. Only product types that this discount condition is applied to will be retrieved.
*/
discount_condition_id?: string
/**
* Filter by value.
*/
value?: Array<string>
/**
* Filter by product type IDs.
*/
id?: Array<string>
/**
* term to search product types' values.
*/
q?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
}
@@ -1,150 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetProductsParams {
/**
* term to search products' title, description, variants' title and sku, and collections' title.
*/
q?: string
/**
* Filter by the ID of a discount condition. Only products that this discount condition is applied to will be retrieved.
*/
discount_condition_id?: string
/**
* Filter by product IDs.
*/
id?: string | Array<string>
/**
* Filter by status.
*/
status?: Array<"draft" | "proposed" | "published" | "rejected">
/**
* Filter by product collection IDs. Only products that are associated with the specified collections will be retrieved.
*/
collection_id?: Array<string>
/**
* Filter by product tag IDs. Only products that are associated with the specified tags will be retrieved.
*/
tags?: Array<string>
/**
* Filter by IDs of price lists. Only products that these price lists are applied to will be retrieved.
*/
price_list_id?: Array<string>
/**
* Filter by sales channel IDs. Only products that are available in the specified sales channels will be retrieved.
*/
sales_channel_id?: Array<string>
/**
* Filter by product type IDs. Only products that are associated with the specified types will be retrieved.
*/
type_id?: Array<string>
/**
* Filter by product category IDs. Only products that are associated with the specified categories will be retrieved.
*/
category_id?: Array<string>
/**
* whether to include product category children when filtering by `category_id`
*/
include_category_children?: boolean
/**
* Filter by title.
*/
title?: string
/**
* Filter by description.
*/
description?: string
/**
* Filter by handle.
*/
handle?: string
/**
* Whether to retrieve gift cards or regular products.
*/
is_giftcard?: boolean
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
/**
* The number of products to skip when retrieving the products.
*/
offset?: number
/**
* Limit the number of products returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned products.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned products.
*/
fields?: string
/**
* A product field to sort-order the retrieved products by.
*/
order?: string
}
@@ -1,108 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetProductsVariantsParams {
/**
* IDs to filter product variants by.
*/
id?: string
/**
* Comma-separated fields that should be included in the returned product variants.
*/
fields?: string
/**
* Comma-separated relations that should be expanded in the returned product variants.
*/
expand?: string
/**
* The number of product variants to skip when retrieving the product variants.
*/
offset?: number
/**
* Limit the number of product variants returned.
*/
limit?: number
/**
* Search term to search product variants' title, sku, and products' title.
*/
q?: string
/**
* The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
*/
order?: string
/**
* Filter product variants by whether their inventory is managed or not.
*/
manage_inventory?: boolean
/**
* Filter product variants by whether they are allowed to be backordered or not.
*/
allow_backorder?: boolean
/**
* 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
}
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
}
@@ -1,86 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetRegionsParams {
/**
* Term used to search regions' name.
*/
q?: string
/**
* A field to sort-order the retrieved regions by.
*/
order?: string
/**
* Limit the number of regions returned.
*/
limit?: number
/**
* The number of regions to skip when retrieving the regions.
*/
offset?: number
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
}
@@ -1,23 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
/**
* The list of fulfillment options in a region.
*/
export interface AdminGetRegionsRegionFulfillmentOptionsRes {
/**
* Fulfillment providers details.
*/
fulfillment_options: Array<{
/**
* ID of the fulfillment provider
*/
provider_id: string
/**
* fulfillment provider options
*/
options: Array<Record<string, any>>
}>
}
@@ -1,96 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetReservationsParams {
/**
* Filter by location ID
*/
location_id?: Array<string>
/**
* Filter by inventory item ID.
*/
inventory_item_id?: Array<string>
/**
* Filter by line item ID.
*/
line_item_id?: Array<string>
/**
* 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
}
/**
* Filter by description.
*/
description?:
| string
| {
/**
* filter by reservation description containing search string.
*/
contains?: string
/**
* filter by reservation description starting with search string.
*/
starts_with?: string
/**
* filter by reservation description ending with search string.
*/
ends_with?: string
}
/**
* Filter by a creation date range.
*/
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
}
/**
* The number of reservations to skip when retrieving the reservations.
*/
offset?: number
/**
* Limit the number of reservations returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned reservations.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned reservations.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetReturnsParams {
/**
* Limit the number of Returns returned.
*/
limit?: number
/**
* The number of Returns to skip when retrieving the Returns.
*/
offset?: number
}
@@ -1,106 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetSalesChannelsParams {
/**
* Filter by a sales channel ID.
*/
id?: string
/**
* Filter by name.
*/
name?: string
/**
* Filter by description.
*/
description?: string
/**
* term used to search sales channels' names and descriptions.
*/
q?: string
/**
* A sales-channel field to sort-order the retrieved sales channels by.
*/
order?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
/**
* The number of sales channels to skip when retrieving the sales channels.
*/
offset?: number
/**
* Limit the number of sales channels returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned sales channels.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned sales channels.
*/
fields?: string
}
@@ -1,114 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetShippingOptionsParams {
/**
* Filter by name.
*/
name?: string
/**
* Filter by the ID of the region the shipping options belong to.
*/
region_id?: string
/**
* Filter by whether the shipping options are return shipping options.
*/
is_return?: boolean
/**
* Filter by whether the shipping options are available for admin users only.
*/
admin_only?: boolean
/**
* Term used to search shipping options' name.
*/
q?: string
/**
* A shipping option field to sort-order the retrieved shipping options by.
*/
order?: string
/**
* Filter by shipping option IDs.
*/
id?: string | Array<string>
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
/**
* The number of users to skip when retrieving the shipping options.
*/
offset?: number
/**
* Limit the number of shipping options returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned shipping options.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned shipping options.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetStockLocationsLocationParams {
/**
* Comma-separated relations that should be expanded in the returned stock location.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned stock location.
*/
fields?: string
}
@@ -1,98 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetStockLocationsParams {
/**
* Filter by ID.
*/
id?: string
/**
* Filter by name.
*/
name?: string
/**
* A stock-location field to sort-order the retrieved stock locations by.
*/
order?: string
/**
* Filter by a creation date range.
*/
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
}
/**
* Filter by an update date range.
*/
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
}
/**
* Filter by a deletion date range.
*/
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
}
/**
* The number of stock locations to skip when retrieving the stock locations.
*/
offset?: number
/**
* Limit the number of stock locations returned.
*/
limit?: number
/**
* Comma-separated relations that should be expanded in the returned stock locations.
*/
expand?: string
/**
* Comma-separated fields that should be included in the returned stock locations.
*/
fields?: string
}
@@ -1,15 +0,0 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import { SetRelation, Merge } from "../core/ModelUtils"
export interface AdminGetSwapsParams {
/**
* Limit the number of swaps returned.
*/
limit?: number
/**
* The number of swaps to skip when retrieving the swaps.
*/
offset?: number
}

Some files were not shown because too many files have changed in this diff Show More