@builtbystack/sq-shopify-theme-sdk 0.0.4 → 0.0.6

package/README.md

@@ -0,0 +1,768 @@
+
+<a name="readmemd"></a>
+
+**@builtbystack/sq-shopify-theme-sdk** • [**Docs**](#globalsmd)
+
+***
+
+# @builtbystack/sq-shopify-theme-sdk
+
+以下のScriptタグを適宜してください。
+
+`@x.x.x` で指定されているバージョンは適宜最新のものを利用してください。
+
+```html
+<script src="https://unpkg.com/@builtbystack/sq-shopify-theme-sdk@x.x.x/dist/sq-shopify-theme-sdk.umd.js" defer></script>
+```
+
+# Classes
+
+
+<a name="classessdkmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / SDK
+
+## Class: SDK
+
+### Constructors
+
+#### new SDK()
+
+> **new SDK**(`apiURL`): [`SDK`](#classessdkmd)
+
+##### Parameters
+
+• **apiURL**: `string`
+
+##### Returns
+
+[`SDK`](#classessdkmd)
+
+### Methods
+
+#### getLocationAvailabilities()
+
+> **getLocationAvailabilities**(`sku`, `first`?, `after`?, `isReverse`?): `Promise`\<[`LocationAvailabilities`](#type-aliaseslocationavailabilitiesmd)\>
+
+getLocationAvailabilities は渡されたSKUの各ロケーションにおける残り在庫の一覧を返します。
+
+##### Parameters
+
+• **sku**: `string`
+
+在庫一覧を取得したい商品のSKU。
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+##### Returns
+
+`Promise`\<[`LocationAvailabilities`](#type-aliaseslocationavailabilitiesmd)\>
+
+***
+
+#### getLocationAvailability()
+
+> **getLocationAvailability**(`sku`, `locationID`): `Promise`\<[`LocationAvailability`](#type-aliaseslocationavailabilitymd)\>
+
+getLocationAvailability は渡されたSKUとLocationIDにおける在庫情報を返します。
+
+##### Parameters
+
+• **sku**: `string`
+
+在庫情報を取得したい商品のSKU。
+
+• **locationID**: `string`
+
+在庫情報を取得したいLocationのID。
+
+##### Returns
+
+`Promise`\<[`LocationAvailability`](#type-aliaseslocationavailabilitymd)\>
+
+***
+
+#### getLocations()
+
+> **getLocations**(`first`?, `after`?, `isReverse`?): `Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
+
+getLocations は ShopifyIntegration に紐づく LocationGroup の Location の一覧を取得します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+##### Returns
+
+`Promise`\<[`Locations`](#type-aliaseslocationsmd)\>
+
+***
+
+#### getPointChangeActivities()
+
+> **getPointChangeActivities**(`first`?, `after`?, `isReverse`?, `sortKeys`?): `Promise`\<`null` \| [`PointChangeActivities`](#type-aliasespointchangeactivitiesmd)\>
+
+getPointChangeActivities は購入者のポイント変動履歴を返します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+• **sortKeys?**: `PointChangeActivitySortKey`
+
+ソートキー。CREATED_ATかPOINT_CHANGE_CREATED_ATを渡す。デフォルトはCREATED_AT。
+
+##### Returns
+
+`Promise`\<`null` \| [`PointChangeActivities`](#type-aliasespointchangeactivitiesmd)\>
+
+***
+
+#### getPoints()
+
+> **getPoints**(): `Promise`\<`null` \| [`Points`](#type-aliasespointsmd)\>
+
+getPoints は、現在の保有ポイントと、獲得予定ポイントを返します。
+存在しない場合は0を返します。
+
+##### Returns
+
+`Promise`\<`null` \| [`Points`](#type-aliasespointsmd)\>
+
+***
+
+#### getPurchasingCustomerCurrentRank()
+
+> **getPurchasingCustomerCurrentRank**(): `Promise`\<`null` \| [`CustomerRank`](#type-aliasescustomerrankmd)\>
+
+getPurchasingCustomerCurrentRank は購入者の現在のランク情報を返します。
+
+##### Returns
+
+`Promise`\<`null` \| [`CustomerRank`](#type-aliasescustomerrankmd)\>
+
+***
+
+#### getPurchasingCustomerDiscounts()
+
+> **getPurchasingCustomerDiscounts**(`first`?, `after`?, `isReverse`?): `Promise`\<`null` \| [`PurchasingCustomerDiscounts`](#type-aliasespurchasingcustomerdiscountsmd)\>
+
+getPurchasingCustomerDiscounts は購入者の割引情報を返します。
+
+##### Parameters
+
+• **first?**: `number`
+
+取得してくる個数。デフォルトは250。
+
+• **after?**: `string`
+
+ページングの値。指定しない場合先頭から取得してくる。
+
+• **isReverse?**: `boolean`
+
+並び順。デフォルトはfalse。
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerDiscounts`](#type-aliasespurchasingcustomerdiscountsmd)\>
+
+***
+
+#### getPurchasingCustomerMetafield()
+
+> **getPurchasingCustomerMetafield**(`namespace`, `key`): `Promise`\<`null` \| [`PurchasingCustomerMetafield`](#type-aliasespurchasingcustomermetafieldmd)\>
+
+getPurchasingCustomerMetafield は渡されたnamespaceとkeyに一致する現在ログインしているCustomerのカスタムメタフィールドを返します。
+存在しない場合はnullを返します。
+
+##### Parameters
+
+• **namespace**: `string`
+
+取得したいメタフィールドのnamespace。
+
+• **key**: `string`
+
+取得したいメタフィールドのkey。
+
+##### Returns
+
+`Promise`\<`null` \| [`PurchasingCustomerMetafield`](#type-aliasespurchasingcustomermetafieldmd)\>
+
+
+<a name="globalsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+# @builtbystack/sq-shopify-theme-sdk
+
+## Classes
+
+- [SDK](#classessdkmd)
+
+## Type Aliases
+
+- [CustomerRank](#type-aliasescustomerrankmd)
+- [CustomerRankCalculationCondition](#type-aliasescustomerrankcalculationconditionmd)
+- [CustomerRankCalculationPeriod](#type-aliasescustomerrankcalculationperiodmd)
+- [CustomerRankRule](#type-aliasescustomerrankrulemd)
+- [Location](#type-aliaseslocationmd)
+- [LocationAvailabilities](#type-aliaseslocationavailabilitiesmd)
+- [LocationAvailability](#type-aliaseslocationavailabilitymd)
+- [Locations](#type-aliaseslocationsmd)
+- [PageInfo](#type-aliasespageinfomd)
+- [PointChange](#type-aliasespointchangemd)
+- [PointChangeActivities](#type-aliasespointchangeactivitiesmd)
+- [PointChangeActivity](#type-aliasespointchangeactivitymd)
+- [Points](#type-aliasespointsmd)
+- [PurchasingCustomerDiscount](#type-aliasespurchasingcustomerdiscountmd)
+- [PurchasingCustomerDiscounts](#type-aliasespurchasingcustomerdiscountsmd)
+- [PurchasingCustomerMetafield](#type-aliasespurchasingcustomermetafieldmd)
+
+# Type Aliases
+
+
+<a name="type-aliasescustomerrankmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CustomerRank
+
+## Type Alias: CustomerRank
+
+> **CustomerRank**: `object`
+
+CustomerRank は会員ランクを表す。
+
+### Type declaration
+
+#### calculationCondition
+
+> **calculationCondition**: [`CustomerRankCalculationCondition`](#type-aliasescustomerrankcalculationconditionmd)
+
+#### earnedPointToRankUp
+
+> **earnedPointToRankUp**: `number`
+
+#### higherRank?
+
+> `optional` **higherRank**: [`CustomerRankRule`](#type-aliasescustomerrankrulemd)
+
+#### id
+
+> **id**: `string`
+
+#### lowerRank?
+
+> `optional` **lowerRank**: [`CustomerRankRule`](#type-aliasescustomerrankrulemd)
+
+#### name
+
+> **name**: `string`
+
+#### purchasePriceToRankUp
+
+> **purchasePriceToRankUp**: `number`
+
+#### threshold
+
+> **threshold**: `number`
+
+
+<a name="type-aliasescustomerrankcalculationconditionmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CustomerRankCalculationCondition
+
+## Type Alias: CustomerRankCalculationCondition
+
+> **CustomerRankCalculationCondition**: `object`
+
+CustomerRankCalculationCondition は会員ランクの算出条件を表す。
+
+### Type declaration
+
+#### customerRankCalculationPeriod?
+
+> `optional` **customerRankCalculationPeriod**: [`CustomerRankCalculationPeriod`](#type-aliasescustomerrankcalculationperiodmd)
+
+#### earnedPoint
+
+> **earnedPoint**: `number`
+
+#### purchasePrice
+
+> **purchasePrice**: `number`
+
+
+<a name="type-aliasescustomerrankcalculationperiodmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CustomerRankCalculationPeriod
+
+## Type Alias: CustomerRankCalculationPeriod
+
+> **CustomerRankCalculationPeriod**: `object`
+
+CustomerRankCalculationPeriod は会員ランクの算出期間を表す。
+
+### Type declaration
+
+#### end
+
+> **end**: `Date`
+
+#### start
+
+> **start**: `Date`
+
+
+<a name="type-aliasescustomerrankrulemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / CustomerRankRule
+
+## Type Alias: CustomerRankRule
+
+> **CustomerRankRule**: `object`
+
+CustomerRankRule は会員ランクのルールを表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### name
+
+> **name**: `string`
+
+#### threshold
+
+> **threshold**: `number`
+
+
+<a name="type-aliaseslocationmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Location
+
+## Type Alias: Location
+
+> **Location**: `object`
+
+Location は ShopifyIntegration に紐付いている Location を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### name
+
+> **name**: `string`
+
+
+<a name="type-aliaseslocationavailabilitiesmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / LocationAvailabilities
+
+## Type Alias: LocationAvailabilities
+
+> **LocationAvailabilities**: `object`
+
+LocationAvailabilities は LocationAvailability の一覧を取得するための情報を表す。
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`LocationAvailability`](#type-aliaseslocationavailabilitymd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliaseslocationavailabilitymd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / LocationAvailability
+
+## Type Alias: LocationAvailability
+
+> **LocationAvailability**: `object`
+
+LocationAvailability はLocationの在庫情報を表す。
+
+### Type declaration
+
+#### inventoryQuantity
+
+> **inventoryQuantity**: `number`
+
+inventoryQuantity は在庫数を表す。
+
+#### location
+
+> **location**: `object`
+
+location は在庫のLocationを表す。
+
+#### location.name
+
+> **name**: `string`
+
+name はLocationの名前を表す。
+
+
+<a name="type-aliaseslocationsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Locations
+
+## Type Alias: Locations
+
+> **Locations**: `object`
+
+Locations は Location の一覧を取得するための情報を表す。
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`Location`](#type-aliaseslocationmd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliasespageinfomd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PageInfo
+
+## Type Alias: PageInfo
+
+> **PageInfo**: `object`
+
+PageInfo はページングを伴って一覧を取得したときに、その一覧のページングの情報を表す。
+
+### Type declaration
+
+#### endCursor
+
+> **endCursor**: `string`
+
+endCursor は一覧の末尾のカーソルを表す。
+このカーソルを使って次のページを取得することができる。
+
+#### hasNextPage
+
+> **hasNextPage**: `boolean`
+
+hasNextPage は次のページがあるかどうかを表す。
+
+#### hasPreviousPage
+
+> **hasPreviousPage**: `boolean`
+
+hasPreviousPage は前のページがあるかどうかを表す。
+
+#### startCursor
+
+> **startCursor**: `string`
+
+startCursor は一覧の先頭のカーソルを表す。
+
+
+<a name="type-aliasespointchangemd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointChange
+
+## Type Alias: PointChange
+
+> **PointChange**: `object`
+
+PointChange はポイントの変動を表す。
+
+### Type declaration
+
+#### availableAt?
+
+> `optional` **availableAt**: `Date`
+
+#### availableUntil?
+
+> `optional` **availableUntil**: `Date`
+
+#### createdAt
+
+> **createdAt**: `Date`
+
+#### delta
+
+> **delta**: `number`
+
+#### expiresDate?
+
+> `optional` **expiresDate**: `Date`
+
+#### id
+
+> **id**: `string`
+
+#### pointChangeCreatedAt
+
+> **pointChangeCreatedAt**: `Date`
+
+
+<a name="type-aliasespointchangeactivitiesmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointChangeActivities
+
+## Type Alias: PointChangeActivities
+
+> **PointChangeActivities**: `object`
+
+### Type declaration
+
+#### nodes
+
+> **nodes**: [`PointChangeActivity`](#type-aliasespointchangeactivitymd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliasespointchangeactivitymd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PointChangeActivity
+
+## Type Alias: PointChangeActivity
+
+> **PointChangeActivity**: `object`
+
+PointChangeActivity はポイントの変動の履歴を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### pointChange
+
+> **pointChange**: [`PointChange`](#type-aliasespointchangemd)
+
+#### title
+
+> **title**: `string`
+
+
+<a name="type-aliasespointsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / Points
+
+## Type Alias: Points
+
+> **Points**: `object`
+
+Points は SDK から取得できるポイントの情報を表す。
+
+### Type declaration
+
+#### pointsApproved
+
+> **pointsApproved**: `number`
+
+#### pointsPending
+
+> **pointsPending**: `number`
+
+
+<a name="type-aliasespurchasingcustomerdiscountmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerDiscount
+
+## Type Alias: PurchasingCustomerDiscount
+
+> **PurchasingCustomerDiscount**: `object`
+
+PurchasingCustomerDiscount は購入者の割引情報を表す。
+
+### Type declaration
+
+#### code
+
+> **code**: `string`
+
+#### createdAt
+
+> **createdAt**: `Date`
+
+#### description
+
+> **description**: `string`
+
+#### id
+
+> **id**: `string`
+
+#### title
+
+> **title**: `string`
+
+#### updatedAt
+
+> **updatedAt**: `Date`
+
+
+<a name="type-aliasespurchasingcustomerdiscountsmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerDiscounts
+
+## Type Alias: PurchasingCustomerDiscounts
+
+> **PurchasingCustomerDiscounts**: `object`
+
+DiscountCodes は PurchasingCustomerDiscount の一覧を取得するための情報を表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### nodes
+
+> **nodes**: [`PurchasingCustomerDiscount`](#type-aliasespurchasingcustomerdiscountmd)[]
+
+#### pageInfo
+
+> **pageInfo**: [`PageInfo`](#type-aliasespageinfomd)
+
+
+<a name="type-aliasespurchasingcustomermetafieldmd"></a>
+
+[**@builtbystack/sq-shopify-theme-sdk**](#readmemd) • **Docs**
+
+***
+
+[@builtbystack/sq-shopify-theme-sdk](#globalsmd) / PurchasingCustomerMetafield
+
+## Type Alias: PurchasingCustomerMetafield
+
+> **PurchasingCustomerMetafield**: `object`
+
+PurchasingCustomerMetafield は購入者のカスタムメタフィールドを表す。
+
+### Type declaration
+
+#### id
+
+> **id**: `string`
+
+#### key
+
+> **key**: `string`
+
+#### namespace
+
+> **namespace**: `string`
+
+#### value
+
+> **value**: `string`