@swell/apps-sdk 1.0.190 → 2.0.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +188 -254
- package/dist/backend.d.cts +81 -0
- package/dist/backend.d.ts +81 -0
- package/dist/backend.js +154 -0
- package/dist/browser-refusal.d.cts +1 -0
- package/dist/browser-refusal.d.ts +1 -0
- package/dist/browser-refusal.js +2 -0
- package/dist/context.d.cts +7 -0
- package/dist/context.d.ts +7 -0
- package/dist/context.js +29 -0
- package/dist/error.d.cts +23 -0
- package/dist/error.d.ts +23 -0
- package/dist/error.js +30 -0
- package/dist/guard.d.cts +1 -0
- package/dist/guard.d.ts +1 -0
- package/dist/guard.js +4 -0
- package/dist/index.d.cts +11 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +6 -20299
- package/dist/jwks.d.cts +1 -0
- package/dist/jwks.d.ts +1 -0
- package/dist/jwks.js +70 -0
- package/dist/request-context.d.cts +37 -0
- package/dist/request-context.d.ts +37 -0
- package/dist/request-context.js +99 -0
- package/dist/staff.d.cts +7 -0
- package/dist/staff.d.ts +7 -0
- package/dist/staff.js +7 -0
- package/dist/storefront.d.cts +28 -0
- package/dist/storefront.d.ts +28 -0
- package/dist/storefront.js +44 -0
- package/dist/version.d.cts +1 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.js +2 -0
- package/dist/workflow.d.cts +1 -0
- package/dist/workflow.d.ts +1 -0
- package/dist/workflow.js +35 -0
- package/package.json +48 -63
- package/dist/index.cjs +0 -20547
- package/dist/index.cjs.map +0 -7
- package/dist/index.js.map +0 -7
- package/dist/index.mjs +0 -20404
- package/dist/index.mjs.map +0 -7
- package/dist/src/api.d.ts +0 -96
- package/dist/src/cache/cache.d.ts +0 -41
- package/dist/src/cache/cf-worker-kv-keyv-adapter.d.ts +0 -18
- package/dist/src/cache/constants.d.ts +0 -7
- package/dist/src/cache/content-cache.d.ts +0 -21
- package/dist/src/cache/html-cache/html-cache-backend.d.ts +0 -64
- package/dist/src/cache/html-cache/html-cache-factory.d.ts +0 -9
- package/dist/src/cache/html-cache/html-cache-kv.d.ts +0 -38
- package/dist/src/cache/html-cache/html-cache-worker.d.ts +0 -8
- package/dist/src/cache/html-cache/html-cache.d.ts +0 -120
- package/dist/src/cache/html-cache/index.d.ts +0 -4
- package/dist/src/cache/index.d.ts +0 -9
- package/dist/src/cache/kv-variety.d.ts +0 -10
- package/dist/src/cache/request-cache.d.ts +0 -4
- package/dist/src/cache/resource-cache.d.ts +0 -4
- package/dist/src/cache/theme-cache.d.ts +0 -4
- package/dist/src/cache/theme-file-cache.d.ts +0 -87
- package/dist/src/compatibility/drops/all_products.d.ts +0 -10
- package/dist/src/compatibility/drops/articles.d.ts +0 -10
- package/dist/src/compatibility/drops/blogs.d.ts +0 -10
- package/dist/src/compatibility/drops/collections.d.ts +0 -19
- package/dist/src/compatibility/drops/image-src.d.ts +0 -15
- package/dist/src/compatibility/drops/image.d.ts +0 -29
- package/dist/src/compatibility/drops/images.d.ts +0 -9
- package/dist/src/compatibility/drops/money.d.ts +0 -10
- package/dist/src/compatibility/drops/object-handles.d.ts +0 -6
- package/dist/src/compatibility/drops/pages.d.ts +0 -17
- package/dist/src/compatibility/drops/robots-rule.d.ts +0 -9
- package/dist/src/compatibility/drops/template.d.ts +0 -9
- package/dist/src/compatibility/shopify-configs.d.ts +0 -8
- package/dist/src/compatibility/shopify-fonts.d.ts +0 -1
- package/dist/src/compatibility/shopify-objects/address.d.ts +0 -7
- package/dist/src/compatibility/shopify-objects/article.d.ts +0 -7
- package/dist/src/compatibility/shopify-objects/blog.d.ts +0 -6
- package/dist/src/compatibility/shopify-objects/cart.d.ts +0 -6
- package/dist/src/compatibility/shopify-objects/collection.d.ts +0 -7
- package/dist/src/compatibility/shopify-objects/collections.d.ts +0 -6
- package/dist/src/compatibility/shopify-objects/content.d.ts +0 -12
- package/dist/src/compatibility/shopify-objects/currency.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/customer.d.ts +0 -6
- package/dist/src/compatibility/shopify-objects/filter.d.ts +0 -6
- package/dist/src/compatibility/shopify-objects/font.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/form.d.ts +0 -29
- package/dist/src/compatibility/shopify-objects/image.d.ts +0 -10
- package/dist/src/compatibility/shopify-objects/index.d.ts +0 -27
- package/dist/src/compatibility/shopify-objects/line_item.d.ts +0 -7
- package/dist/src/compatibility/shopify-objects/link.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/localization.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/media.d.ts +0 -9
- package/dist/src/compatibility/shopify-objects/money.d.ts +0 -3
- package/dist/src/compatibility/shopify-objects/order.d.ts +0 -11
- package/dist/src/compatibility/shopify-objects/page.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/paginate.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/predictive_search.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/product.d.ts +0 -9
- package/dist/src/compatibility/shopify-objects/recommendations.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/resource.d.ts +0 -27
- package/dist/src/compatibility/shopify-objects/search.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/shop.d.ts +0 -5
- package/dist/src/compatibility/shopify-objects/template.d.ts +0 -4
- package/dist/src/compatibility/shopify-objects/variant.d.ts +0 -6
- package/dist/src/compatibility/shopify.d.ts +0 -134
- package/dist/src/constants.d.ts +0 -598
- package/dist/src/content.d.ts +0 -8
- package/dist/src/easyblocks/config.d.ts +0 -152
- package/dist/src/easyblocks/index.d.ts +0 -2
- package/dist/src/easyblocks/utils.d.ts +0 -23
- package/dist/src/editor/resources.d.ts +0 -9
- package/dist/src/fonts.d.ts +0 -6
- package/dist/src/globals.d.ts +0 -7
- package/dist/src/index.d.ts +0 -16
- package/dist/src/liquid/color.d.ts +0 -33
- package/dist/src/liquid/drops/render.d.ts +0 -10
- package/dist/src/liquid/filters/asset_url.d.ts +0 -3
- package/dist/src/liquid/filters/brightness_difference.d.ts +0 -2
- package/dist/src/liquid/filters/color_brightness.d.ts +0 -2
- package/dist/src/liquid/filters/color_contrast.d.ts +0 -2
- package/dist/src/liquid/filters/color_darken.d.ts +0 -2
- package/dist/src/liquid/filters/color_desaturate.d.ts +0 -2
- package/dist/src/liquid/filters/color_difference.d.ts +0 -2
- package/dist/src/liquid/filters/color_extract.d.ts +0 -4
- package/dist/src/liquid/filters/color_lighten.d.ts +0 -2
- package/dist/src/liquid/filters/color_mix.d.ts +0 -2
- package/dist/src/liquid/filters/color_modify.d.ts +0 -3
- package/dist/src/liquid/filters/color_saturate.d.ts +0 -2
- package/dist/src/liquid/filters/color_to_hex.d.ts +0 -2
- package/dist/src/liquid/filters/color_to_hsl.d.ts +0 -2
- package/dist/src/liquid/filters/color_to_rgb.d.ts +0 -2
- package/dist/src/liquid/filters/date.d.ts +0 -7
- package/dist/src/liquid/filters/date_next_interval.d.ts +0 -3
- package/dist/src/liquid/filters/default_errors.d.ts +0 -3
- package/dist/src/liquid/filters/divided_by.d.ts +0 -2
- package/dist/src/liquid/filters/embedded_content.d.ts +0 -2
- package/dist/src/liquid/filters/escape.d.ts +0 -3
- package/dist/src/liquid/filters/font_face.d.ts +0 -2
- package/dist/src/liquid/filters/font_modify.d.ts +0 -3
- package/dist/src/liquid/filters/font_url.d.ts +0 -2
- package/dist/src/liquid/filters/format_address.d.ts +0 -6
- package/dist/src/liquid/filters/handleize.d.ts +0 -3
- package/dist/src/liquid/filters/image_tag.d.ts +0 -3
- package/dist/src/liquid/filters/image_url.d.ts +0 -8
- package/dist/src/liquid/filters/index.d.ts +0 -120
- package/dist/src/liquid/filters/inline_asset_content.d.ts +0 -2
- package/dist/src/liquid/filters/inline_editable.d.ts +0 -4
- package/dist/src/liquid/filters/json.d.ts +0 -3
- package/dist/src/liquid/filters/json_pretty.d.ts +0 -3
- package/dist/src/liquid/filters/locale_flag.d.ts +0 -2
- package/dist/src/liquid/filters/minus.d.ts +0 -2
- package/dist/src/liquid/filters/money.d.ts +0 -4
- package/dist/src/liquid/filters/money_with_currency.d.ts +0 -3
- package/dist/src/liquid/filters/money_without_currency.d.ts +0 -3
- package/dist/src/liquid/filters/money_without_trailing_zeros.d.ts +0 -3
- package/dist/src/liquid/filters/preload_tag.d.ts +0 -3
- package/dist/src/liquid/filters/script_tag.d.ts +0 -3
- package/dist/src/liquid/filters/shopify/asset_img_url.d.ts +0 -3
- package/dist/src/liquid/filters/shopify/default_pagination.d.ts +0 -3
- package/dist/src/liquid/filters/shopify/hex_to_rgba.d.ts +0 -2
- package/dist/src/liquid/filters/shopify/img_url.d.ts +0 -3
- package/dist/src/liquid/filters/shopify/item_count_for_variant.d.ts +0 -6
- package/dist/src/liquid/filters/shopify/payment_button.d.ts +0 -2
- package/dist/src/liquid/filters/shopify/payment_terms.d.ts +0 -2
- package/dist/src/liquid/filters/shopify/placeholder-svgs/index.d.ts +0 -5
- package/dist/src/liquid/filters/shopify/placeholder_svg_tag.d.ts +0 -3
- package/dist/src/liquid/filters/shopify/shopify_asset_url.d.ts +0 -3
- package/dist/src/liquid/filters/shopify/structured_data.d.ts +0 -3
- package/dist/src/liquid/filters/stylesheet_tag.d.ts +0 -3
- package/dist/src/liquid/filters/time_tag.d.ts +0 -2
- package/dist/src/liquid/filters/translate.d.ts +0 -3
- package/dist/src/liquid/filters/where.d.ts +0 -3
- package/dist/src/liquid/font.d.ts +0 -51
- package/dist/src/liquid/form.d.ts +0 -17
- package/dist/src/liquid/hash.d.ts +0 -5
- package/dist/src/liquid/index.d.ts +0 -52
- package/dist/src/liquid/operators.d.ts +0 -10
- package/dist/src/liquid/tags/assign.d.ts +0 -3
- package/dist/src/liquid/tags/case.d.ts +0 -3
- package/dist/src/liquid/tags/comment.d.ts +0 -3
- package/dist/src/liquid/tags/content_for.d.ts +0 -3
- package/dist/src/liquid/tags/doc.d.ts +0 -2
- package/dist/src/liquid/tags/for.d.ts +0 -3
- package/dist/src/liquid/tags/form.d.ts +0 -3
- package/dist/src/liquid/tags/if.d.ts +0 -4
- package/dist/src/liquid/tags/index.d.ts +0 -42
- package/dist/src/liquid/tags/inline_editable.d.ts +0 -3
- package/dist/src/liquid/tags/javascript.d.ts +0 -3
- package/dist/src/liquid/tags/layout.d.ts +0 -3
- package/dist/src/liquid/tags/paginate.d.ts +0 -3
- package/dist/src/liquid/tags/render.d.ts +0 -6
- package/dist/src/liquid/tags/section.d.ts +0 -3
- package/dist/src/liquid/tags/sections.d.ts +0 -3
- package/dist/src/liquid/tags/shopify/include.d.ts +0 -3
- package/dist/src/liquid/tags/shopify/schema.d.ts +0 -3
- package/dist/src/liquid/tags/style.d.ts +0 -3
- package/dist/src/liquid/tags/stylesheet.d.ts +0 -3
- package/dist/src/liquid/test-helpers.d.ts +0 -8
- package/dist/src/liquid/tokens/identifier-token.d.ts +0 -9
- package/dist/src/liquid/tokens/index.d.ts +0 -2
- package/dist/src/liquid/tokienizer.d.ts +0 -5
- package/dist/src/liquid/utils.d.ts +0 -45
- package/dist/src/menus.d.ts +0 -25
- package/dist/src/resources/account.d.ts +0 -6
- package/dist/src/resources/addresses.d.ts +0 -7
- package/dist/src/resources/blog.d.ts +0 -7
- package/dist/src/resources/blog_category.d.ts +0 -7
- package/dist/src/resources/cart.d.ts +0 -6
- package/dist/src/resources/categories.d.ts +0 -7
- package/dist/src/resources/category.d.ts +0 -7
- package/dist/src/resources/index.d.ts +0 -48
- package/dist/src/resources/order.d.ts +0 -7
- package/dist/src/resources/orders.d.ts +0 -7
- package/dist/src/resources/page.d.ts +0 -7
- package/dist/src/resources/predictive_search.d.ts +0 -6
- package/dist/src/resources/product.d.ts +0 -7
- package/dist/src/resources/product_helpers.d.ts +0 -21
- package/dist/src/resources/search.d.ts +0 -6
- package/dist/src/resources/subscription.d.ts +0 -7
- package/dist/src/resources/subscriptions.d.ts +0 -7
- package/dist/src/resources/swell_types.d.ts +0 -163
- package/dist/src/resources/variant.d.ts +0 -9
- package/dist/src/resources.d.ts +0 -113
- package/dist/src/theme/theme-loader.d.ts +0 -110
- package/dist/src/theme.d.ts +0 -204
- package/dist/src/utils/escape.d.ts +0 -1
- package/dist/src/utils/index.d.ts +0 -34
- package/dist/src/utils/kv-flavor.d.ts +0 -7
- package/dist/src/utils/logger.d.ts +0 -21
- package/dist/src/utils/md5.d.ts +0 -1
- package/dist/types/cloudflare.d.ts +0 -61
- package/dist/types/shopify.d.ts +0 -1035
- package/dist/types/swell.d.ts +0 -576
- package/types/index.d.ts +0 -4
- package/types/svg.d.ts +0 -4
package/dist/types/shopify.d.ts
DELETED
|
@@ -1,1035 +0,0 @@
|
|
|
1
|
-
import { SHOPIFY_TO_SWELL_SORTING } from '@/compatibility/shopify-configs';
|
|
2
|
-
import type { ShopifySwellContent } from '@/compatibility/shopify-objects/content';
|
|
3
|
-
import type { SwellData, ThemeSectionEnabledDisabled } from './swell';
|
|
4
|
-
import type { ShopifyResource } from '../src/compatibility/shopify-objects/resource';
|
|
5
|
-
import type { ShopifyCompatibility } from '../src/compatibility/shopify';
|
|
6
|
-
import type { StorefrontResource, SwellStorefrontCollection } from '../src/resources';
|
|
7
|
-
export type ShopifySorting = keyof typeof SHOPIFY_TO_SWELL_SORTING;
|
|
8
|
-
export type ShopifyBasicInputType = 'text' | 'textarea' | 'select' | 'checkbox' | 'radio' | 'number' | 'range';
|
|
9
|
-
export type ShopifySpecializedInputType = 'article' | 'blog' | 'collection' | 'collection_list' | 'color' | 'color_background' | 'color_scheme' | 'color_scheme_group' | 'font_picker' | 'header' | 'paragraph' | 'html' | 'image_picker' | 'inline_richtext' | 'link_list' | 'liquid' | 'page' | 'product' | 'product_list' | 'richtext' | 'text_alignment' | 'url' | 'video' | 'video_url';
|
|
10
|
-
export interface ShopifyBgStyleSchema {
|
|
11
|
-
solid: string;
|
|
12
|
-
gradient: string;
|
|
13
|
-
}
|
|
14
|
-
export interface ShopifySettingRoleSchema {
|
|
15
|
-
background: string | ShopifyBgStyleSchema;
|
|
16
|
-
primary_button: string | ShopifyBgStyleSchema;
|
|
17
|
-
secondary_button: string | ShopifyBgStyleSchema;
|
|
18
|
-
text: string;
|
|
19
|
-
on_primary_button: string;
|
|
20
|
-
primary_button_border: string;
|
|
21
|
-
on_secondary_button: string;
|
|
22
|
-
secondary_button_border: string;
|
|
23
|
-
icons: string;
|
|
24
|
-
links: string;
|
|
25
|
-
}
|
|
26
|
-
export interface ShopifyOptionItem {
|
|
27
|
-
label: string | Record<string, string | undefined>;
|
|
28
|
-
value: string;
|
|
29
|
-
}
|
|
30
|
-
export interface ShopifySettingDefinitionSchema {
|
|
31
|
-
type: 'header' | 'color' | 'color_background';
|
|
32
|
-
label: string;
|
|
33
|
-
id?: string;
|
|
34
|
-
info?: string;
|
|
35
|
-
default?: any;
|
|
36
|
-
placeholder?: string;
|
|
37
|
-
}
|
|
38
|
-
export interface ShopifySettingSchema {
|
|
39
|
-
type: ShopifyBasicInputType | ShopifySpecializedInputType;
|
|
40
|
-
label: string | Record<string, string | undefined>;
|
|
41
|
-
id?: string;
|
|
42
|
-
info?: string | Record<string, string | undefined>;
|
|
43
|
-
default?: string | Record<string, string | undefined>;
|
|
44
|
-
placeholder?: string;
|
|
45
|
-
content?: string | Record<string, string | undefined>;
|
|
46
|
-
options?: ShopifyOptionItem[];
|
|
47
|
-
group?: string;
|
|
48
|
-
min?: number;
|
|
49
|
-
max?: number;
|
|
50
|
-
step?: number;
|
|
51
|
-
unit?: string;
|
|
52
|
-
limit?: number;
|
|
53
|
-
definition?: ShopifySettingDefinitionSchema[];
|
|
54
|
-
role?: ShopifySettingRoleSchema;
|
|
55
|
-
accept?: string[];
|
|
56
|
-
}
|
|
57
|
-
export interface ShopifySettingSection {
|
|
58
|
-
name: string;
|
|
59
|
-
settings?: ShopifySettingSchema[];
|
|
60
|
-
}
|
|
61
|
-
export type ShopifySettingsSchema = ShopifySettingSection[];
|
|
62
|
-
export interface ShopifySettingsData {
|
|
63
|
-
current: Record<string, any> | string;
|
|
64
|
-
presets: Record<string, ShopifySettingsDataPreset>;
|
|
65
|
-
platform_customizations: PlatformCustomizations;
|
|
66
|
-
}
|
|
67
|
-
export interface ShopifySettingsDataPreset {
|
|
68
|
-
[key: string]: any;
|
|
69
|
-
sections?: Record<string, ShopifySettingsDataPresetSection>;
|
|
70
|
-
content_for_index?: string[];
|
|
71
|
-
}
|
|
72
|
-
export interface ShopifySettingsDataPresetSection {
|
|
73
|
-
type: string;
|
|
74
|
-
settings: Record<string, any>;
|
|
75
|
-
blocks?: Record<string, Record<string, any>>;
|
|
76
|
-
block_order?: string[];
|
|
77
|
-
}
|
|
78
|
-
export interface ShopifySectionBlockSchema {
|
|
79
|
-
type: string;
|
|
80
|
-
name: string;
|
|
81
|
-
limit?: number;
|
|
82
|
-
settings: ShopifySettingSchema[];
|
|
83
|
-
}
|
|
84
|
-
export interface ShopifySectionPresetSchema {
|
|
85
|
-
name: string;
|
|
86
|
-
settings: ShopifySettingSchema[];
|
|
87
|
-
blocks?: ShopifySectionBlockSchema[];
|
|
88
|
-
}
|
|
89
|
-
export interface ShopifySettingSection {
|
|
90
|
-
name: string;
|
|
91
|
-
settings?: ShopifySettingSchema[];
|
|
92
|
-
}
|
|
93
|
-
export interface ShopifySectionGroupItem {
|
|
94
|
-
type: string;
|
|
95
|
-
settings: Record<string, any>;
|
|
96
|
-
blocks: Record<string, ShopifySectionBlockSchema>;
|
|
97
|
-
}
|
|
98
|
-
export interface ShopifySectionGroup {
|
|
99
|
-
name: string;
|
|
100
|
-
type: string;
|
|
101
|
-
sections: Record<string, ShopifySectionGroupItem>;
|
|
102
|
-
order: string[];
|
|
103
|
-
}
|
|
104
|
-
export interface ShopifySectionSchema {
|
|
105
|
-
type?: string;
|
|
106
|
-
name: string;
|
|
107
|
-
tag?: string;
|
|
108
|
-
class?: string;
|
|
109
|
-
enabled_on?: ThemeSectionEnabledDisabled;
|
|
110
|
-
disabled_on?: ThemeSectionEnabledDisabled;
|
|
111
|
-
limit?: number;
|
|
112
|
-
settings: ShopifySettingSchema[];
|
|
113
|
-
blocks?: ShopifySectionBlockSchema[];
|
|
114
|
-
presets?: ShopifySectionPresetSchema[];
|
|
115
|
-
default?: ShopifySectionPresetSchema;
|
|
116
|
-
}
|
|
117
|
-
export interface PlatformCustomizations {
|
|
118
|
-
custom_css?: string[];
|
|
119
|
-
}
|
|
120
|
-
export interface ShopifyPageResource {
|
|
121
|
-
from: string;
|
|
122
|
-
to: string;
|
|
123
|
-
object(shopify: ShopifyCompatibility, value: StorefrontResource): ShopifyResource<object>;
|
|
124
|
-
}
|
|
125
|
-
export interface ShopifyPage {
|
|
126
|
-
page: string;
|
|
127
|
-
resources: ShopifyPageResource[];
|
|
128
|
-
}
|
|
129
|
-
export type ShopifyPageResourceMap = Map<string, ShopifyPage>;
|
|
130
|
-
interface ShopifyObject {
|
|
131
|
-
from: string;
|
|
132
|
-
object(shopify: ShopifyCompatibility, value: SwellData): ShopifyResource<object>;
|
|
133
|
-
}
|
|
134
|
-
export type ShopifyObjectResourceMap = Map<string, ShopifyObject>;
|
|
135
|
-
export interface ShopifyForm {
|
|
136
|
-
type: string;
|
|
137
|
-
shopifyType?: string;
|
|
138
|
-
clientParams?(scope: SwellData, arg?: unknown): SwellData | undefined;
|
|
139
|
-
clientHtml?(scope: SwellData, arg?: unknown): string | undefined;
|
|
140
|
-
serverParams?(context: SwellData): SwellData;
|
|
141
|
-
serverResponse?(context: SwellData): SwellData;
|
|
142
|
-
}
|
|
143
|
-
export type ShopifyFormResourceMap = ShopifyForm[];
|
|
144
|
-
export interface ShopifyQueryParams {
|
|
145
|
-
from: string | ((param: string) => boolean);
|
|
146
|
-
to: string | ((param: string, value: string) => SwellData);
|
|
147
|
-
}
|
|
148
|
-
export type ShopifyQueryParamsMap = ShopifyQueryParams[];
|
|
149
|
-
export interface ShopifyLocale {
|
|
150
|
-
endonym_name: string;
|
|
151
|
-
iso_code: string;
|
|
152
|
-
name: string;
|
|
153
|
-
primary: boolean;
|
|
154
|
-
root_url: string;
|
|
155
|
-
}
|
|
156
|
-
export interface ShopifyCurrency {
|
|
157
|
-
iso_code: string;
|
|
158
|
-
name: string;
|
|
159
|
-
symbol: string;
|
|
160
|
-
}
|
|
161
|
-
export interface ShopifyMarket {
|
|
162
|
-
handle: string;
|
|
163
|
-
id: number;
|
|
164
|
-
metafields: Record<string, unknown>;
|
|
165
|
-
}
|
|
166
|
-
export interface ShopifyCountry {
|
|
167
|
-
available_languages: ShopifyLocale[];
|
|
168
|
-
continent: 'Africa' | 'Asia' | 'Central America' | 'Europe' | 'North America' | 'Oceania' | 'South America';
|
|
169
|
-
currency: ShopifyCurrency;
|
|
170
|
-
iso_code: string;
|
|
171
|
-
market: ShopifyMarket;
|
|
172
|
-
name: string;
|
|
173
|
-
'popular?': boolean;
|
|
174
|
-
unit_system: 'imperial' | 'metric';
|
|
175
|
-
}
|
|
176
|
-
export interface ShopifyLocalization {
|
|
177
|
-
available_countries: ShopifyCountry[];
|
|
178
|
-
available_languages: ShopifyLocale[];
|
|
179
|
-
country: ShopifyCountry;
|
|
180
|
-
language: ShopifyLocale;
|
|
181
|
-
market: ShopifyMarket;
|
|
182
|
-
}
|
|
183
|
-
export interface ShopifyFocalPoint {
|
|
184
|
-
x: number;
|
|
185
|
-
y: number;
|
|
186
|
-
}
|
|
187
|
-
export interface ShopifyImagePresentation {
|
|
188
|
-
focal_point: ShopifyFocalPoint;
|
|
189
|
-
}
|
|
190
|
-
export interface ShopifyImageSrc {
|
|
191
|
-
url: string;
|
|
192
|
-
width: number;
|
|
193
|
-
height: number;
|
|
194
|
-
}
|
|
195
|
-
export interface ShopifyImage {
|
|
196
|
-
id: number;
|
|
197
|
-
alt: string;
|
|
198
|
-
src: ShopifyImageSrc;
|
|
199
|
-
media_type?: 'image';
|
|
200
|
-
preview_image?: ShopifyImage;
|
|
201
|
-
presentation?: ShopifyImagePresentation;
|
|
202
|
-
aspect_ratio: number;
|
|
203
|
-
'attached_to_variant?'?: boolean;
|
|
204
|
-
width: number;
|
|
205
|
-
height: number;
|
|
206
|
-
position?: number;
|
|
207
|
-
product_id?: number;
|
|
208
|
-
variants?: ShopifyVariant[];
|
|
209
|
-
}
|
|
210
|
-
export interface ShopifyMedia {
|
|
211
|
-
alt: string;
|
|
212
|
-
id: number;
|
|
213
|
-
media_type: 'image' | 'model' | 'video' | 'external_video';
|
|
214
|
-
position?: number;
|
|
215
|
-
preview_image: ShopifyImage;
|
|
216
|
-
}
|
|
217
|
-
export interface ShopifyAddress {
|
|
218
|
-
id: number;
|
|
219
|
-
address1: string;
|
|
220
|
-
address2?: string;
|
|
221
|
-
city: string;
|
|
222
|
-
company?: string;
|
|
223
|
-
country: ShopifyCountry;
|
|
224
|
-
country_code: string;
|
|
225
|
-
first_name?: string;
|
|
226
|
-
last_name?: string;
|
|
227
|
-
name: string;
|
|
228
|
-
phone: string;
|
|
229
|
-
province: string;
|
|
230
|
-
province_code: string;
|
|
231
|
-
street: string;
|
|
232
|
-
summary: string;
|
|
233
|
-
url: string;
|
|
234
|
-
zip: string;
|
|
235
|
-
}
|
|
236
|
-
export interface ShopifyLocation {
|
|
237
|
-
address: ShopifyAddress;
|
|
238
|
-
id: number;
|
|
239
|
-
latitude: number;
|
|
240
|
-
longitude: number;
|
|
241
|
-
metafields: Record<string, unknown>;
|
|
242
|
-
name: string;
|
|
243
|
-
}
|
|
244
|
-
export interface ShopifyBrand {
|
|
245
|
-
colors: object;
|
|
246
|
-
cover_image: ShopifyImage;
|
|
247
|
-
favicon_url: ShopifyImage;
|
|
248
|
-
logo: ShopifyImage;
|
|
249
|
-
metafields: Record<string, unknown>;
|
|
250
|
-
short_description: string;
|
|
251
|
-
slogan: string;
|
|
252
|
-
square_logo: ShopifyImage;
|
|
253
|
-
}
|
|
254
|
-
export interface ShopifyShop {
|
|
255
|
-
accepts_gift_cards: boolean;
|
|
256
|
-
address: ShopifyAddress;
|
|
257
|
-
brand: ShopifyBrand;
|
|
258
|
-
collections_count: number;
|
|
259
|
-
currency: string;
|
|
260
|
-
customer_accounts_enabled: boolean;
|
|
261
|
-
customer_accounts_optional: boolean;
|
|
262
|
-
description: string;
|
|
263
|
-
domain: string;
|
|
264
|
-
email: string;
|
|
265
|
-
enabled_currencies: ShopifyCurrency[];
|
|
266
|
-
/** @deprecated */
|
|
267
|
-
enabled_locales: ShopifyLocale[];
|
|
268
|
-
enabled_payment_types: string[];
|
|
269
|
-
id: number;
|
|
270
|
-
/** @deprecated */
|
|
271
|
-
locale: string;
|
|
272
|
-
metafields: Record<string, unknown>;
|
|
273
|
-
/** @deprecated */
|
|
274
|
-
metaobjects: Record<string, unknown>;
|
|
275
|
-
money_format: string;
|
|
276
|
-
money_with_currency_format: string;
|
|
277
|
-
name: string;
|
|
278
|
-
password_message: string;
|
|
279
|
-
permanent_domain: string;
|
|
280
|
-
phone: string;
|
|
281
|
-
policies: object[];
|
|
282
|
-
privacy_policy?: object;
|
|
283
|
-
products_count: number;
|
|
284
|
-
published_locales: ShopifyLocale[];
|
|
285
|
-
refund_policy?: object;
|
|
286
|
-
secure_url: string;
|
|
287
|
-
shipping_policy?: object;
|
|
288
|
-
subscription_policy?: object;
|
|
289
|
-
/** @deprecated */
|
|
290
|
-
taxes_included: boolean;
|
|
291
|
-
terms_of_service?: object;
|
|
292
|
-
types: string[];
|
|
293
|
-
url: string;
|
|
294
|
-
vendors: string[];
|
|
295
|
-
}
|
|
296
|
-
export interface ShopifyColor {
|
|
297
|
-
alpha: number;
|
|
298
|
-
blue: number;
|
|
299
|
-
chroma: number;
|
|
300
|
-
color_space: string;
|
|
301
|
-
green: number;
|
|
302
|
-
hue: number;
|
|
303
|
-
lightness: number;
|
|
304
|
-
oklch: string;
|
|
305
|
-
oklcha: string;
|
|
306
|
-
red: number;
|
|
307
|
-
rgb: string;
|
|
308
|
-
rgba: string;
|
|
309
|
-
saturation: number;
|
|
310
|
-
}
|
|
311
|
-
export interface ShopifyLink {
|
|
312
|
-
active: boolean;
|
|
313
|
-
child_active: boolean;
|
|
314
|
-
child_current: boolean;
|
|
315
|
-
current: boolean;
|
|
316
|
-
handle: string;
|
|
317
|
-
levels: number;
|
|
318
|
-
links: ShopifyLink[];
|
|
319
|
-
object?: object;
|
|
320
|
-
title: string;
|
|
321
|
-
type: 'article_link' | 'blog_link' | 'catalog_link' | 'collection_link' | 'collections_link' | 'customer_account_page_link' | 'frontpage_link' | 'http_link' | 'metaobject_link' | 'page_link' | 'policy_link' | 'product_link' | 'search_link';
|
|
322
|
-
url: string;
|
|
323
|
-
}
|
|
324
|
-
export interface ShopifySwatch {
|
|
325
|
-
color: ShopifyColor;
|
|
326
|
-
image: ShopifyImage;
|
|
327
|
-
}
|
|
328
|
-
export interface ShopifySellingPlanCheckoutCharge {
|
|
329
|
-
value: number;
|
|
330
|
-
value_type: 'percentage' | 'price';
|
|
331
|
-
}
|
|
332
|
-
export interface ShopifySellingPlanOption {
|
|
333
|
-
name: string;
|
|
334
|
-
position: number;
|
|
335
|
-
value: string;
|
|
336
|
-
}
|
|
337
|
-
export interface ShopifySellingPlanPriceAdjustment {
|
|
338
|
-
order_count: number;
|
|
339
|
-
position: number;
|
|
340
|
-
value: number;
|
|
341
|
-
value_type: 'percentage' | 'fixed_amount' | 'price';
|
|
342
|
-
}
|
|
343
|
-
export interface ShopifySellingPlan {
|
|
344
|
-
checkout_charge: ShopifySellingPlanCheckoutCharge;
|
|
345
|
-
description: string;
|
|
346
|
-
group_id: string;
|
|
347
|
-
id: number;
|
|
348
|
-
name: string;
|
|
349
|
-
options: ShopifySellingPlanOption[];
|
|
350
|
-
price_adjustments: ShopifySellingPlanPriceAdjustment[];
|
|
351
|
-
recurring_deliveries: boolean;
|
|
352
|
-
selected: boolean;
|
|
353
|
-
}
|
|
354
|
-
export interface ShopifySellingPlanAllocationPriceAdjustment {
|
|
355
|
-
position?: number;
|
|
356
|
-
price: number;
|
|
357
|
-
}
|
|
358
|
-
export interface ShopifySellingPlanAllocation {
|
|
359
|
-
checkout_charge_amount: number;
|
|
360
|
-
compare_at_price: number;
|
|
361
|
-
per_delivery_price: number;
|
|
362
|
-
price: number;
|
|
363
|
-
price_adjustments: ShopifySellingPlanAllocationPriceAdjustment[];
|
|
364
|
-
remaining_balance_charge_amount: number;
|
|
365
|
-
selling_plan: ShopifySellingPlan;
|
|
366
|
-
selling_plan_group_id: string;
|
|
367
|
-
unit_price?: number;
|
|
368
|
-
}
|
|
369
|
-
export interface ShopifySellingPlanGroupOption {
|
|
370
|
-
name: string;
|
|
371
|
-
position: number;
|
|
372
|
-
selected_value: string;
|
|
373
|
-
values: string[];
|
|
374
|
-
}
|
|
375
|
-
export interface ShopifySellingPlanGroup {
|
|
376
|
-
app_id?: string;
|
|
377
|
-
id: number;
|
|
378
|
-
name: string;
|
|
379
|
-
options: ShopifySellingPlanGroupOption[];
|
|
380
|
-
selling_plan_selected: boolean;
|
|
381
|
-
selling_plans: ShopifySellingPlan[];
|
|
382
|
-
}
|
|
383
|
-
export interface ShopifyProductOption {
|
|
384
|
-
name: string;
|
|
385
|
-
position: number;
|
|
386
|
-
selected_value?: string;
|
|
387
|
-
values?: ShopifyProductOptionValue[];
|
|
388
|
-
}
|
|
389
|
-
export interface ShopifyProduct {
|
|
390
|
-
available: boolean;
|
|
391
|
-
category: unknown;
|
|
392
|
-
collections: ShopifyCollection[];
|
|
393
|
-
compare_at_price: number;
|
|
394
|
-
compare_at_price_max: number;
|
|
395
|
-
compare_at_price_min: number;
|
|
396
|
-
compare_at_price_varies: boolean;
|
|
397
|
-
content: ShopifySwellContent;
|
|
398
|
-
created_at: string;
|
|
399
|
-
description: string;
|
|
400
|
-
featured_image?: ShopifyImage;
|
|
401
|
-
featured_media?: ShopifyMedia;
|
|
402
|
-
first_available_variant?: ShopifyVariant;
|
|
403
|
-
'gift_card?': boolean;
|
|
404
|
-
handle: string;
|
|
405
|
-
has_only_default_variant: boolean;
|
|
406
|
-
id: number;
|
|
407
|
-
images: ShopifyImage[];
|
|
408
|
-
media: ShopifyMedia[];
|
|
409
|
-
metafields: Record<string, unknown>;
|
|
410
|
-
options: string[];
|
|
411
|
-
options_by_name: Record<string, ShopifyProductOption | undefined>;
|
|
412
|
-
options_with_values: ShopifyProductOption[];
|
|
413
|
-
price: number;
|
|
414
|
-
price_max: number;
|
|
415
|
-
price_min: number;
|
|
416
|
-
price_varies: boolean;
|
|
417
|
-
published_at: string;
|
|
418
|
-
'quantity_price_breaks_configured?': boolean;
|
|
419
|
-
requires_selling_plan: boolean;
|
|
420
|
-
selected_or_first_available_selling_plan_allocation?: ShopifySellingPlanAllocation;
|
|
421
|
-
selected_or_first_available_variant?: ShopifyVariant;
|
|
422
|
-
selected_selling_plan?: ShopifySellingPlan;
|
|
423
|
-
selected_selling_plan_allocation?: ShopifySellingPlanAllocation;
|
|
424
|
-
selected_variant?: ShopifyVariant;
|
|
425
|
-
selling_plan_groups: ShopifySellingPlanGroup[];
|
|
426
|
-
tags: string[];
|
|
427
|
-
template_suffix?: string;
|
|
428
|
-
title: string;
|
|
429
|
-
type: string;
|
|
430
|
-
url: string;
|
|
431
|
-
variants: ShopifyVariant[];
|
|
432
|
-
variants_count: number;
|
|
433
|
-
vendor?: string;
|
|
434
|
-
}
|
|
435
|
-
export interface ShopifyCollection {
|
|
436
|
-
all_products_count: number;
|
|
437
|
-
all_tags: string[];
|
|
438
|
-
all_types: string[];
|
|
439
|
-
all_vendors: string[];
|
|
440
|
-
current_type?: string;
|
|
441
|
-
current_vendor?: string;
|
|
442
|
-
default_sort_by: ShopifySorting;
|
|
443
|
-
description: string;
|
|
444
|
-
featured_image?: ShopifyImage;
|
|
445
|
-
filters: ShopifyFilter[];
|
|
446
|
-
handle: string;
|
|
447
|
-
id: number;
|
|
448
|
-
image?: ShopifyImage;
|
|
449
|
-
metafields: Record<string, unknown>;
|
|
450
|
-
next_product?: ShopifyProduct;
|
|
451
|
-
previous_product?: ShopifyProduct;
|
|
452
|
-
products: SwellStorefrontCollection<ShopifyResource<ShopifyProduct>>;
|
|
453
|
-
products_count: number;
|
|
454
|
-
published_at: string;
|
|
455
|
-
sort_by?: string;
|
|
456
|
-
sort_options: ShopifySortOption[];
|
|
457
|
-
tags: string[];
|
|
458
|
-
template_suffix?: string;
|
|
459
|
-
title: string;
|
|
460
|
-
url: string;
|
|
461
|
-
}
|
|
462
|
-
export interface ShopifyFilterValueDisplayColors {
|
|
463
|
-
type: 'colors';
|
|
464
|
-
value: ShopifyColor[];
|
|
465
|
-
}
|
|
466
|
-
export interface ShopifyFilterValueDisplayImage {
|
|
467
|
-
type: 'image';
|
|
468
|
-
value: ShopifyImage;
|
|
469
|
-
}
|
|
470
|
-
export type ShopifyFilterValueDisplay = ShopifyFilterValueDisplayColors | ShopifyFilterValueDisplayImage;
|
|
471
|
-
export interface ShopifyFilterValue {
|
|
472
|
-
active: boolean;
|
|
473
|
-
count: number;
|
|
474
|
-
display?: ShopifyFilterValueDisplay;
|
|
475
|
-
image?: ShopifyImage;
|
|
476
|
-
label: string;
|
|
477
|
-
param_name: string;
|
|
478
|
-
swatch?: ShopifySwatch;
|
|
479
|
-
url_to_add: string;
|
|
480
|
-
url_to_remove: string;
|
|
481
|
-
value: string;
|
|
482
|
-
}
|
|
483
|
-
export interface ShopifyFilter {
|
|
484
|
-
active_values?: ShopifyFilterValue[];
|
|
485
|
-
false_value?: ShopifyFilterValue;
|
|
486
|
-
inactive_values?: ShopifyFilterValue[];
|
|
487
|
-
label: string;
|
|
488
|
-
max_value?: ShopifyFilterValue;
|
|
489
|
-
min_value?: ShopifyFilterValue;
|
|
490
|
-
operator?: 'AND' | 'OR';
|
|
491
|
-
param_name: string;
|
|
492
|
-
presentation?: 'image' | 'swatch' | 'text';
|
|
493
|
-
range_max?: number;
|
|
494
|
-
true_value?: ShopifyFilterValue;
|
|
495
|
-
type: 'boolean' | 'list' | 'price_range';
|
|
496
|
-
url_to_remove: string;
|
|
497
|
-
values?: ShopifyFilterValue[];
|
|
498
|
-
}
|
|
499
|
-
export interface ShopifySortOption {
|
|
500
|
-
name: string;
|
|
501
|
-
value: string;
|
|
502
|
-
}
|
|
503
|
-
export interface ShopifyProductOptionValue {
|
|
504
|
-
available: boolean;
|
|
505
|
-
id: number;
|
|
506
|
-
name: string;
|
|
507
|
-
product_url?: string;
|
|
508
|
-
selected: boolean;
|
|
509
|
-
swatch?: ShopifySwatch;
|
|
510
|
-
variant?: ShopifyVariant;
|
|
511
|
-
}
|
|
512
|
-
export interface ShopifyQuantityPriceBreak {
|
|
513
|
-
minimum_quantity: number;
|
|
514
|
-
price: number;
|
|
515
|
-
}
|
|
516
|
-
export interface ShopifyQuantityRule {
|
|
517
|
-
increment: number;
|
|
518
|
-
max: number | null;
|
|
519
|
-
min: number;
|
|
520
|
-
}
|
|
521
|
-
export interface ShopifyStoreAvailability {
|
|
522
|
-
available: boolean;
|
|
523
|
-
location: ShopifyLocation;
|
|
524
|
-
pick_up_enabled: boolean;
|
|
525
|
-
pick_up_time: string;
|
|
526
|
-
}
|
|
527
|
-
export interface ShopifyUnitPriceMeasurement {
|
|
528
|
-
measured_type: 'volume' | 'weight' | 'dimension';
|
|
529
|
-
quantity_unit: string;
|
|
530
|
-
quantity_value: number;
|
|
531
|
-
reference_unit: string;
|
|
532
|
-
reference_value: number;
|
|
533
|
-
}
|
|
534
|
-
export interface ShopifyVariant {
|
|
535
|
-
available: boolean;
|
|
536
|
-
barcode?: string;
|
|
537
|
-
compare_at_price?: number;
|
|
538
|
-
featured_image?: ShopifyImage;
|
|
539
|
-
featured_media?: ShopifyMedia;
|
|
540
|
-
id: number;
|
|
541
|
-
image?: ShopifyImage;
|
|
542
|
-
incoming: boolean;
|
|
543
|
-
inventory_management?: string;
|
|
544
|
-
inventory_policy: 'continue' | 'deny';
|
|
545
|
-
inventory_quantity: number;
|
|
546
|
-
matched: boolean;
|
|
547
|
-
metafields: Record<string, unknown>;
|
|
548
|
-
next_incoming_date?: string;
|
|
549
|
-
/** @deprecated */
|
|
550
|
-
option1?: string;
|
|
551
|
-
/** @deprecated */
|
|
552
|
-
option2?: string;
|
|
553
|
-
/** @deprecated */
|
|
554
|
-
option3?: string;
|
|
555
|
-
options: ShopifyProductOptionValue[];
|
|
556
|
-
price: number;
|
|
557
|
-
product: ShopifyProduct;
|
|
558
|
-
quantity_price_breaks: ShopifyQuantityPriceBreak[];
|
|
559
|
-
'quantity_price_breaks_configured?': boolean;
|
|
560
|
-
quantity_rule: ShopifyQuantityRule;
|
|
561
|
-
requires_selling_plan: boolean;
|
|
562
|
-
requires_shipping: boolean;
|
|
563
|
-
selected: boolean;
|
|
564
|
-
selected_selling_plan_allocation?: ShopifySellingPlanAllocation;
|
|
565
|
-
selling_plan_allocations: ShopifySellingPlanAllocation[];
|
|
566
|
-
sku: string;
|
|
567
|
-
store_availabilities: ShopifyStoreAvailability[];
|
|
568
|
-
taxable: boolean;
|
|
569
|
-
title: string;
|
|
570
|
-
unit_price: number;
|
|
571
|
-
unit_price_measurement?: ShopifyUnitPriceMeasurement;
|
|
572
|
-
url: string;
|
|
573
|
-
weight: number;
|
|
574
|
-
weight_in_unit: number;
|
|
575
|
-
weight_unit?: string;
|
|
576
|
-
}
|
|
577
|
-
export interface ShopifyUser {
|
|
578
|
-
account_owner: boolean;
|
|
579
|
-
bio?: string;
|
|
580
|
-
email: string;
|
|
581
|
-
first_name: string;
|
|
582
|
-
homepage?: string;
|
|
583
|
-
image?: ShopifyImage;
|
|
584
|
-
last_name: string;
|
|
585
|
-
name: string;
|
|
586
|
-
}
|
|
587
|
-
export interface ShopifyComment {
|
|
588
|
-
author: string;
|
|
589
|
-
content: string;
|
|
590
|
-
created_at: string;
|
|
591
|
-
email: string;
|
|
592
|
-
id: number;
|
|
593
|
-
status: string;
|
|
594
|
-
updated_at: string;
|
|
595
|
-
url: string;
|
|
596
|
-
}
|
|
597
|
-
export interface ShopifyArticle {
|
|
598
|
-
author: string;
|
|
599
|
-
comment_post_url: string;
|
|
600
|
-
comments: ShopifyComment[];
|
|
601
|
-
comments_count: number;
|
|
602
|
-
'comments_enabled?': boolean;
|
|
603
|
-
content: string;
|
|
604
|
-
created_at: string;
|
|
605
|
-
excerpt: string;
|
|
606
|
-
excerpt_or_content: string;
|
|
607
|
-
handle: string;
|
|
608
|
-
id: string;
|
|
609
|
-
image?: ShopifyImage;
|
|
610
|
-
metafields: Record<string, unknown>;
|
|
611
|
-
'moderated?': boolean;
|
|
612
|
-
published_at: string;
|
|
613
|
-
tags: string[];
|
|
614
|
-
template_suffix?: string;
|
|
615
|
-
title: string;
|
|
616
|
-
updated_at: string;
|
|
617
|
-
url: string;
|
|
618
|
-
user: ShopifyUser;
|
|
619
|
-
}
|
|
620
|
-
export interface ShopifyBlog {
|
|
621
|
-
all_tags: string[];
|
|
622
|
-
articles: SwellStorefrontCollection<ShopifyResource<ShopifyArticle>>;
|
|
623
|
-
articles_count: number;
|
|
624
|
-
'comments_enabled?': boolean;
|
|
625
|
-
handle: string;
|
|
626
|
-
id: number;
|
|
627
|
-
metafields: Record<string, unknown>;
|
|
628
|
-
'moderated?': boolean;
|
|
629
|
-
next_article?: ShopifyArticle;
|
|
630
|
-
previous_article?: ShopifyArticle;
|
|
631
|
-
tags: string[];
|
|
632
|
-
template_suffix?: string;
|
|
633
|
-
title: string;
|
|
634
|
-
url: string;
|
|
635
|
-
}
|
|
636
|
-
export interface ShopifyOptionWithValue {
|
|
637
|
-
name: string;
|
|
638
|
-
value: string;
|
|
639
|
-
}
|
|
640
|
-
/** @deprecated */
|
|
641
|
-
export interface ShopifyDiscount {
|
|
642
|
-
amount: number;
|
|
643
|
-
code: string;
|
|
644
|
-
savings: number;
|
|
645
|
-
title: string;
|
|
646
|
-
total_amount: number;
|
|
647
|
-
total_savings: number;
|
|
648
|
-
type: 'FixedAmountDiscount' | 'PercentageDiscount' | 'ShippingDiscount';
|
|
649
|
-
}
|
|
650
|
-
export interface ShopifyDiscountApplication {
|
|
651
|
-
target_selection: 'all' | 'entitled' | 'explicit';
|
|
652
|
-
target_type: 'line_item' | 'shipping_line';
|
|
653
|
-
title: string;
|
|
654
|
-
total_allocated_amount: number;
|
|
655
|
-
type: 'automatic' | 'discount_code' | 'manual' | 'script';
|
|
656
|
-
value: number;
|
|
657
|
-
value_type: 'fixed_amount' | 'percentage';
|
|
658
|
-
}
|
|
659
|
-
export interface ShopifyDiscountAllocation {
|
|
660
|
-
amount: number;
|
|
661
|
-
discount_application: ShopifyDiscountApplication;
|
|
662
|
-
}
|
|
663
|
-
export interface ShopifyFulfillment {
|
|
664
|
-
created_at: string;
|
|
665
|
-
fulfillment_line_items: ShopifyLineItem[];
|
|
666
|
-
item_count: number;
|
|
667
|
-
tracking_company: string;
|
|
668
|
-
tracking_number: string;
|
|
669
|
-
tracking_numbers: string[];
|
|
670
|
-
tracking_url: string;
|
|
671
|
-
}
|
|
672
|
-
export interface ShopifyTaxLine {
|
|
673
|
-
price: number;
|
|
674
|
-
rate: number;
|
|
675
|
-
rate_percentage: number;
|
|
676
|
-
title: string;
|
|
677
|
-
}
|
|
678
|
-
export interface ShopifyLineItem {
|
|
679
|
-
/** @deprecated */
|
|
680
|
-
discounts: ShopifyDiscount[];
|
|
681
|
-
discount_allocations: ShopifyDiscountAllocation[];
|
|
682
|
-
error_message?: string;
|
|
683
|
-
final_line_price: number;
|
|
684
|
-
final_price: number;
|
|
685
|
-
fulfillment?: ShopifyFulfillment;
|
|
686
|
-
fulfillment_service: string;
|
|
687
|
-
gift_card: boolean;
|
|
688
|
-
grams: number;
|
|
689
|
-
id: number;
|
|
690
|
-
image?: ShopifyImage;
|
|
691
|
-
item_components: ShopifyLineItem[];
|
|
692
|
-
key: string;
|
|
693
|
-
line_level_discount_allocations: ShopifyDiscountAllocation[];
|
|
694
|
-
line_level_total_discount: number;
|
|
695
|
-
/** @deprecated */
|
|
696
|
-
line_price: number;
|
|
697
|
-
message?: string;
|
|
698
|
-
options_with_values: ShopifyOptionWithValue[];
|
|
699
|
-
original_line_price: number;
|
|
700
|
-
original_price: number;
|
|
701
|
-
/** @deprecated */
|
|
702
|
-
price: number;
|
|
703
|
-
product: ShopifyProduct;
|
|
704
|
-
product_id: number;
|
|
705
|
-
properties: Record<string, unknown>;
|
|
706
|
-
quantity: number;
|
|
707
|
-
requires_shipping: boolean;
|
|
708
|
-
selling_plan_allocation?: ShopifySellingPlanAllocation;
|
|
709
|
-
sku: string;
|
|
710
|
-
successfully_fulfilled_quantity: number;
|
|
711
|
-
tax_lines: ShopifyTaxLine[];
|
|
712
|
-
taxable: boolean;
|
|
713
|
-
title: string;
|
|
714
|
-
/** @deprecated */
|
|
715
|
-
total_discount: number;
|
|
716
|
-
unit_price?: number;
|
|
717
|
-
unit_price_measurement?: ShopifyUnitPriceMeasurement;
|
|
718
|
-
url: string;
|
|
719
|
-
url_to_remove: string;
|
|
720
|
-
variant?: ShopifyVariant;
|
|
721
|
-
variant_id?: number;
|
|
722
|
-
vendor?: string;
|
|
723
|
-
}
|
|
724
|
-
export interface ShopifyCart {
|
|
725
|
-
attributes: Record<string, unknown>;
|
|
726
|
-
cart_level_discount_applications: ShopifyDiscountApplication[];
|
|
727
|
-
checkout_charge_amount: number;
|
|
728
|
-
currency: ShopifyCurrency;
|
|
729
|
-
/** @deprecated */
|
|
730
|
-
discounts: ShopifyDiscount[];
|
|
731
|
-
discount_applications: ShopifyDiscountApplication[];
|
|
732
|
-
duties_included: boolean;
|
|
733
|
-
'empty?': boolean;
|
|
734
|
-
item_count: number;
|
|
735
|
-
items: ShopifyLineItem[];
|
|
736
|
-
items_subtotal_price: number;
|
|
737
|
-
note: string;
|
|
738
|
-
original_total_price: number;
|
|
739
|
-
requires_shipping: boolean;
|
|
740
|
-
taxes_included: boolean;
|
|
741
|
-
total_discount: number;
|
|
742
|
-
total_price: number;
|
|
743
|
-
total_weight: number;
|
|
744
|
-
}
|
|
745
|
-
export interface ShopifyCompanyAddress {
|
|
746
|
-
address1: string;
|
|
747
|
-
address2: string;
|
|
748
|
-
attention?: string;
|
|
749
|
-
city: string;
|
|
750
|
-
country: ShopifyCountry;
|
|
751
|
-
country_code: string;
|
|
752
|
-
first_name: string;
|
|
753
|
-
id: number;
|
|
754
|
-
last_name: string;
|
|
755
|
-
province?: string;
|
|
756
|
-
province_code?: string;
|
|
757
|
-
street: string;
|
|
758
|
-
zip: string;
|
|
759
|
-
}
|
|
760
|
-
export interface ShopifyCompanyLocation {
|
|
761
|
-
company: ShopifyCompany;
|
|
762
|
-
'current?': boolean;
|
|
763
|
-
external_id?: string;
|
|
764
|
-
id: number;
|
|
765
|
-
metafields: Record<string, unknown>;
|
|
766
|
-
name: string;
|
|
767
|
-
shipping_address: ShopifyCompanyAddress;
|
|
768
|
-
tax_registration_id?: number;
|
|
769
|
-
url_to_set_as_current: string;
|
|
770
|
-
}
|
|
771
|
-
export interface ShopifyCompany {
|
|
772
|
-
available_locations: ShopifyCompanyLocation[];
|
|
773
|
-
available_locations_count: number;
|
|
774
|
-
external_id?: string;
|
|
775
|
-
id: number;
|
|
776
|
-
metafields: Record<string, unknown>;
|
|
777
|
-
name: string;
|
|
778
|
-
}
|
|
779
|
-
export interface ShopifyMoney {
|
|
780
|
-
value: number;
|
|
781
|
-
decimals: number;
|
|
782
|
-
currency: ShopifyCurrency;
|
|
783
|
-
}
|
|
784
|
-
export interface ShopifyStoreCreditAccount {
|
|
785
|
-
balance: ShopifyMoney;
|
|
786
|
-
}
|
|
787
|
-
export interface ShopifyCustomerPaymentMethod {
|
|
788
|
-
payment_instrument_type: string;
|
|
789
|
-
token: string;
|
|
790
|
-
}
|
|
791
|
-
export interface ShopifyCustomer {
|
|
792
|
-
accepts_marketing: boolean;
|
|
793
|
-
addresses: ShopifyAddress[];
|
|
794
|
-
addresses_count: number;
|
|
795
|
-
'b2b?': boolean;
|
|
796
|
-
company_available_locations: ShopifyCompanyLocation[];
|
|
797
|
-
company_available_locations_count: number;
|
|
798
|
-
current_company?: ShopifyCompany;
|
|
799
|
-
current_location?: ShopifyCompanyLocation;
|
|
800
|
-
default_address?: ShopifyAddress;
|
|
801
|
-
email: string;
|
|
802
|
-
first_name: string;
|
|
803
|
-
has_account: boolean;
|
|
804
|
-
'has_avatar?': boolean;
|
|
805
|
-
id: number;
|
|
806
|
-
last_name: number;
|
|
807
|
-
last_order?: ShopifyOrder;
|
|
808
|
-
name: string;
|
|
809
|
-
orders: ShopifyOrder[];
|
|
810
|
-
orders_count: number;
|
|
811
|
-
payment_methods: ShopifyCustomerPaymentMethod[];
|
|
812
|
-
phone: string;
|
|
813
|
-
store_credit_account: ShopifyStoreCreditAccount;
|
|
814
|
-
tags: string[];
|
|
815
|
-
tax_exempt: boolean;
|
|
816
|
-
total_spent: number;
|
|
817
|
-
}
|
|
818
|
-
export interface ShopifyRecipient {
|
|
819
|
-
email: string;
|
|
820
|
-
name: string;
|
|
821
|
-
nickname: string;
|
|
822
|
-
}
|
|
823
|
-
export interface ShopifyGiftCard {
|
|
824
|
-
balance: number;
|
|
825
|
-
code: string;
|
|
826
|
-
currency: string;
|
|
827
|
-
customer: ShopifyCustomer;
|
|
828
|
-
enabled: boolean;
|
|
829
|
-
expired: boolean;
|
|
830
|
-
expires_on: string;
|
|
831
|
-
initial_value: number;
|
|
832
|
-
last_four_characters: string;
|
|
833
|
-
message?: string;
|
|
834
|
-
pass_url: string;
|
|
835
|
-
product: ShopifyProduct;
|
|
836
|
-
properties: Record<string, unknown>;
|
|
837
|
-
qr_identifier: string;
|
|
838
|
-
recipient?: ShopifyRecipient;
|
|
839
|
-
send_on?: string;
|
|
840
|
-
template_suffix?: string;
|
|
841
|
-
url: string;
|
|
842
|
-
}
|
|
843
|
-
export interface ShopifyPendingPaymentInstructionInput {
|
|
844
|
-
header: string;
|
|
845
|
-
value: string;
|
|
846
|
-
}
|
|
847
|
-
export interface ShopifyTransactionPaymentDetails {
|
|
848
|
-
credit_card_company: string;
|
|
849
|
-
credit_card_last_four_digits: string;
|
|
850
|
-
credit_card_number: string;
|
|
851
|
-
gift_card?: ShopifyGiftCard;
|
|
852
|
-
}
|
|
853
|
-
export interface ShopifyTransaction {
|
|
854
|
-
amount: number;
|
|
855
|
-
buyer_pending_payment_instructions: ShopifyPendingPaymentInstructionInput[];
|
|
856
|
-
buyer_pending_payment_notice: string;
|
|
857
|
-
created_at: string;
|
|
858
|
-
gateway: string;
|
|
859
|
-
gateway_display_name: string;
|
|
860
|
-
id: number;
|
|
861
|
-
kind: 'authorization' | 'capture' | 'sale' | 'void' | 'refund';
|
|
862
|
-
name: string;
|
|
863
|
-
payment_details: ShopifyTransactionPaymentDetails;
|
|
864
|
-
receipt: string;
|
|
865
|
-
'show_buyer_pending_payment_instructions?': boolean;
|
|
866
|
-
status: 'success' | 'pending' | 'failure' | 'error';
|
|
867
|
-
status_label: string;
|
|
868
|
-
}
|
|
869
|
-
export interface ShopifyShippingMethod {
|
|
870
|
-
discount_allocations: ShopifyDiscountAllocation[];
|
|
871
|
-
handle: string;
|
|
872
|
-
id: string;
|
|
873
|
-
original_price: number;
|
|
874
|
-
/** @deprecated */
|
|
875
|
-
price: number;
|
|
876
|
-
price_with_discounts: number;
|
|
877
|
-
tax_lines: ShopifyTaxLine[];
|
|
878
|
-
title: string;
|
|
879
|
-
}
|
|
880
|
-
export interface ShopifyOrder {
|
|
881
|
-
attributes: Record<string, unknown>;
|
|
882
|
-
billing_address: ShopifyAddress;
|
|
883
|
-
/** @deprecated */
|
|
884
|
-
discounts: ShopifyDiscount[];
|
|
885
|
-
cancel_reason?: 'customer' | 'declined' | 'fraud' | 'inventory' | 'staff' | 'other';
|
|
886
|
-
cancel_reason_label?: string;
|
|
887
|
-
cancelled: boolean;
|
|
888
|
-
cancelled_at?: string;
|
|
889
|
-
cart_level_discount_applications: ShopifyDiscountApplication[];
|
|
890
|
-
confirmation_number: string;
|
|
891
|
-
created_at: string;
|
|
892
|
-
customer: ShopifyCustomer;
|
|
893
|
-
customer_order_url: string;
|
|
894
|
-
customer_url: string;
|
|
895
|
-
discount_applications: ShopifyDiscountApplication[];
|
|
896
|
-
email: string;
|
|
897
|
-
financial_status: 'authorized' | 'expired' | 'paid' | 'partially_paid' | 'partially_refunded' | 'pending' | 'refunded' | 'unpaid' | 'voided';
|
|
898
|
-
financial_status_label: string;
|
|
899
|
-
fulfillment_status: 'complete' | 'fulfilled' | 'partial' | 'restocked' | 'unfulfilled';
|
|
900
|
-
fulfillment_status_label: string;
|
|
901
|
-
id: number;
|
|
902
|
-
item_count: number;
|
|
903
|
-
line_items: ShopifyLineItem[];
|
|
904
|
-
line_items_subtotal_price: number;
|
|
905
|
-
metafields: Record<string, unknown>;
|
|
906
|
-
name: string;
|
|
907
|
-
note?: string;
|
|
908
|
-
order_number: number;
|
|
909
|
-
order_status_url: string;
|
|
910
|
-
phone: string;
|
|
911
|
-
'pickup_in_store?': boolean;
|
|
912
|
-
shipping_address?: ShopifyAddress;
|
|
913
|
-
shipping_methods: ShopifyShippingMethod[];
|
|
914
|
-
shipping_price: number;
|
|
915
|
-
subtotal_line_items: ShopifyLineItem[];
|
|
916
|
-
subtotal_price: number;
|
|
917
|
-
tags: string[];
|
|
918
|
-
tax_lines: ShopifyTaxLine[];
|
|
919
|
-
tax_price: number;
|
|
920
|
-
total_discounts: number;
|
|
921
|
-
total_duties: number;
|
|
922
|
-
total_net_amount: number;
|
|
923
|
-
total_price: number;
|
|
924
|
-
total_refunded_amount: number;
|
|
925
|
-
transactions: ShopifyTransaction[];
|
|
926
|
-
}
|
|
927
|
-
export interface ShopifyFont {
|
|
928
|
-
baseline_ratio: number;
|
|
929
|
-
fallback_families: string;
|
|
930
|
-
family: string;
|
|
931
|
-
style: string;
|
|
932
|
-
'system?': boolean;
|
|
933
|
-
variants: ShopifyFont[];
|
|
934
|
-
weight: number;
|
|
935
|
-
}
|
|
936
|
-
export interface ShopifyFormErrors {
|
|
937
|
-
messages: string[];
|
|
938
|
-
translated_fields: string[];
|
|
939
|
-
}
|
|
940
|
-
export interface ShopifyFormObject {
|
|
941
|
-
address1?: string;
|
|
942
|
-
address2?: string;
|
|
943
|
-
author?: string;
|
|
944
|
-
body?: string;
|
|
945
|
-
city?: string;
|
|
946
|
-
company?: string;
|
|
947
|
-
country?: string;
|
|
948
|
-
email?: string;
|
|
949
|
-
errors?: ShopifyFormErrors;
|
|
950
|
-
first_name?: string;
|
|
951
|
-
id: string;
|
|
952
|
-
last_name?: string;
|
|
953
|
-
message?: string;
|
|
954
|
-
name?: string;
|
|
955
|
-
'password_needed?'?: boolean;
|
|
956
|
-
phone?: string;
|
|
957
|
-
'posted_successfully?': boolean;
|
|
958
|
-
province?: string;
|
|
959
|
-
set_as_default_checkbox?: string;
|
|
960
|
-
zip?: string;
|
|
961
|
-
}
|
|
962
|
-
export interface ShopifyPageObject {
|
|
963
|
-
author?: string;
|
|
964
|
-
content: string;
|
|
965
|
-
handle: string;
|
|
966
|
-
id: number;
|
|
967
|
-
metafields: Record<string, unknown>;
|
|
968
|
-
published_at: string;
|
|
969
|
-
template_suffix?: string;
|
|
970
|
-
title: string;
|
|
971
|
-
url: string;
|
|
972
|
-
}
|
|
973
|
-
export interface ShopifyTemplate {
|
|
974
|
-
directory?: string;
|
|
975
|
-
name: '404' | 'article' | 'blog' | 'cart' | 'collection' | 'list-collections' | 'customers/account' | 'customers/activate_account' | 'customers/addresses' | 'customers/login' | 'customers/order' | 'customers/register' | 'customers/reset_password' | 'gift_card' | 'index' | 'page' | 'password' | 'product' | 'search';
|
|
976
|
-
suffix?: string;
|
|
977
|
-
}
|
|
978
|
-
export interface ShopifySearch {
|
|
979
|
-
default_sort_by: string;
|
|
980
|
-
filters: ShopifyFilter[];
|
|
981
|
-
performed: boolean;
|
|
982
|
-
results: object[];
|
|
983
|
-
results_count: number;
|
|
984
|
-
sort_by?: string;
|
|
985
|
-
sort_options: ShopifySortOption[];
|
|
986
|
-
terms: string;
|
|
987
|
-
types: Array<'article' | 'page' | 'product'>;
|
|
988
|
-
}
|
|
989
|
-
export interface ShopifyRecommendations {
|
|
990
|
-
intent?: string;
|
|
991
|
-
'performed?': boolean;
|
|
992
|
-
products: ShopifyProduct[];
|
|
993
|
-
products_count: number;
|
|
994
|
-
}
|
|
995
|
-
export interface ShopifyPredictiveSearchResources {
|
|
996
|
-
articles: ShopifyArticle[];
|
|
997
|
-
collections: ShopifyCollection[];
|
|
998
|
-
pages: ShopifyPageObject[];
|
|
999
|
-
products: ShopifyProduct[];
|
|
1000
|
-
}
|
|
1001
|
-
export interface ShopifyPredictiveSearch {
|
|
1002
|
-
performed: boolean;
|
|
1003
|
-
resources: ShopifyPredictiveSearchResources;
|
|
1004
|
-
terms: string;
|
|
1005
|
-
types: Array<'article' | 'collection' | 'page' | 'product'>;
|
|
1006
|
-
}
|
|
1007
|
-
export interface ShopifyPart {
|
|
1008
|
-
is_link: boolean;
|
|
1009
|
-
title: string;
|
|
1010
|
-
url?: string;
|
|
1011
|
-
}
|
|
1012
|
-
export interface ShopifyPaginate {
|
|
1013
|
-
current_offset: number;
|
|
1014
|
-
current_page: number;
|
|
1015
|
-
items: number;
|
|
1016
|
-
next?: ShopifyPart;
|
|
1017
|
-
page_param: string;
|
|
1018
|
-
page_size: number;
|
|
1019
|
-
pages: number;
|
|
1020
|
-
parts: ShopifyPart[];
|
|
1021
|
-
previous?: ShopifyPart;
|
|
1022
|
-
}
|
|
1023
|
-
export interface ShopifyRule {
|
|
1024
|
-
directive: string;
|
|
1025
|
-
value: string;
|
|
1026
|
-
}
|
|
1027
|
-
export interface ShopifyGroup {
|
|
1028
|
-
rules: ShopifyRule[];
|
|
1029
|
-
sitemap?: ShopifyRule;
|
|
1030
|
-
user_agent: ShopifyRule;
|
|
1031
|
-
}
|
|
1032
|
-
export interface ShopifyRobots {
|
|
1033
|
-
default_groups: ShopifyGroup[];
|
|
1034
|
-
}
|
|
1035
|
-
export {};
|