color_me_shop 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7319e14550db521e337e99e941f3ce9dc8490fb1b0999ba3f0d60cca6da8a2de
-  data.tar.gz: d6094c6d31a990725cb22bb95442fc63c0506ca8d80c0fb4100ae98410290d01
+  metadata.gz: 8f2858106378aac6ce2fc349a81110911ebd5dd75693121b53663fed7d9fea36
+  data.tar.gz: f233926907bfdc7a55de4af462de5f7503fa941afce34cb51bc1dec8b4e60414
 SHA512:
-  metadata.gz: 23f25552d3bd4fcbc88b14fa808d0e5a0232edfe03e9ec8ad754877b9a5669e9c17a6d607b6c176150e669a35bd5d4d2aa760170347745efcea5666fa9f728ec
-  data.tar.gz: b12dc691ab298195985610f4dbe4f62ea474d8d8e2d0343cde8da16be31ba4e07cd1fb45f0edd1d8275b633d788e26b586dd830b59734af060dbb925046bc5f6
+  metadata.gz: 3834ce596bf72e1723c11a5ec144ace6553a84d5802ba5f8db4ce1a5249f6910e54916d68f1e9d94701c19c2641c7bd70bc436f0e45ddefdc01ad06c661a2861
+  data.tar.gz: b343502cdda297bea531df4704d8d2d0158ae9899f0c485ae53bf75fc0b7e3ea3989c8708df085cf556e6fa3c609bc9713d47e1940c4ee8aa127ac530a0d6788

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    color_me_shop (1.0.0)
+    color_me_shop (1.1.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -2,12 +2,125 @@
 
 ColorMeShop - the Ruby gem for the カラーミーショップ API
 
-# カラーミーショップ API  [カラーミーショップ](https://shop-pro.jp) APIでは、受注の検索や商品情報の更新を行うことができます。  ## 利用手順  はじめに、カラーミーデベロッパーアカウントを用意します。[デベロッパー登録ページ](https://api.shop-pro.jp/developers/sign_up)から登録してください。  次に、[登録ページ](https://api.shop-pro.jp/oauth/applications/new)からアプリケーション登録を行ってください。 スマートフォンのWebViewを利用する場合は、リダイレクトURLに`urn:ietf:wg:oauth:2.0:oob`を入力してください。  その後、カラーミーショップアカウントの認証ページを開きます。認証ページのURLは、`https://api.shop-pro.jp/oauth/authorize`に必要なパラメータをつけたものです。  |パラメータ名|値| |---|---| |`client_id`|アプリケーション詳細画面で確認できるクライアントID| |`response_type`|\"code\"という文字列| |`scope`| 別表参照| |`redirect_url`|アプリケーション登録時に入力したリダイレクトURL|  `scope`は、以下のうち、アプリケーションが利用したい機能をスペース区切りで指定してください。  |スコープ|機能| |---|---| |`read_products`|商品データの参照| |`write_products`|在庫データの更新| |`read_sales`|受注・顧客データの参照| |`write_sales`|受注データの更新|  以下のようなURLとなります。  ``` https://api.shop-pro.jp/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&scope=read_products%20write_products ```  初めてこのページを訪れる場合は、カラーミーショップアカウントのIDとパスワードの入力を求められます。 承認ボタンを押すと、このアプリケーションがショップのデータにアクセスすることが許可され、リダイレクトURLへリダイレクトされます。  承認された場合は、`code`というクエリパラメータに認可コードが付与されます。承認がキャンセルされた、またはエラーが起きた場合は、 `error`パラメータにエラーの内容を表す文字列が与えられます。  アプリケーション登録時のリダイレクトURLに`urn:ietf:wg:oauth:2.0:oob`を指定した場合は、以下のようなURLにリダイレクトされます。 末尾のパスが認可コードになっています。  ``` https://api.shop-pro.jp/oauth/authorize/AUTH_CODE ```  認可コードの有効期限は発行から10分間です。  最後に、認可コードとアクセストークンを交換します。以下のパラメータを付けて、`https://api.shop-pro.jp/oauth/token`へリクエストを送ります。  |パラメータ名|値| |---|---| |`client_id`|アプリケーション詳細画面に表示されているクライアントID| |`client_secret`|アプリケーション詳細画面に表示されているクライアントシークレット| |`code`|取得した認可コード| |`grant_type`|\"authorization_code\"という文字列| |`redirect_uri`|アプリケーション登録時に入力したリダイレクトURL|  ```console # curl での例  $ curl -X POST \\   -d'client_id=CLIENT_ID' \\   -d'client_secret=CLIENT_SECRET' \\   -d'code=CODE' \\   -d'grant_type=authorization_code'   \\   -d'redirect_uri=REDIRECT_URI'  \\   'https://api.shop-pro.jp/oauth/token' ```  リクエストが成功すると、以下のようなJSONが返ってきます。  ```json {   \"access_token\": \"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX\",   \"token_type\": \"bearer\",   \"scope\": \"read_products write_products\" } ```  アクセストークンに有効期限はありませんが、許可済みアプリケーション一覧画面から失効させることができます。なお、同じ認可コードをアクセストークンに交換できるのは1度だけです。  取得したアクセストークンは、Authorizationヘッダに入れて使用します。以下にショップ情報を取得する際の例を示します。  ```console # curlの例  $ curl -H 'Authorization: Bearer d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX' https://api.shop-pro.jp/v1/shop.json ```  ## エラー  カラーミーショップAPI v1では  - エラーコード - エラーメッセージ - ステータスコード  の配列でエラーを表現します。以下に例を示します。  ```json {   \"errors\": [     {       \"code\": 404100,       \"message\": \"レコードが見つかりませんでした。\",       \"status\": 404     }   ] } ``` 
+# カラーミーショップ API
+
+[カラーミーショップ](https://shop-pro.jp) APIでは、受注の検索や商品情報の更新を行うことができます。
+
+## 利用手順
+
+はじめに、カラーミーデベロッパーアカウントを用意します。[デベロッパー登録ページ](https://api.shop-pro.jp/developers/sign_up)から登録してください。
+
+次に、[登録ページ](https://api.shop-pro.jp/oauth/applications/new)からアプリケーション登録を行ってください。
+スマートフォンのWebViewを利用する場合は、リダイレクトURLに`urn:ietf:wg:oauth:2.0:oob`を入力してください。
+
+その後、カラーミーショップアカウントの認証ページを開きます。認証ページのURLは、`https://api.shop-pro.jp/oauth/authorize`に必要なパラメータをつけたものです。
+
+|パラメータ名|値|
+|---|---|
+|`client_id`|アプリケーション詳細画面で確認できるクライアントID|
+|`response_type`|\"code\"という文字列|
+|`scope`| 別表参照|
+|`redirect_url`|アプリケーション登録時に入力したリダイレクトURL|
+
+`scope`は、以下のうち、アプリケーションが利用したい機能をスペース区切りで指定してください。
+
+|スコープ|機能|
+|---|---|
+|`read_products`|商品データの参照|
+|`write_products`|在庫データの更新|
+|`read_sales`|受注・顧客データの参照|
+|`write_sales`|受注データの更新|
+
+以下のようなURLとなります。
+
+```
+https://api.shop-pro.jp/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&scope=read_products%20write_products
+```
+
+初めてこのページを訪れる場合は、カラーミーショップアカウントのIDとパスワードの入力を求められます。
+承認ボタンを押すと、このアプリケーションがショップのデータにアクセスすることが許可され、リダイレクトURLへリダイレクトされます。
+
+承認された場合は、`code`というクエリパラメータに認可コードが付与されます。承認がキャンセルされた、またはエラーが起きた場合は、
+`error`パラメータにエラーの内容を表す文字列が与えられます。
+
+アプリケーション登録時のリダイレクトURLに`urn:ietf:wg:oauth:2.0:oob`を指定した場合は、以下のようなURLにリダイレクトされます。
+末尾のパスが認可コードになっています。
+
+```
+https://api.shop-pro.jp/oauth/authorize/AUTH_CODE
+```
+
+認可コードの有効期限は発行から10分間です。
+
+最後に、認可コードとアクセストークンを交換します。以下のパラメータを付けて、`https://api.shop-pro.jp/oauth/token`へリクエストを送ります。
+
+|パラメータ名|値|
+|---|---|
+|`client_id`|アプリケーション詳細画面に表示されているクライアントID|
+|`client_secret`|アプリケーション詳細画面に表示されているクライアントシークレット|
+|`code`|取得した認可コード|
+|`grant_type`|\"authorization_code\"という文字列|
+|`redirect_uri`|アプリケーション登録時に入力したリダイレクトURL|
+
+```console
+# curl での例
+
+$ curl -X POST \\
+  -d'client_id=CLIENT_ID' \\
+  -d'client_secret=CLIENT_SECRET' \\
+  -d'code=CODE' \\
+  -d'grant_type=authorization_code'   \\
+  -d'redirect_uri=REDIRECT_URI'  \\
+  'https://api.shop-pro.jp/oauth/token'
+```
+
+リクエストが成功すると、以下のようなJSONが返ってきます。
+
+```json
+{
+  \"access_token\": \"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX\",
+  \"token_type\": \"bearer\",
+  \"scope\": \"read_products write_products\"
+}
+```
+
+アクセストークンに有効期限はありませんが、許可済みアプリケーション一覧画面から失効させることができます。なお、同じ認可コードをアクセストークンに交換できるのは1度だけです。
+
+取得したアクセストークンは、Authorizationヘッダに入れて使用します。以下にショップ情報を取得する際の例を示します。
+
+```console
+# curlの例
+
+$ curl -H 'Authorization: Bearer d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX' https://api.shop-pro.jp/v1/shop.json
+```
+
+## エラー
+
+カラーミーショップAPI v1では
+
+- エラーコード
+- エラーメッセージ
+- ステータスコード
+
+の配列でエラーを表現します。以下に例を示します。
+
+```json
+{
+  \"errors\": [
+    {
+      \"code\": 404100,
+      \"message\": \"レコードが見つかりませんでした。\",
+      \"status\": 404
+    }
+  ]
+}
+```
+
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.0
+- Package version: 1.1.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://shop-pro.jp/?mode=inq](https://shop-pro.jp/?mode=inq)
 
@@ -24,15 +137,15 @@ gem build color_me_shop.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./color_me_shop-1.0.0.gem
+gem install ./color_me_shop-1.1.0.gem
 ```
-(for development, run `gem install --dev ./color_me_shop-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./color_me_shop-1.1.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'color_me_shop', '~> 1.0.0'
+    gem 'color_me_shop', '~> 1.1.0'
 
 ### Install from Git
 
@@ -75,11 +188,20 @@ end
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.shop-pro.jp/*
+All URIs are relative to *https://api.shop-pro.jp*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *ColorMeShop::CategoryApi* | [**get_product_categories**](docs/CategoryApi.md#get_product_categories) | **GET** /v1/categories.json | 商品カテゴリー一覧を取得
+*ColorMeShop::ChargeApi* | [**activate_application_charge**](docs/ChargeApi.md#activate_application_charge) | **POST** /v1/application_charges/{applicationChargeId}/activate.json | スポット課金データをアクティベートする
+*ColorMeShop::ChargeApi* | [**activate_recurring_application_charge**](docs/ChargeApi.md#activate_recurring_application_charge) | **POST** /v1/recurring_application_charges/{recurringApplicationChargeId}/activate.json | 月額課金データをアクティベートする
+*ColorMeShop::ChargeApi* | [**cancel_recurring_application_charge**](docs/ChargeApi.md#cancel_recurring_application_charge) | **POST** /v1/recurring_application_charges/{recurringApplicationChargeId}/cancel.json | 月額課金データをキャンセルする
+*ColorMeShop::ChargeApi* | [**get_application_charge**](docs/ChargeApi.md#get_application_charge) | **GET** /v1/application_charges/{applicationChargeId}.json | スポット課金データの取得
+*ColorMeShop::ChargeApi* | [**get_application_charges**](docs/ChargeApi.md#get_application_charges) | **GET** /v1/application_charges.json | スポット課金一覧の取得
+*ColorMeShop::ChargeApi* | [**get_recurring_application_charge**](docs/ChargeApi.md#get_recurring_application_charge) | **GET** /v1/recurring_application_charges/{recurringApplicationChargeId}.json | 月額課金データの取得
+*ColorMeShop::ChargeApi* | [**get_recurring_application_charges**](docs/ChargeApi.md#get_recurring_application_charges) | **GET** /v1/recurring_application_charges.json | 月額課金一覧の取得
+*ColorMeShop::ChargeApi* | [**post_application_charge**](docs/ChargeApi.md#post_application_charge) | **POST** /v1/application_charges.json | スポット課金データの作成
+*ColorMeShop::ChargeApi* | [**post_recurring_application_charge**](docs/ChargeApi.md#post_recurring_application_charge) | **POST** /v1/recurring_application_charges.json | 月額課金データの作成
 *ColorMeShop::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /v1/customers/{customerId}.json | 顧客データの取得
 *ColorMeShop::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /v1/customers.json | 顧客データのリストを取得
 *ColorMeShop::CustomerApi* | [**post_customers**](docs/CustomerApi.md#post_customers) | **POST** /v1/customers.json | 顧客データを追加
@@ -111,6 +233,8 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Models
 
+ - [ColorMeShop::ApplicationCharge](docs/ApplicationCharge.md)
+ - [ColorMeShop::ApplicationChargeCreateResponse](docs/ApplicationChargeCreateResponse.md)
  - [ColorMeShop::Customer](docs/Customer.md)
  - [ColorMeShop::Delivery](docs/Delivery.md)
  - [ColorMeShop::DeliveryChargeByPrefecture](docs/DeliveryChargeByPrefecture.md)
@@ -124,6 +248,8 @@ Class | Method | HTTP request | Description
  - [ColorMeShop::ProductPickup](docs/ProductPickup.md)
  - [ColorMeShop::ProductUpdateRequest](docs/ProductUpdateRequest.md)
  - [ColorMeShop::ProductVariant](docs/ProductVariant.md)
+ - [ColorMeShop::RecurringApplicationCharge](docs/RecurringApplicationCharge.md)
+ - [ColorMeShop::RecurringApplicationChargeCreateResponse](docs/RecurringApplicationChargeCreateResponse.md)
  - [ColorMeShop::Sale](docs/Sale.md)
  - [ColorMeShop::SaleDelivery](docs/SaleDelivery.md)
  - [ColorMeShop::SaleDetail](docs/SaleDetail.md)

data/color_me_shop.gemspec

@@ -8,7 +8,7 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.0.1-SNAPSHOT
+OpenAPI Generator version: 3.2.0-SNAPSHOT
 
 =end
 

data/docs/ApplicationCharge.md

@@ -0,0 +1,15 @@
+# ColorMeShop::ApplicationCharge
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | 課金ID | [optional] 
+**account_id** | **String** | アカウントID | [optional] 
+**oauth_application_id** | **Integer** | アプリケーションID | [optional] 
+**application_charge_plan_id** | **Integer** | 課金プランID | [optional] 
+**return_url** | **String** | ショップオーナー様が課金の許可/拒否を行った後に遷移するURL | [optional] 
+**status** | **String** | ステータス | [optional] 
+**make_date** | **Integer** | 作成日時 | [optional] 
+**update_date** | **Integer** | 更新日時 | [optional] 
+
+

data/docs/ApplicationChargeCreateResponse.md

@@ -0,0 +1,16 @@
+# ColorMeShop::ApplicationChargeCreateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | 課金ID | [optional] 
+**account_id** | **String** | アカウントID | [optional] 
+**oauth_application_id** | **Integer** | アプリケーションID | [optional] 
+**application_charge_plan_id** | **Integer** | 課金プランID | [optional] 
+**return_url** | **String** | ショップオーナー様が課金の許可/拒否を行った後に遷移するURL | [optional] 
+**confirmation_url** | **String** | ショップオーナー様が課金のOK/NGを行う確認画面ページのURLです。 URLには課金IDとsignatureを含んでいます。  | [optional] 
+**status** | **String** | ステータス | [optional] 
+**make_date** | **Integer** | 作成日時 | [optional] 
+**update_date** | **Integer** | 更新日時 | [optional] 
+
+

data/docs/CategoryApi.md

@@ -1,6 +1,6 @@
 # ColorMeShop::CategoryApi
 
-All URIs are relative to *https://api.shop-pro.jp/*
+All URIs are relative to *https://api.shop-pro.jp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------