@builtbystack/sq-shopify-theme-sdk 0.0.18 → 0.0.20

package/README.doc.md

@@ -4,6 +4,13 @@
 
 `@x.x.x` で指定されているバージョンは適宜最新のものを利用してください。
 
+SDKは名前空間 `SQ` 内に存在するため、SDKの初期化は `new SQ.SDK()` で行ってください。
+
 ```html
 <script src="https://unpkg.com/@builtbystack/sq-shopify-theme-sdk@x.x.x/dist/sq-shopify-theme-sdk.umd.js" defer></script>
+<script type="text/javascript">
+  window.onload = async () => {
+    const sdk = new SQ.SDK({{ request.origin | json }});
+  }
+</script>
 ```

package/README.md

@@ -11,8 +11,15 @@
 
 `@x.x.x` で指定されているバージョンは適宜最新のものを利用してください。
 
+SDKは名前空間 `SQ` 内に存在するため、SDKの初期化は `new SQ.SDK()` で行ってください。
+
 ```html
 <script src="https://unpkg.com/@builtbystack/sq-shopify-theme-sdk@x.x.x/dist/sq-shopify-theme-sdk.umd.js" defer></script>
+<script type="text/javascript">
+  window.onload = async () => {
+    const sdk = new SQ.SDK({{ request.origin | json }});
+  }
+</script>
 ```
 
 # Classes
@@ -165,6 +172,28 @@ getPoints は、現在の保有ポイントと、獲得予定ポイントを返
 
 ***
 
+#### getProduct()
+
+> **getProduct**(`id`, `first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`Product`](#type-aliasesproductmd)\>
+
+##### Parameters
+
+• **id**: `string`
+
+• **first?**: `number`
+
+• **after?**: `string`
+
+• **isReverse?**: `boolean`
+
+• **sortKeys?**: `ProductVariantSortKeys`
+
+##### Returns
+
+`Promise`\<`null` \| [`Product`](#type-aliasesproductmd)\>
+
+***
+
 #### getPurchasingCustomerCurrentRank()
 
 > **getPurchasingCustomerCurrentRank**(): `Promise`\<`null` \| [`CustomerRank`](#type-aliasescustomerrankmd)\>
@@ -311,6 +340,7 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 - [CustomerRankCalculationPeriod](#type-aliasescustomerrankcalculationperiodmd)
 - [CustomerRankRule](#type-aliasescustomerrankrulemd)
 - [CustomerSharingActivationCode](#type-aliasescustomersharingactivationcodemd)
+- [InventoryItem](#type-aliasesinventoryitemmd)
 - [Location](#type-aliaseslocationmd)
 - [LocationAvailabilities](#type-aliaseslocationavailabilitiesmd)
 - [LocationAvailability](#type-aliaseslocationavailabilitymd)
@@ -321,6 +351,9 @@ purchasingCustomerSendCustomerSharingActivationCode はログインしている
 - [PointChangeActivity](#type-aliasespointchangeactivitymd)
 - [PointMultiplierCustomerRankRule](#type-aliasespointmultipliercustomerrankrulemd)
 - [Points](#type-aliasespointsmd)
+- [Product](#type-aliasesproductmd)
+- [ProductVariant](#type-aliasesproductvariantmd)
+- [ProductVariants](#type-aliasesproductvariantsmd)
 - [PurchasingCustomer](#type-aliasespurchasingcustomermd)
 - [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
 - [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
@@ -573,6 +606,31 @@ CustomerRankRule は会員ランクのルールを表す。
 > **purchasingCustomer**: [`PurchasingCustomer`](#type-aliasespurchasingcustomermd)
 
 
+<a name="type-aliasesinventoryitemmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / InventoryItem
+
+## Type Alias: InventoryItem
+
+> **InventoryItem**: `object`
+
+InventoryItem は在庫情報を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### sku
+
+> **sku**: `string`
+
+
 <a name="type-aliaseslocationmd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
@@ -915,6 +973,103 @@ PointsApproved は保有ポイントを表す。
 PointsPending は獲得予定ポイントを表す。
 
 
+<a name="type-aliasesproductmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Product
+
+## Type Alias: Product
+
+> **Product**: `object`
+
+Product は商品情報を表す。
+
+### Type declaration
+
+#### hasBackOrderProductVariants
+
+> **hasBackOrderProductVariants**: `boolean`
+
+商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る
+
+#### id
+
+> **id**: `string`
+
+#### title
+
+> **title**: `string`
+
+商品のタイトル
+
+#### variants
+
+> **variants**: [`ProductVariants`](#type-aliasesproductvariantsmd)
+
+商品のバリエーション一覧
+
+
+<a name="type-aliasesproductvariantmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / ProductVariant
+
+## Type Alias: ProductVariant
+
+> **ProductVariant**: `object`
+
+ProductVariant は商品のバリエーションを表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### inventoryItem
+
+> **inventoryItem**: [`InventoryItem`](#type-aliasesinventoryitemmd)
+
+#### isBackOrderEnable
+
+> **isBackOrderEnable**: `boolean`
+
+#### title
+
+> **title**: `string`
+
+
+<a name="type-aliasesproductvariantsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / ProductVariants
+
+## Type Alias: ProductVariants
+
+> **ProductVariants**: `object`
+
+ProductVariants は商品のバリエーションの一覧を取得するための情報を表す。
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`ProductVariant`](#type-aliasesproductvariantmd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
 <a name="type-aliasespurchasingcustomermd"></a>
 
 [**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**

package/dist/sq-shopify-theme-sdk.d.ts

@@ -104,6 +104,14 @@ export declare type CustomerSharingActivationCode = {
     customerSharingActivationCodeID: string;
 };
 
+/**
+ * InventoryItem は在庫情報を表す。
+ */
+export declare type InventoryItem = {
+    id: string;
+    sku: string;
+};
+
 /**
  * Location は ShopifyIntegration に紐付いている Location を表す。
  */
@@ -252,6 +260,47 @@ export declare type Points = {
     pointsPending: number;
 };
 
+/**
+ * Product は商品情報を表す。
+ */
+export declare type Product = {
+    id: string;
+    /**
+     * 商品のタイトル
+     */
+    title: string;
+    /**
+     * 商品が持つバリエーションに1つでも予約販売設定がされている場合trueが返る
+     */
+    hasBackOrderProductVariants: boolean;
+    /**
+     * 商品のバリエーション一覧
+     */
+    variants: ProductVariants;
+};
+
+/**
+ * ProductVariant は商品のバリエーションを表す。
+ */
+export declare type ProductVariant = {
+    id: string;
+    title: string;
+    isBackOrderEnable: boolean;
+    inventoryItem: InventoryItem;
+};
+
+/**
+ * ProductVariants は商品のバリエーションの一覧を取得するための情報を表す。
+ */
+export declare type ProductVariants = {
+    nodes: ProductVariant[];
+    pageInfo: PageInfo;
+};
+
+declare enum ProductVariantSortKeys {
+    CreatedAt = "CREATED_AT"
+}
+
 export declare type PurchasingCustomer = {
     id: string;
     sharingPurchasingCustomerCount: number;
@@ -380,6 +429,7 @@ export declare class SDK {
      * getPurchasingCustomerSharing は共有化している顧客情報を返します。
      */
     getPurchasingCustomerSharing(): Promise<PurchasingCustomerSharing | null>;
+    getProduct(id: string, first?: number, after?: string, isReverse?: boolean, sortKeys?: ProductVariantSortKeys): Promise<Product | null>;
     /**
      * purchasingCustomerSendCustomerSharingActivationCode はログインしているアカウントのメールアドレスに顧客情報共有のためのアクティベーションコードを送信します。
      */