color_me_shop 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7319e14550db521e337e99e941f3ce9dc8490fb1b0999ba3f0d60cca6da8a2de
+  data.tar.gz: d6094c6d31a990725cb22bb95442fc63c0506ca8d80c0fb4100ae98410290d01
+SHA512:
+  metadata.gz: 23f25552d3bd4fcbc88b14fa808d0e5a0232edfe03e9ec8ad754877b9a5669e9c17a6d607b6c176150e669a35bd5d4d2aa760170347745efcea5666fa9f728ec
+  data.tar.gz: b12dc691ab298195985610f4dbe4f62ea474d8d8e2d0343cde8da16be31ba4e07cd1fb45f0edd1d8275b633d788e26b586dd830b59734af060dbb925046bc5f6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    color_me_shop (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.13)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    public_suffix (3.0.2)
+    rake (12.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  color_me_shop!
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,148 @@
+# color_me_shop
+
+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     }   ] } ``` 
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.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)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build color_me_shop.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./color_me_shop-1.0.0.gem
+```
+(for development, run `gem install --dev ./color_me_shop-1.0.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'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'color_me_shop', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'color_me_shop'
+
+# Setup authorization
+ColorMeShop.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ColorMeShop::CategoryApi.new
+
+begin
+  #商品カテゴリー一覧を取得
+  result = api_instance.get_product_categories
+  p result
+rescue ColorMeShop::ApiError => e
+  puts "Exception when calling CategoryApi->get_product_categories: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+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::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 | 顧客データを追加
+*ColorMeShop::DeliveryApi* | [**get_deliveries**](docs/DeliveryApi.md#get_deliveries) | **GET** /v1/deliveries.json | 配送方法一覧を取得
+*ColorMeShop::DeliveryApi* | [**get_delivery_date_setting**](docs/DeliveryApi.md#get_delivery_date_setting) | **GET** /v1/deliveries/date.json | 配送日時設定を取得
+*ColorMeShop::EtcApi* | [**delete_device_token**](docs/EtcApi.md#delete_device_token) | **DELETE** /v1/device_tokens/{token}.json | デバイストークンの削除
+*ColorMeShop::GiftApi* | [**get_gift**](docs/GiftApi.md#get_gift) | **GET** /v1/gift.json | ギフト設定を取得
+*ColorMeShop::GroupApi* | [**get_product_groups**](docs/GroupApi.md#get_product_groups) | **GET** /v1/groups.json | 商品グループ一覧を取得
+*ColorMeShop::PaymentApi* | [**get_payments**](docs/PaymentApi.md#get_payments) | **GET** /v1/payments.json | 決済設定の一覧を取得
+*ColorMeShop::ProductApi* | [**delete_product_pickup**](docs/ProductApi.md#delete_product_pickup) | **DELETE** /v1/products/{productId}/pickups/{pickupType}.json | おすすめ商品情報の削除
+*ColorMeShop::ProductApi* | [**get_product**](docs/ProductApi.md#get_product) | **GET** /v1/products/{productId}.json | 商品データの取得
+*ColorMeShop::ProductApi* | [**get_products**](docs/ProductApi.md#get_products) | **GET** /v1/products.json | 商品一覧の取得
+*ColorMeShop::ProductApi* | [**post_product_pickup**](docs/ProductApi.md#post_product_pickup) | **POST** /v1/products/{productId}/pickups.json | おすすめ商品情報の追加
+*ColorMeShop::ProductApi* | [**update_product**](docs/ProductApi.md#update_product) | **PUT** /v1/products/{productId}.json | 商品データの更新
+*ColorMeShop::SaleApi* | [**cancel_sale**](docs/SaleApi.md#cancel_sale) | **PUT** /v1/sales/{saleId}/cancel.json | 受注のキャンセル
+*ColorMeShop::SaleApi* | [**get_sale**](docs/SaleApi.md#get_sale) | **GET** /v1/sales/{saleId}.json | 受注データの取得
+*ColorMeShop::SaleApi* | [**get_sales**](docs/SaleApi.md#get_sales) | **GET** /v1/sales.json | 受注データのリストを取得
+*ColorMeShop::SaleApi* | [**send_sales_mail**](docs/SaleApi.md#send_sales_mail) | **POST** /v1/sales/{saleId}/mails.json | メールの送信
+*ColorMeShop::SaleApi* | [**stat_sale**](docs/SaleApi.md#stat_sale) | **GET** /v1/sales/stat.json | 売上集計の取得
+*ColorMeShop::SaleApi* | [**update_sale**](docs/SaleApi.md#update_sale) | **PUT** /v1/sales/{saleId}.json | 受注データの更新
+*ColorMeShop::ScriptApi* | [**create_script_tag**](docs/ScriptApi.md#create_script_tag) | **POST** /v1/script_tags.json | スクリプトタグの作成
+*ColorMeShop::ScriptApi* | [**delete_script_tag**](docs/ScriptApi.md#delete_script_tag) | **DELETE** /v1/script_tags/{scriptTagId}.json | スクリプトタグの削除
+*ColorMeShop::ScriptApi* | [**get_script_tag**](docs/ScriptApi.md#get_script_tag) | **GET** /v1/script_tags/{scriptTagId}.json | スクリプトタグの取得
+*ColorMeShop::ScriptApi* | [**get_script_tags**](docs/ScriptApi.md#get_script_tags) | **GET** /v1/script_tags.json | スクリプトタグの取得
+*ColorMeShop::ScriptApi* | [**update_script_tag**](docs/ScriptApi.md#update_script_tag) | **PUT** /v1/script_tags/{scriptTagId}.json | スクリプトタグの更新
+*ColorMeShop::ShopApi* | [**get_shop**](docs/ShopApi.md#get_shop) | **GET** /v1/shop.json | ショップ情報の取得
+*ColorMeShop::StockApi* | [**get_stocks**](docs/StockApi.md#get_stocks) | **GET** /v1/stocks.json | 在庫情報の取得
+
+
+## Documentation for Models
+
+ - [ColorMeShop::Customer](docs/Customer.md)
+ - [ColorMeShop::Delivery](docs/Delivery.md)
+ - [ColorMeShop::DeliveryChargeByPrefecture](docs/DeliveryChargeByPrefecture.md)
+ - [ColorMeShop::DeliveryDateSetting](docs/DeliveryDateSetting.md)
+ - [ColorMeShop::Meta](docs/Meta.md)
+ - [ColorMeShop::Payment](docs/Payment.md)
+ - [ColorMeShop::Product](docs/Product.md)
+ - [ColorMeShop::ProductCategory](docs/ProductCategory.md)
+ - [ColorMeShop::ProductGroup](docs/ProductGroup.md)
+ - [ColorMeShop::ProductOption](docs/ProductOption.md)
+ - [ColorMeShop::ProductPickup](docs/ProductPickup.md)
+ - [ColorMeShop::ProductUpdateRequest](docs/ProductUpdateRequest.md)
+ - [ColorMeShop::ProductVariant](docs/ProductVariant.md)
+ - [ColorMeShop::Sale](docs/Sale.md)
+ - [ColorMeShop::SaleDelivery](docs/SaleDelivery.md)
+ - [ColorMeShop::SaleDetail](docs/SaleDetail.md)
+ - [ColorMeShop::ScriptTag](docs/ScriptTag.md)
+ - [ColorMeShop::Shop](docs/Shop.md)
+ - [ColorMeShop::Stock](docs/Stock.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://api.shop-pro.jp/oauth/authorize
+- **Scopes**: 
+  - read_products: 商品データを参照
+  - write_products: 在庫データを更新
+  - read_sales: 受注・顧客データを参照
+  - write_sales: 受注データを更新
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/color_me_shop.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#カラーミーショップ 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     }   ] } ``` 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.0.1-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "color_me_shop/version"
+
+Gem::Specification.new do |s|
+  s.name        = "color_me_shop"
+  s.version     = ColorMeShop::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["GMO Pepabo inc."]
+  s.email       = [""]
+  s.homepage    = "https://shop-pro.jp"
+  s.summary     = "カラーミーショップ API Ruby Gem"
+  s.description = "カラーミーショップAPIのRubyクライアントです。"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/CategoryApi.md

@@ -0,0 +1,53 @@
+# ColorMeShop::CategoryApi
+
+All URIs are relative to *https://api.shop-pro.jp/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_product_categories**](CategoryApi.md#get_product_categories) | **GET** /v1/categories.json | 商品カテゴリー一覧を取得
+
+
+# **get_product_categories**
+> Object get_product_categories
+
+商品カテゴリー一覧を取得
+
+### Example
+```ruby
+# load the gem
+require 'color_me_shop'
+# setup authorization
+ColorMeShop.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ColorMeShop::CategoryApi.new
+
+begin
+  #商品カテゴリー一覧を取得
+  result = api_instance.get_product_categories
+  p result
+rescue ColorMeShop::ApiError => e
+  puts "Exception when calling CategoryApi->get_product_categories: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Customer.md

@@ -0,0 +1,27 @@
+# ColorMeShop::Customer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | 顧客ID | [optional] 
+**account_id** | **String** | ショップアカウントID | [optional] 
+**name** | **String** | 顧客の名前 | [optional] 
+**furigana** | **String** | 名前のフリガナ | [optional] 
+**hojin** | **String** | 法人名 | [optional] 
+**busho** | **String** | 部署名 | [optional] 
+**sex** | **String** | 性別 | [optional] 
+**postal** | **String** | 郵便番号 | [optional] 
+**pref_id** | **Integer** | 都道府県の通し番号。北海道が1、沖縄が47 | [optional] 
+**pref_name** | **String** | 都道府県名 | [optional] 
+**address1** | **String** | 住所1 | [optional] 
+**address2** | **String** | 住所2 | [optional] 
+**mail** | **String** | メールアドレス | [optional] 
+**tel** | **String** | 電話番号 | [optional] 
+**fax** | **String** | FAX番号 | [optional] 
+**tel_mobile** | **String** | 携帯電話番号 | [optional] 
+**memo** | **String** | 備考 | [optional] 
+**points** | **Integer** | 保有ポイント数 | [optional] 
+**member** | **BOOLEAN** | 会員登録済みであるか否か | [optional] 
+**sales_count** | **Integer** | これまでの購入回数 | [optional] 
+
+

data/docs/CustomerApi.md

@@ -0,0 +1,177 @@
+# ColorMeShop::CustomerApi
+
+All URIs are relative to *https://api.shop-pro.jp/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_customer**](CustomerApi.md#get_customer) | **GET** /v1/customers/{customerId}.json | 顧客データの取得
+[**get_customers**](CustomerApi.md#get_customers) | **GET** /v1/customers.json | 顧客データのリストを取得
+[**post_customers**](CustomerApi.md#post_customers) | **POST** /v1/customers.json | 顧客データを追加
+
+
+# **get_customer**
+> Object get_customer(customer_id)
+
+顧客データの取得
+
+### Example
+```ruby
+# load the gem
+require 'color_me_shop'
+# setup authorization
+ColorMeShop.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ColorMeShop::CustomerApi.new
+customer_id = 56 # Integer | 
+
+begin
+  #顧客データの取得
+  result = api_instance.get_customer(customer_id)
+  p result
+rescue ColorMeShop::ApiError => e
+  puts "Exception when calling CustomerApi->get_customer: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_id** | **Integer**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_customers**
+> Object get_customers(opts)
+
+顧客データのリストを取得
+
+### Example
+```ruby
+# load the gem
+require 'color_me_shop'
+# setup authorization
+ColorMeShop.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ColorMeShop::CustomerApi.new
+opts = {
+  ids: 'ids_example', # String | 顧客IDで検索。カンマ区切りで複数指定可能
+  name: 'name_example', # String | 顧客名で部分一致検索
+  furigana: 'furigana_example', # String | 顧客フリガナがで部分一致検索
+  mail: 'mail_example', # String | 顧客メールアドレスで部分一致検索
+  postal: 'postal_example', # String | 顧客の郵便番号で部分一致検索
+  tel: 'tel_example', # String | 顧客の電話番号で部分一致検索
+  mobile: true, # BOOLEAN | `true`なら会員登録済みの顧客から検索
+  make_date_min: 'make_date_min_example', # String | 指定日時以降に登録された顧客から検索
+  make_date_max: 'make_date_max_example', # String | 指定日時以前に登録された顧客から検索
+  update_date_min: 'update_date_min_example', # String | 指定日時以降に更新された顧客から検索
+  update_date_max: 'update_date_max_example' # String | 指定日時以降に更新された顧客から検索
+}
+
+begin
+  #顧客データのリストを取得
+  result = api_instance.get_customers(opts)
+  p result
+rescue ColorMeShop::ApiError => e
+  puts "Exception when calling CustomerApi->get_customers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ids** | **String**| 顧客IDで検索。カンマ区切りで複数指定可能 | [optional] 
+ **name** | **String**| 顧客名で部分一致検索 | [optional] 
+ **furigana** | **String**| 顧客フリガナがで部分一致検索 | [optional] 
+ **mail** | **String**| 顧客メールアドレスで部分一致検索 | [optional] 
+ **postal** | **String**| 顧客の郵便番号で部分一致検索 | [optional] 
+ **tel** | **String**| 顧客の電話番号で部分一致検索 | [optional] 
+ **mobile** | **BOOLEAN**| `true`なら会員登録済みの顧客から検索 | [optional] 
+ **make_date_min** | **String**| 指定日時以降に登録された顧客から検索 | [optional] 
+ **make_date_max** | **String**| 指定日時以前に登録された顧客から検索 | [optional] 
+ **update_date_min** | **String**| 指定日時以降に更新された顧客から検索 | [optional] 
+ **update_date_max** | **String**| 指定日時以降に更新された顧客から検索 | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **post_customers**
+> Object post_customers(unknown_base_type)
+
+顧客データを追加
+
+### Example
+```ruby
+# load the gem
+require 'color_me_shop'
+# setup authorization
+ColorMeShop.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ColorMeShop::CustomerApi.new
+unknown_base_type = ColorMeShop::UNKNOWN_BASE_TYPE.new # Object | 
+
+begin
+  #顧客データを追加
+  result = api_instance.post_customers(unknown_base_type)
+  p result
+rescue ColorMeShop::ApiError => e
+  puts "Exception when calling CustomerApi->post_customers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **unknown_base_type** | [**Object**](UNKNOWN_BASE_TYPE.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Delivery.md

@@ -0,0 +1,26 @@
+# ColorMeShop::Delivery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | 配送方法ID | [optional] 
+**account_id** | **String** | ショップアカウントID | [optional] 
+**name** | **String** | 配送方法名 | [optional] 
+**image_url** | **String** | 配送方法画像URL | [optional] 
+**charge_free_type** | **String** | 配送料が無料になる基準  - `not_free`: 有料 - `free`: 無料 - `free_to_limit`: 注文金額が一定以上の場合は無料  | [optional] 
+**charge_free_limit** | **Integer** | 配送料が無料になる金額。`charge_free_type`が`free_to_limit`の場合のみ意味を持つ | [optional] 
+**charge_type** | **String** | 配送料の計算方法  - `fixed`: 固定額 - `by_price`: 注文金額によって決定 - `by_area`: 配送先都道府県によって決定 - `by_weight`: 商品重量によって決定  | [optional] 
+**charge** | **Object** | 配送料設定の詳細。上記の`charge_free_type`や`charge_type`に基づいて、この中から配送料が決定される | [optional] 
+**tax_included** | **BOOLEAN** | 送料が税込み料金であるか否か | [optional] 
+**slip_number_use** | **BOOLEAN** | 配送伝票番号設定を使用するか否か | [optional] 
+**slip_number_url** | **String** | 配送伝票番号確認URL | [optional] 
+**memo** | **String** | 配送方法の説明 | [optional] 
+**memo2** | **String** | フィーチャーフォン向けショップ用の配送方法説明 | [optional] 
+**sort** | **Integer** | 表示順 | [optional] 
+**display_state** | **String** | 表示状態 | [optional] 
+**preferred_date_use** | **BOOLEAN** | 配送希望日を指定可能か | [optional] 
+**preferred_period_use** | **BOOLEAN** | 配送時間帯を指定可能か | [optional] 
+**make_date** | **Integer** | 配送方法作成日時 | [optional] 
+**update_date** | **Integer** | 配送方法更新日時 | [optional] 
+
+