feat(codegen): commit generated client types to codebase (#3492)
## What Commit generated client types to codebase. ## Why As a developer, we will provides better visibility on the impact of OAS changes to the generated type. Also allow for browser the types on GitHub. ## How * Remove `/lib` from .gitignore * Add a non-blocking github action check validating if the latest generated build has been committed. * Runs `yarn build --force --no-cache` on GitHub. Caching was creating false positives. * Use `git status` and filter the output to target only `packages/generated` directory. ## Test Proof of a failing check: https://github.com/medusajs/medusa/actions/runs/4432323763/jobs/7776235128 UPDATE: Failing check after updating branch with latest develop https://github.com/medusajs/medusa/actions/runs/4436707954/jobs/7785472045
This commit is contained in:
5
.changeset/seven-keys-beg.md
Normal file
5
.changeset/seven-keys-beg.md
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
"@medusajs/client-types": patch
|
||||
---
|
||||
|
||||
feat(codegen): commit generated client types to codebase
|
||||
40
.github/workflows/codegen-test.yml
vendored
Normal file
40
.github/workflows/codegen-test.yml
vendored
Normal file
@@ -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
|
||||
1
packages/generated/client-types/.gitignore
vendored
1
packages/generated/client-types/.gitignore
vendored
@@ -1,3 +1,2 @@
|
||||
node_modules
|
||||
/dist
|
||||
/src/lib
|
||||
121
packages/generated/client-types/src/lib/core/ModelUtils.ts
Normal file
121
packages/generated/client-types/src/lib/core/ModelUtils.ts
Normal file
@@ -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<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
|
||||
>
|
||||
5
packages/generated/client-types/src/lib/index.ts
Normal file
5
packages/generated/client-types/src/lib/index.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
/* istanbul ignore file */
|
||||
/* tslint:disable */
|
||||
/* eslint-disable */
|
||||
|
||||
export * from "./models"
|
||||
85
packages/generated/client-types/src/lib/models/Address.ts
Normal file
85
packages/generated/client-types/src/lib/models/Address.ts
Normal file
@@ -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<string, any> | null
|
||||
}
|
||||
@@ -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<string, any>
|
||||
}
|
||||
@@ -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<string, any>
|
||||
}
|
||||
@@ -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<OAuth>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<BatchJob>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<ProductCollection>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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<ProductCollection, "products">
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<Currency>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<CustomerGroup>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<Customer>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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<Customer, "orders" | "shipping_addresses">
|
||||
}
|
||||
@@ -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
|
||||
}>
|
||||
}
|
||||
@@ -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
|
||||
}>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}>
|
||||
}
|
||||
@@ -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<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
}
|
||||
@@ -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
|
||||
}>
|
||||
}
|
||||
@@ -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
|
||||
}>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Which fields should be expanded and retrieved in the result.
|
||||
*/
|
||||
expand?: Array<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Which fields should be expanded and retrieved in the result.
|
||||
*/
|
||||
expand?: Array<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Which fields should be expanded and retrieved in the result.
|
||||
*/
|
||||
expand?: Array<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<DiscountCondition, "discount_rule">
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<Discount, "parent_discount" | "regions" | "rule">,
|
||||
{
|
||||
rule: SetRelation<DiscountRule, "conditions">
|
||||
}
|
||||
>
|
||||
>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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<Discount, "parent_discount" | "regions" | "rule">,
|
||||
{
|
||||
regions: Array<
|
||||
SetRelation<Region, "fulfillment_providers" | "payment_providers">
|
||||
>
|
||||
rule: SetRelation<DiscountRule, "conditions">
|
||||
}
|
||||
>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<DraftOrder, "order" | "cart">,
|
||||
{
|
||||
cart: Merge<
|
||||
SetRelation<Cart, "items">,
|
||||
{
|
||||
items: Array<SetRelation<LineItem, "adjustments">>
|
||||
}
|
||||
>
|
||||
}
|
||||
>
|
||||
>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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<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: SetRelation<ProductVariant, "product">
|
||||
}
|
||||
>
|
||||
>
|
||||
discounts: Array<SetRelation<Discount, "rule">>
|
||||
region: SetRelation<
|
||||
Region,
|
||||
"payment_providers" | "tax_rates" | "fulfillment_providers"
|
||||
>
|
||||
shipping_methods: Array<
|
||||
SetRelation<ShippingMethod, "shipping_option" | "tax_lines">
|
||||
>
|
||||
}
|
||||
>
|
||||
}
|
||||
>
|
||||
}
|
||||
@@ -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<ExtendedStoreDTO, "currencies" | "default_currency">
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Filter by the batch type
|
||||
*/
|
||||
type?: Array<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<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>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* 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<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Tag IDs to search for
|
||||
*/
|
||||
tags?: Array<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* A query string to search values for
|
||||
*/
|
||||
q?: string
|
||||
/**
|
||||
* The tag IDs to search for
|
||||
*/
|
||||
id?: Array<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
|
||||
}
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* The type IDs to search for
|
||||
*/
|
||||
id?: Array<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Status to search for
|
||||
*/
|
||||
status?: Array<"draft" | "proposed" | "published" | "rejected">
|
||||
/**
|
||||
* Collection ids to search for.
|
||||
*/
|
||||
collection_id?: Array<string>
|
||||
/**
|
||||
* Tag IDs to search for
|
||||
*/
|
||||
tags?: Array<string>
|
||||
/**
|
||||
* Price List IDs to search for
|
||||
*/
|
||||
price_list_id?: Array<string>
|
||||
/**
|
||||
* Sales Channel IDs to filter products by
|
||||
*/
|
||||
sales_channel_id?: Array<string>
|
||||
/**
|
||||
* Type IDs to filter products by
|
||||
*/
|
||||
type_id?: Array<string>
|
||||
/**
|
||||
* Category IDs to filter products by
|
||||
*/
|
||||
category_id?: Array<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string, any>
|
||||
/**
|
||||
* Date comparison for when resulting region was updated, i.e. less than, greater than etc.
|
||||
*/
|
||||
updated_at?: Record<string, any>
|
||||
/**
|
||||
* Date comparison for when resulting region was deleted, i.e. less than, greater than etc.
|
||||
*/
|
||||
deleted_at?: Record<string, any>
|
||||
}
|
||||
@@ -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<Record<string, any>>
|
||||
}>
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Inventory Item ids to search for.
|
||||
*/
|
||||
inventory_item_id?: Array<string>
|
||||
/**
|
||||
* Line Item ids to search for.
|
||||
*/
|
||||
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
|
||||
}
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* 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<string>
|
||||
/**
|
||||
* Which fields should be expanded and retrieved for each item.
|
||||
*/
|
||||
expand?: Array<string>
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* Which fields should be expanded and retrieved in the result.
|
||||
*/
|
||||
expand?: Array<string>
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<string>
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
@@ -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<GiftCard, "order" | "region">,
|
||||
{
|
||||
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
|
||||
}
|
||||
@@ -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<GiftCard, "order" | "region">,
|
||||
{
|
||||
region: SetRelation<Region, "fulfillment_providers" | "payment_providers">
|
||||
}
|
||||
>
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user