bigcommerce 1.0.0.beta → 1.0.1
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.
- checksums.yaml +4 -4
- data/README.md +115 -39
- data/bigcommerce.gemspec +12 -13
- data/lib/bigcommerce.rb +5 -34
- data/lib/bigcommerce/config.rb +14 -0
- data/lib/bigcommerce/connection.rb +26 -0
- data/lib/bigcommerce/exception.rb +25 -18
- data/lib/bigcommerce/request.rb +8 -9
- data/lib/bigcommerce/resource_actions.rb +11 -11
- data/lib/bigcommerce/resources/content/blog_post.rb +3 -5
- data/lib/bigcommerce/resources/content/blog_tag.rb +2 -3
- data/lib/bigcommerce/resources/content/redirect.rb +2 -2
- data/lib/bigcommerce/resources/customers/customer.rb +22 -2
- data/lib/bigcommerce/resources/customers/customer_address.rb +5 -5
- data/lib/bigcommerce/resources/customers/customer_group.rb +2 -2
- data/lib/bigcommerce/resources/geography/country.rb +4 -3
- data/lib/bigcommerce/resources/geography/state.rb +6 -5
- data/lib/bigcommerce/resources/marketing/banner.rb +21 -0
- data/lib/bigcommerce/resources/marketing/coupon.rb +2 -2
- data/lib/bigcommerce/resources/marketing/gift_certificates.rb +25 -0
- data/lib/bigcommerce/resources/orders/order.rb +46 -44
- data/lib/bigcommerce/resources/orders/order_coupon.rb +5 -5
- data/lib/bigcommerce/resources/orders/order_message.rb +8 -7
- data/lib/bigcommerce/resources/orders/order_product.rb +37 -36
- data/lib/bigcommerce/resources/orders/order_shipping_address.rb +24 -23
- data/lib/bigcommerce/resources/orders/order_status.rb +2 -1
- data/lib/bigcommerce/resources/orders/order_tax.rb +8 -7
- data/lib/bigcommerce/resources/orders/shipment.rb +11 -10
- data/lib/bigcommerce/resources/products/brand.rb +2 -2
- data/lib/bigcommerce/resources/products/bulk_pricing_rule.rb +6 -5
- data/lib/bigcommerce/resources/products/category.rb +2 -2
- data/lib/bigcommerce/resources/products/configurable_field.rb +6 -5
- data/lib/bigcommerce/resources/products/custom_field.rb +6 -5
- data/lib/bigcommerce/resources/products/google_product_search_mapping.rb +9 -8
- data/lib/bigcommerce/resources/products/option.rb +2 -2
- data/lib/bigcommerce/resources/products/option_set.rb +2 -2
- data/lib/bigcommerce/resources/products/option_set_option.rb +2 -1
- data/lib/bigcommerce/resources/products/option_value.rb +1 -0
- data/lib/bigcommerce/resources/products/product.rb +61 -61
- data/lib/bigcommerce/resources/products/product_image.rb +4 -4
- data/lib/bigcommerce/resources/products/product_option.rb +2 -1
- data/lib/bigcommerce/resources/products/product_review.rb +1 -5
- data/lib/bigcommerce/resources/products/product_rule.rb +4 -4
- data/lib/bigcommerce/resources/products/product_video.rb +4 -4
- data/lib/bigcommerce/resources/products/sku.rb +15 -9
- data/lib/bigcommerce/resources/shipping/shipping_method.rb +2 -1
- data/lib/bigcommerce/resources/store/store_information.rb +18 -14
- data/lib/bigcommerce/resources/system/time.rb +2 -2
- data/lib/bigcommerce/resources/tax/tax_class.rb +2 -1
- data/lib/bigcommerce/resources/webhooks/webhook.rb +2 -1
- data/lib/bigcommerce/subresource_actions.rb +14 -14
- data/lib/bigcommerce/version.rb +1 -1
- metadata +47 -166
- data/.gitignore +0 -17
- data/.rspec +0 -2
- data/.rubocop.yml +0 -620
- data/.travis.yml +0 -15
- data/CHANGELOG.md +0 -11
- data/CONTRIBUTING.md +0 -119
- data/DEPENDENCIES.md +0 -7
- data/Gemfile +0 -15
- data/Guardfile +0 -22
- data/LICENSE +0 -20
- data/RELEASING.md +0 -64
- data/Rakefile +0 -13
- data/examples/README.md +0 -148
- data/examples/configuration/legacy_auth.rb +0 -12
- data/examples/configuration/oauth.rb +0 -9
- data/examples/content/blog_post.rb +0 -39
- data/examples/content/blog_tag.rb +0 -10
- data/examples/content/redirect.rb +0 -43
- data/examples/customers/customer.rb +0 -36
- data/examples/customers/customer_address.rb +0 -50
- data/examples/customers/customer_group.rb +0 -35
- data/examples/exception_handling.rb +0 -50
- data/examples/geography/country.rb +0 -16
- data/examples/geography/state.rb +0 -19
- data/examples/marketing/coupon.rb +0 -44
- data/examples/orders/order.rb +0 -53
- data/examples/orders/order_coupon.rb +0 -17
- data/examples/orders/order_message.rb +0 -17
- data/examples/orders/order_product.rb +0 -23
- data/examples/orders/order_shipping_address.rb +0 -23
- data/examples/orders/order_status.rb +0 -15
- data/examples/orders/order_tax.rb +0 -17
- data/examples/orders/shipment.rb +0 -57
- data/examples/payments/payment_method.rb +0 -10
- data/examples/products/brand.rb +0 -36
- data/examples/products/bulk_pricing_rule.rb +0 -47
- data/examples/products/category.rb +0 -37
- data/examples/products/configurable_field.rb +0 -29
- data/examples/products/custom_field.rb +0 -44
- data/examples/products/google_product_search_mapping.rb +0 -12
- data/examples/products/option.rb +0 -37
- data/examples/products/option_set.rb +0 -35
- data/examples/products/option_set_option.rb +0 -50
- data/examples/products/option_value.rb +0 -43
- data/examples/products/product.rb +0 -44
- data/examples/products/product_image.rb +0 -42
- data/examples/products/product_option.rb +0 -17
- data/examples/products/product_review.rb +0 -12
- data/examples/products/product_rule.rb +0 -54
- data/examples/products/product_video.rb +0 -45
- data/examples/products/sku.rb +0 -48
- data/examples/shipping/shipping_method.rb +0 -13
- data/examples/store/store_info.rb +0 -10
- data/examples/system/time.rb +0 -10
- data/examples/tax/tax_class.rb +0 -13
- data/examples/webhooks/webhook.rb +0 -29
- data/spec/bigcommerce/bigcommerce_spec.rb +0 -76
- data/spec/bigcommerce/unit/actions_spec.rb +0 -151
- data/spec/bigcommerce/unit/exception_spec.rb +0 -53
- data/spec/bigcommerce/unit/middleware/auth_spec.rb +0 -18
- data/spec/bigcommerce/unit/middleware/http_exception_spec.rb +0 -40
- data/spec/bigcommerce/unit/request_spec.rb +0 -180
- data/spec/bigcommerce/unit/resources/content/blog_post_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/content/blog_tag_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/content/redirect_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/customers/customer_address_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/customers/customer_group_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/customers/customer_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/geography/country_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/geography/state_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/marketing/coupon_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/orders/order_product_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/orders/order_shipping_address_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/orders/order_spec.rb +0 -13
- data/spec/bigcommerce/unit/resources/orders/shipment_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/payments/payment_method_spec.rb +0 -23
- data/spec/bigcommerce/unit/resources/products/brand_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/products/bulk_pricing_rule_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/products/category_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/products/configurable_field_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/products/custom_field_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/products/google_product_search_mapping_spec.rb +0 -14
- data/spec/bigcommerce/unit/resources/products/option_set_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/products/option_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/products/product_image_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/products/product_review_spec.rb +0 -14
- data/spec/bigcommerce/unit/resources/products/product_rule_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/products/product_spec.rb +0 -13
- data/spec/bigcommerce/unit/resources/products/product_video_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/products/sku_spec.rb +0 -21
- data/spec/bigcommerce/unit/resources/resource_spec.rb +0 -4
- data/spec/bigcommerce/unit/resources/store_info/store_information_spec.rb +0 -12
- data/spec/bigcommerce/unit/resources/system/time_spec.rb +0 -12
- data/spec/bigcommerce/unit/version_spec.rb +0 -7
- data/spec/spec_helper.rb +0 -11
data/.travis.yml
DELETED
data/CHANGELOG.md
DELETED
@@ -1,11 +0,0 @@
|
|
1
|
-
## Next Release
|
2
|
-
|
3
|
-
* Your contribution here.
|
4
|
-
|
5
|
-
## 1.0.0
|
6
|
-
Please note that this is the start of a new major release which breaks all backward compatibility.
|
7
|
-
|
8
|
-
* [#89](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/89): Complete rewrite of Bigcommerce API Client. - [@pedelman](https://github.com/pedelman).
|
9
|
-
|
10
|
-
## 0.x (Legacy)
|
11
|
-
For the old version of the API Client please view the [0.x branch](https://github.com/bigcommerce/bigcommerce-api-ruby/tree/0.x).
|
data/CONTRIBUTING.md
DELETED
@@ -1,119 +0,0 @@
|
|
1
|
-
# Contributing to Bigcommerce
|
2
|
-
|
3
|
-
|
4
|
-
We would love to see contributors! You're encouraged to submit [pull requests](https://github.com/bigcommerce/bigcommerce-api-ruby/pulls), [propose features, and discuss issues](https://github.com/bigcommerce/bigcommerce-api-ruby/issues).
|
5
|
-
|
6
|
-
#### Fork the Project
|
7
|
-
|
8
|
-
Fork the [project on Github](https://github.com/bigcommerce/bigcommerce-api-ruby) and check out your copy.
|
9
|
-
|
10
|
-
```
|
11
|
-
git clone your_forked_version_of_bigcommerce_api_ruby
|
12
|
-
cd bigcommerce-api-ruby
|
13
|
-
git remote add upstream https://github.com/bigcommerce/bigcommerce-api-ruby.git
|
14
|
-
```
|
15
|
-
|
16
|
-
#### Create a Feature Branch
|
17
|
-
|
18
|
-
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
|
19
|
-
|
20
|
-
```
|
21
|
-
git checkout master
|
22
|
-
git pull upstream master
|
23
|
-
git checkout -b my-feature-branch
|
24
|
-
```
|
25
|
-
|
26
|
-
#### Bundle Install and Test
|
27
|
-
|
28
|
-
Ensure that you can build the project and run tests.
|
29
|
-
|
30
|
-
```
|
31
|
-
bundle install
|
32
|
-
bundle exec rake
|
33
|
-
```
|
34
|
-
|
35
|
-
#### Installing the gem locally (useful to run examples)
|
36
|
-
|
37
|
-
This will build the gem locally into the pkg directory, you can then install it manually by targeting that directory specifically.
|
38
|
-
|
39
|
-
```
|
40
|
-
bundle exec rake build
|
41
|
-
gem install pkg/bigcommerce-1.x.x.gem
|
42
|
-
```
|
43
|
-
|
44
|
-
#### Write Tests
|
45
|
-
|
46
|
-
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/bigcommerce](spec/bigcommerce).
|
47
|
-
|
48
|
-
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
|
49
|
-
|
50
|
-
#### Write Code
|
51
|
-
|
52
|
-
Implement your feature or bug fix.
|
53
|
-
|
54
|
-
Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
|
55
|
-
|
56
|
-
Make sure that `bundle exec rake` completes without errors.
|
57
|
-
|
58
|
-
#### Write Documentation
|
59
|
-
|
60
|
-
Document any external behavior in the [README](README.md).
|
61
|
-
|
62
|
-
#### Update Changelog
|
63
|
-
|
64
|
-
Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
|
65
|
-
|
66
|
-
#### Commit Changes
|
67
|
-
|
68
|
-
Make sure git knows your name and email address:
|
69
|
-
|
70
|
-
```
|
71
|
-
git config --global user.name "Your Name"
|
72
|
-
git config --global user.email "contributor@example.com"
|
73
|
-
```
|
74
|
-
|
75
|
-
Writing good commit logs is important. A commit log should describe what changed and why.
|
76
|
-
|
77
|
-
```
|
78
|
-
git add ...
|
79
|
-
git commit
|
80
|
-
```
|
81
|
-
|
82
|
-
#### Push
|
83
|
-
|
84
|
-
```
|
85
|
-
git push origin my-feature-branch
|
86
|
-
```
|
87
|
-
|
88
|
-
#### Make a Pull Request
|
89
|
-
|
90
|
-
Go to https://github.com/contributor/bigcommerce-api-ruby and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
|
91
|
-
|
92
|
-
#### Rebase
|
93
|
-
|
94
|
-
If you've been working on a change for a while, rebase with upstream/master.
|
95
|
-
|
96
|
-
```
|
97
|
-
git fetch upstream
|
98
|
-
git rebase upstream/master
|
99
|
-
git push origin my-feature-branch -f
|
100
|
-
```
|
101
|
-
|
102
|
-
#### Update CHANGELOG Again
|
103
|
-
|
104
|
-
Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
|
105
|
-
|
106
|
-
```
|
107
|
-
* [#123](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/123): Added products resource - [@contributor](https://github.com/contributor).
|
108
|
-
```
|
109
|
-
|
110
|
-
Amend your previous commit and force push the changes.
|
111
|
-
|
112
|
-
```
|
113
|
-
git commit --amend
|
114
|
-
git push origin my-feature-branch -f
|
115
|
-
```
|
116
|
-
|
117
|
-
#### Check on Your Pull Request
|
118
|
-
|
119
|
-
Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
|
data/DEPENDENCIES.md
DELETED
@@ -1,7 +0,0 @@
|
|
1
|
-
### Bigcommerce 💙 Open Source
|
2
|
-
|
3
|
-
Many thanks to the contributors and authors of the following libraries!
|
4
|
-
|
5
|
-
- [Faraday](https://github.com/lostisland/faraday) Simple, but flexible HTTP client library, with support for multiple backends. - [MIT](https://github.com/lostisland/faraday/blob/master/LICENSE.md)
|
6
|
-
- [Faraday Middleware](https://github.com/lostisland/faraday_middleware) Various Faraday middlewares for Faraday-based API wrappers. - [MIT](https://github.com/lostisland/faraday_middleware/blob/master/LICENSE.md)
|
7
|
-
- [Hashie](https://github.com/intridea/hashie) Hashie is a collection of classes and mixins that make hashes more powerful. - [MIT](https://github.com/intridea/hashie/blob/master/LICENSE)
|
data/Gemfile
DELETED
data/Guardfile
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
guard 'rspec', all_on_start: false, cmd: 'bundle exec rspec' do
|
2
|
-
# Watch spec directory
|
3
|
-
watch(/^spec\/.+_spec\.rb/)
|
4
|
-
|
5
|
-
# Watch lib/*.rb
|
6
|
-
watch(/^lib\/(.+)\.rb/) do |m|
|
7
|
-
"spec/bigcommerce/#{m[1]}_spec.rb"
|
8
|
-
end
|
9
|
-
|
10
|
-
# Watch lib/bigcommerce/*.rb
|
11
|
-
watch(%r{^lib/bigcommerce/(.+).rb$}) do |m|
|
12
|
-
"spec/bigcommerce/unit/#{m[1]}_spec.rb"
|
13
|
-
end
|
14
|
-
|
15
|
-
# Watch lib/bigcommerce/(middleware|resources)/*.rb
|
16
|
-
watch(%r{^lib/bigcommerce/(middleware|resources)/(.+).rb$}) do |m|
|
17
|
-
"spec/bigcommerce/unit/#{m[1]}/#{m[2]}_spec.rb"
|
18
|
-
end
|
19
|
-
|
20
|
-
# Watch spec_helper
|
21
|
-
watch('spec/spec_helper.rb') { 'spec' }
|
22
|
-
end
|
data/LICENSE
DELETED
@@ -1,20 +0,0 @@
|
|
1
|
-
Copyright (C) Bigcommerce, 2015.
|
2
|
-
All rights reserved.
|
3
|
-
|
4
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
5
|
-
a copy of this software and associated documentation files (the "Software"),
|
6
|
-
to deal in the Software without restriction, including without limitation
|
7
|
-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
8
|
-
and/or sell copies of the Software, and to permit persons to whom the
|
9
|
-
Software is furnished to do so, subject to the following conditions:
|
10
|
-
|
11
|
-
The above copyright notice and this permission notice shall be included
|
12
|
-
in all copies or substantial portions of the Software.
|
13
|
-
|
14
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
16
|
-
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
17
|
-
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
18
|
-
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
19
|
-
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
|
20
|
-
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/RELEASING.md
DELETED
@@ -1,64 +0,0 @@
|
|
1
|
-
# Releasing Bigcommerce API Client
|
2
|
-
|
3
|
-
There're no particular rules about when to release the Bigcommerce API client. Release bug fixes frequently, features not so frequently, and breaking API changes rarely.
|
4
|
-
|
5
|
-
### Before A Release
|
6
|
-
|
7
|
-
Run tests, check that all tests succeed locally.
|
8
|
-
|
9
|
-
```sh
|
10
|
-
bundle install
|
11
|
-
bundle exec rake
|
12
|
-
```
|
13
|
-
|
14
|
-
This will ensure both style and that all the specs pass locally. Next, check that the last build succeeded in [Travis CI](https://travis-ci.org/bigcommerce/bigcommerce-api-ruby) for all supported platforms.
|
15
|
-
|
16
|
-
Increment the version, modify [lib/bigcommerce/version.rb](lib/bigcommerce/version.rb).
|
17
|
-
|
18
|
-
* Increment the third number (minor version) if the release has bug fixes and/or very minor features, only (eg. change `1.0.1` to `1.0.2`).
|
19
|
-
* Increment the second number (patch version) if the release contains major features or breaking API changes (eg. change `1.0.10` to `1.1.0`).
|
20
|
-
|
21
|
-
Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
|
22
|
-
|
23
|
-
```markdown
|
24
|
-
1.1.0 (4/13/2015)
|
25
|
-
=================
|
26
|
-
```
|
27
|
-
|
28
|
-
Commit your changes.
|
29
|
-
|
30
|
-
```sh
|
31
|
-
git add CHANGELOG.md lib/bigcommerce/version.rb
|
32
|
-
git commit -m "Preparing for release, 1.1.0."
|
33
|
-
git push origin master
|
34
|
-
```
|
35
|
-
|
36
|
-
### Release 🎉
|
37
|
-
|
38
|
-
```sh
|
39
|
-
$ rake release
|
40
|
-
|
41
|
-
bigcommerce 1.1.0 built to pkg/bigcommerce-1.1.0.gem.
|
42
|
-
Tagged v1.1.0.
|
43
|
-
Pushed git commits and tags.
|
44
|
-
Pushed bigcommerce 1.1.0 to rubygems.org.
|
45
|
-
```
|
46
|
-
|
47
|
-
### Prepare for the Next Version
|
48
|
-
|
49
|
-
Add the next release to [CHANGELOG.md](CHANGELOG.md).
|
50
|
-
|
51
|
-
```markdown
|
52
|
-
Next Release
|
53
|
-
============
|
54
|
-
|
55
|
-
* Your contribution here.
|
56
|
-
```
|
57
|
-
|
58
|
-
Commit your changes.
|
59
|
-
|
60
|
-
```sh
|
61
|
-
git add CHANGELOG.md README.md
|
62
|
-
git commit -m "Preparing for next release."
|
63
|
-
git push origin master
|
64
|
-
```
|
data/Rakefile
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
require 'rspec/core/rake_task'
|
2
|
-
require 'bundler/gem_tasks'
|
3
|
-
require 'bigcommerce'
|
4
|
-
|
5
|
-
RSpec::Core::RakeTask.new do |spec|
|
6
|
-
spec.pattern = 'spec/**/*_spec.rb'
|
7
|
-
spec.verbose = false
|
8
|
-
end
|
9
|
-
|
10
|
-
require 'rubocop/rake_task'
|
11
|
-
RuboCop::RakeTask.new(:rubocop)
|
12
|
-
|
13
|
-
task default: [:rubocop, :spec]
|
data/examples/README.md
DELETED
@@ -1,148 +0,0 @@
|
|
1
|
-
# Examples
|
2
|
-
In this directory you can find examples which you may find helpful to reference in development. If you have some useful snippets, please feel free to open a PR into the appropriate file(s).
|
3
|
-
|
4
|
-
#### Resource Reference
|
5
|
-
For reference on the individual resources and the schema of the objects, please visit [developer.bigcommerce.com](https://developer.bigcommerce.com).
|
6
|
-
|
7
|
-
## Configuration
|
8
|
-
#### [Private Apps](configuration/legacy_auth.rb)
|
9
|
-
Public apps (also known as Single-Click Apps) must use OAuth authentication.
|
10
|
-
|
11
|
-
#### [Public Apps](configuration/oauth.rb)
|
12
|
-
To develop a custom integration for one store, your app needs to use Basic Authentication.
|
13
|
-
|
14
|
-
## Content
|
15
|
-
#### [Blog Posts](content/blog_post.rb)
|
16
|
-
A content entry in the store’s blog
|
17
|
-
|
18
|
-
#### [Blog Tags](content/blog_tag.rb)
|
19
|
-
Index of tags used on the store’s blog.
|
20
|
-
|
21
|
-
#### [Redirects](content/redirect.rb)
|
22
|
-
A 301 redirect, mapping from a given URL path to another URL
|
23
|
-
|
24
|
-
## Customers
|
25
|
-
#### [Customers](customers/customer.rb)
|
26
|
-
Identity and account details for customers shopping on Bigcommerce stores
|
27
|
-
|
28
|
-
#### [Customer Addresses](customers/customer_address.rb)
|
29
|
-
Postal address belonging to a Customer
|
30
|
-
|
31
|
-
#### [Customer Groups](customers/customer_group.rb)
|
32
|
-
Grouping of customers who share the same level of access and discounts at a store
|
33
|
-
|
34
|
-
## Geography
|
35
|
-
#### [Countries](geography/country.rb)
|
36
|
-
A country or territory, identifiable by an ISO 3166 country code
|
37
|
-
|
38
|
-
#### [States](geography/state.rb)
|
39
|
-
A state or province, identifiable by an ISO 3166 subdivision code
|
40
|
-
|
41
|
-
## Marketing
|
42
|
-
#### [Coupons](marketing/coupon.rb)
|
43
|
-
Applies a category or product discount to an order for customers who enter a given code
|
44
|
-
|
45
|
-
## Orders
|
46
|
-
#### [Orders](orders/order.rb)
|
47
|
-
The order object contains a record of the purchase agreement between a shopper and a merchant.
|
48
|
-
|
49
|
-
#### [Order Coupons](orders/order_coupon.rb)
|
50
|
-
Coupon code applied to an order
|
51
|
-
|
52
|
-
#### [Order Messages](orders/order_message.rb)
|
53
|
-
Messages associated with an order.
|
54
|
-
|
55
|
-
#### [Order Products](orders/order_product.rb)
|
56
|
-
Product line items associated with an order.
|
57
|
-
|
58
|
-
#### [Order Shipping Addresses](orders/order_shipping_address.rb)
|
59
|
-
Shipping addresses associated with an order.
|
60
|
-
|
61
|
-
#### [Order Statuses](orders/order_status.rb)
|
62
|
-
Statuses that can be assigned to orders. Each status represents a state in the fulfilment workflow.
|
63
|
-
|
64
|
-
#### [Order Taxes](orders/order_tax.rb)
|
65
|
-
Taxes applied to an order.
|
66
|
-
|
67
|
-
#### [Shipments](orders/shipment.rb)
|
68
|
-
Shipping package consignments tracked from an order.
|
69
|
-
|
70
|
-
## Payments
|
71
|
-
#### [Payment Methods](payments/payment_methods.rb)
|
72
|
-
Enabled payment methods.
|
73
|
-
|
74
|
-
## Products
|
75
|
-
#### [Brands](products/brand.rb)
|
76
|
-
Brand facets for identifying and categorising products according to their manufacturer or company metonym.
|
77
|
-
|
78
|
-
#### [Bulk Pricing Rules](products/bulk_pricing_rule.rb)
|
79
|
-
Bulk pricing rules applied to a product.
|
80
|
-
|
81
|
-
#### [Categories](products/category.rb)
|
82
|
-
Index of hierarchical categories used to organise and group products.
|
83
|
-
|
84
|
-
#### [Configurable Fields ](products/configurable_field.rb)
|
85
|
-
Configurable fields associated with a product.
|
86
|
-
|
87
|
-
#### [Custom Fields](products/custom_field.rb)
|
88
|
-
Custom fields associated with a product.
|
89
|
-
|
90
|
-
#### [Google Product Search Mappings](products/google_product_search_mapping.rb)
|
91
|
-
Custom fields associated with a product.
|
92
|
-
|
93
|
-
#### [Options](products/option.rb)
|
94
|
-
Shared attributes that control value facets on a product.
|
95
|
-
|
96
|
-
#### [Option Sets](products/option_set.rb)
|
97
|
-
A reusable set of option facets that can be applied to products.
|
98
|
-
|
99
|
-
#### [Option Set Options](products/option_set_option.rb)
|
100
|
-
Options belonging to an option set.
|
101
|
-
|
102
|
-
#### [Option Values](products/option_value.rb)
|
103
|
-
Values that can be selected for an option.
|
104
|
-
|
105
|
-
#### [Products](products/product.rb)
|
106
|
-
Catalog of saleable items in the store.
|
107
|
-
|
108
|
-
#### [Product Images](products/product_image.rb)
|
109
|
-
Images associated with a product.
|
110
|
-
|
111
|
-
#### [Product Options](products/product_option.rb)
|
112
|
-
Options associated directly with a product.
|
113
|
-
|
114
|
-
#### [Product Reviews](products/product_review.rb)
|
115
|
-
Reviews associated to a product.
|
116
|
-
|
117
|
-
#### [Product Rules](products/product_rule.rb)
|
118
|
-
Rules that modify the default behaviour of products.
|
119
|
-
|
120
|
-
#### [Product Videos](products/product_video.rb)
|
121
|
-
Embedded videos displayed on product listings.
|
122
|
-
|
123
|
-
#### [SKUs](products/sku.rb)
|
124
|
-
Stock Keeping Unit identifiers associated with products.
|
125
|
-
|
126
|
-
## Shipping
|
127
|
-
#### [Shipping Methods](shipping/shipping_method.rb)
|
128
|
-
List of enabled shipping methods.
|
129
|
-
|
130
|
-
## Store
|
131
|
-
#### [Store Information](store/store_info.rb)
|
132
|
-
Metadata that describes the store.
|
133
|
-
|
134
|
-
## System
|
135
|
-
#### [Time](system/time.rb)
|
136
|
-
Timestamp ping to check the system status.
|
137
|
-
|
138
|
-
## Tax
|
139
|
-
#### [Tax Classes](tax/tax_class.rb)
|
140
|
-
Applies a category or product discount to an order for customers who enter a given code
|
141
|
-
|
142
|
-
## Webhooks
|
143
|
-
#### [Webhooks](webhooks/webhook.rb)
|
144
|
-
Applies a category or product discount to an order for customers who enter a given code
|
145
|
-
|
146
|
-
## Exception Handling
|
147
|
-
#### [Exceptions](exception_handling.rb)
|
148
|
-
All the errors we will throw with a convenient method to rescue the errors and take an action for each type
|