@builtbystack/sq-shopify-theme-sdk 0.0.22 → 0.0.23
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 +84 -0
- package/dist/sq-shopify-theme-sdk.d.ts +39 -0
- package/dist/sq-shopify-theme-sdk.js +303 -278
- package/dist/sq-shopify-theme-sdk.umd.js +41 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -137,6 +137,16 @@ getLocations は ShopifyIntegration に紐づく LocationGroup の Location の
|
|
|
137
137
|
|
|
138
138
|
***
|
|
139
139
|
|
|
140
|
+
#### getPointCampaignOrderRuleTargetCustomerRank()
|
|
141
|
+
|
|
142
|
+
> **getPointCampaignOrderRuleTargetCustomerRank**(): `Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
|
|
143
|
+
|
|
144
|
+
##### Returns
|
|
145
|
+
|
|
146
|
+
`Promise`\<`null` \| [`PointCampaignOrderRuleTargetCustomerRank`](#type-aliasespointcampaignorderruletargetcustomerrankmd)\>
|
|
147
|
+
|
|
148
|
+
***
|
|
149
|
+
|
|
140
150
|
#### getPointChangeActivities()
|
|
141
151
|
|
|
142
152
|
> **getPointChangeActivities**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`PointChangeActivities`](#type-aliasespointchangeactivitiesmd)\>
|
|
@@ -354,6 +364,8 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
|
|
|
354
364
|
- [LocationAvailability](#type-aliaseslocationavailabilitymd)
|
|
355
365
|
- [Locations](#type-aliaseslocationsmd)
|
|
356
366
|
- [PageInfo](#type-aliasespageinfomd)
|
|
367
|
+
- [PointCampaignOrderRule](#type-aliasespointcampaignorderrulemd)
|
|
368
|
+
- [PointCampaignOrderRuleTargetCustomerRank](#type-aliasespointcampaignorderruletargetcustomerrankmd)
|
|
357
369
|
- [PointChange](#type-aliasespointchangemd)
|
|
358
370
|
- [PointChangeActivities](#type-aliasespointchangeactivitiesmd)
|
|
359
371
|
- [PointChangeActivity](#type-aliasespointchangeactivitymd)
|
|
@@ -801,6 +813,78 @@ hasPreviousPage は前のページがあるかどうかを表す。
|
|
|
801
813
|
startCursor は一覧の先頭のカーソルを表す。
|
|
802
814
|
|
|
803
815
|
|
|
816
|
+
<a name="type-aliasespointcampaignorderrulemd"></a>
|
|
817
|
+
|
|
818
|
+
[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
|
|
819
|
+
|
|
820
|
+
***
|
|
821
|
+
|
|
822
|
+
[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointCampaignOrderRule
|
|
823
|
+
|
|
824
|
+
## Type Alias: PointCampaignOrderRule
|
|
825
|
+
|
|
826
|
+
> **PointCampaignOrderRule**: `object`
|
|
827
|
+
|
|
828
|
+
PointCampaignOrderRule はポイントキャンペーンの設定を表す。
|
|
829
|
+
|
|
830
|
+
### Type declaration
|
|
831
|
+
|
|
832
|
+
#### id
|
|
833
|
+
|
|
834
|
+
> **id**: `string`
|
|
835
|
+
|
|
836
|
+
#### title
|
|
837
|
+
|
|
838
|
+
> **title**: `string`
|
|
839
|
+
|
|
840
|
+
キャンペーンのタイトル
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
<a name="type-aliasespointcampaignorderruletargetcustomerrankmd"></a>
|
|
844
|
+
|
|
845
|
+
[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
|
|
846
|
+
|
|
847
|
+
***
|
|
848
|
+
|
|
849
|
+
[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointCampaignOrderRuleTargetCustomerRank
|
|
850
|
+
|
|
851
|
+
## Type Alias: PointCampaignOrderRuleTargetCustomerRank
|
|
852
|
+
|
|
853
|
+
> **PointCampaignOrderRuleTargetCustomerRank**: `object`
|
|
854
|
+
|
|
855
|
+
PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。
|
|
856
|
+
以下の場合はnullを返す
|
|
857
|
+
- 開催期間中であるキャンペーンが存在しない場合
|
|
858
|
+
- 存在するが種別が会員ランクではない場合
|
|
859
|
+
- 未ログインの場合
|
|
860
|
+
|
|
861
|
+
### Type declaration
|
|
862
|
+
|
|
863
|
+
#### fixedPoint?
|
|
864
|
+
|
|
865
|
+
> `optional` **fixedPoint**: `string`
|
|
866
|
+
|
|
867
|
+
顧客に適用されるキャンペーン倍率
|
|
868
|
+
以下の場合はnullを返す
|
|
869
|
+
- 該当キャンペーンが存在しない場合
|
|
870
|
+
- 未ログイン状態の場合
|
|
871
|
+
- 計算方法が固定ポイントでない場合
|
|
872
|
+
|
|
873
|
+
#### multiplier?
|
|
874
|
+
|
|
875
|
+
> `optional` **multiplier**: `string`
|
|
876
|
+
|
|
877
|
+
顧客に適用されるキャンペーン倍率
|
|
878
|
+
以下の場合はnullを返す
|
|
879
|
+
- 該当キャンペーンが存在しない場合
|
|
880
|
+
- 未ログイン状態の場合
|
|
881
|
+
- 計算方法が倍率でない場合
|
|
882
|
+
|
|
883
|
+
#### pointCampaignOrderRule
|
|
884
|
+
|
|
885
|
+
> **pointCampaignOrderRule**: [`PointCampaignOrderRule`](#type-aliasespointcampaignorderrulemd)
|
|
886
|
+
|
|
887
|
+
|
|
804
888
|
<a name="type-aliasespointchangemd"></a>
|
|
805
889
|
|
|
806
890
|
[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
|
|
@@ -178,6 +178,44 @@ export declare type PageInfo = {
|
|
|
178
178
|
hasPreviousPage: boolean;
|
|
179
179
|
};
|
|
180
180
|
|
|
181
|
+
/**
|
|
182
|
+
* PointCampaignOrderRule はポイントキャンペーンの設定を表す。
|
|
183
|
+
*/
|
|
184
|
+
export declare type PointCampaignOrderRule = {
|
|
185
|
+
id: string;
|
|
186
|
+
/**
|
|
187
|
+
* キャンペーンのタイトル
|
|
188
|
+
*/
|
|
189
|
+
title: string;
|
|
190
|
+
};
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* PointCampaignOrderRuleTargetCustomerRank は会員ランク種別のポイントキャンペーンの設定を表す。
|
|
194
|
+
* 以下の場合はnullを返す
|
|
195
|
+
* - 開催期間中であるキャンペーンが存在しない場合
|
|
196
|
+
* - 存在するが種別が会員ランクではない場合
|
|
197
|
+
* - 未ログインの場合
|
|
198
|
+
*/
|
|
199
|
+
export declare type PointCampaignOrderRuleTargetCustomerRank = {
|
|
200
|
+
pointCampaignOrderRule: PointCampaignOrderRule;
|
|
201
|
+
/**
|
|
202
|
+
* 顧客に適用されるキャンペーン倍率
|
|
203
|
+
* 以下の場合はnullを返す
|
|
204
|
+
* - 該当キャンペーンが存在しない場合
|
|
205
|
+
* - 未ログイン状態の場合
|
|
206
|
+
* - 計算方法が倍率でない場合
|
|
207
|
+
*/
|
|
208
|
+
multiplier?: string;
|
|
209
|
+
/**
|
|
210
|
+
* 顧客に適用されるキャンペーン倍率
|
|
211
|
+
* 以下の場合はnullを返す
|
|
212
|
+
* - 該当キャンペーンが存在しない場合
|
|
213
|
+
* - 未ログイン状態の場合
|
|
214
|
+
* - 計算方法が固定ポイントでない場合
|
|
215
|
+
*/
|
|
216
|
+
fixedPoint?: string;
|
|
217
|
+
};
|
|
218
|
+
|
|
181
219
|
/**
|
|
182
220
|
* PointChange はポイントの変動を表す。
|
|
183
221
|
*/
|
|
@@ -450,6 +488,7 @@ export declare class SDK {
|
|
|
450
488
|
*/
|
|
451
489
|
getPurchasingCustomerSharing(): Promise<PurchasingCustomerSharing | null>;
|
|
452
490
|
getProduct(id: string, first?: number, after?: string, isReverse?: boolean, sortKeys?: ProductVariantSortKeys): Promise<Product | null>;
|
|
491
|
+
getPointCampaignOrderRuleTargetCustomerRank(): Promise<PointCampaignOrderRuleTargetCustomerRank | null>;
|
|
453
492
|
/**
|
|
454
493
|
* purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
|
|
455
494
|
*/
|