Skip to content

rs-pro/spree_client

BranchesTags

Repository files navigation

spree_client

SpreeClient - the Ruby gem for the Platform API

Spree Platform API

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://sparksolutions.co

Installation

Build a gem

To build the Ruby code into a gem:

gem build spree_client.gemspec

Then either install the gem locally:

gem install ./spree_client-1.0.0.gem

(for development, run gem install --dev ./spree_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'spree_client', '~> 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 'spree_client', :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:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'spree_client'

# Setup authorization
SpreeClient.configure do |config|
  # Configure Bearer authorization: bearer_auth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = SpreeClient::AddressesApi.new
opts = {
  page: 1, # Integer | 
  per_page: 50, # Integer | 
  include: 'user,country,state', # String | Select which associated resources you would like to fetch, see: <a href=\"https://jsonapi.org/format/#fetching-includes\">https://jsonapi.org/format/#fetching-includes</a>
  filter_user_id_eq: '1', # String | 
  filter_firstname_cont: 'John' # String | 
}

begin
  #Return a list of Addresses
  result = api_instance.addresses_list(opts)
  p result
rescue SpreeClient::ApiError => e
  puts "Exception when calling AddressesApi->addresses_list: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:4000

Class Method HTTP request Description
SpreeClient::AddressesApi addresses_list GET /api/v2/platform/addresses Return a list of Addresses
SpreeClient::AddressesApi create_address POST /api/v2/platform/addresses Create an Address
SpreeClient::AddressesApi delete_address DELETE /api/v2/platform/addresses/{id} Delete an Address
SpreeClient::AddressesApi show_address GET /api/v2/platform/addresses/{id} Return an Address
SpreeClient::AddressesApi update_address PATCH /api/v2/platform/addresses/{id} Update an Address
SpreeClient::AdjustmentsApi adjustments_list GET /api/v2/platform/adjustments Return a list of Adjustments
SpreeClient::AdjustmentsApi create_adjustment POST /api/v2/platform/adjustments Create an Adjustment
SpreeClient::AdjustmentsApi delete_adjustment DELETE /api/v2/platform/adjustments/{id} Delete an Adjustment
SpreeClient::AdjustmentsApi show_adjustment GET /api/v2/platform/adjustments/{id} Return an Adjustment
SpreeClient::AdjustmentsApi update_adjustment PATCH /api/v2/platform/adjustments/{id} Update an Adjustment
SpreeClient::CMSPagesApi cms_pages_list GET /api/v2/platform/cms_pages Return a list of CMS Pages
SpreeClient::CMSPagesApi create_cms_page POST /api/v2/platform/cms_pages Create a CMS Page
SpreeClient::CMSPagesApi delete_cms_page DELETE /api/v2/platform/cms_pages/{id} Delete a CMS Page
SpreeClient::CMSPagesApi show_cms_page GET /api/v2/platform/cms_pages/{id} Return a CMS Page
SpreeClient::CMSPagesApi update_cms_page PATCH /api/v2/platform/cms_pages/{id} Update a CMS Page
SpreeClient::CMSSectionsApi cms_sections_list GET /api/v2/platform/cms_sections Return a list of CMS Sections
SpreeClient::CMSSectionsApi create_cms_section POST /api/v2/platform/cms_sections Create a CMS Section
SpreeClient::CMSSectionsApi delete_cms_section DELETE /api/v2/platform/cms_sections/{id} Delete a CMS Section
SpreeClient::CMSSectionsApi show_cms_section GET /api/v2/platform/cms_sections/{id} Return a CMS Section
SpreeClient::CMSSectionsApi update_cms_section PATCH /api/v2/platform/cms_sections/{id} Update a CMS Section
SpreeClient::ClassificationsApi classifications_list GET /api/v2/platform/classifications Return a list of Classifications
SpreeClient::ClassificationsApi create_classification POST /api/v2/platform/classifications Create a Classification
SpreeClient::ClassificationsApi delete_classification DELETE /api/v2/platform/classifications/{id} Delete a Classification
SpreeClient::ClassificationsApi show_classification GET /api/v2/platform/classifications/{id} Return a Classification
SpreeClient::ClassificationsApi update_classification PATCH /api/v2/platform/classifications/{id} Update a Classification
SpreeClient::CountriesApi countries_list GET /api/v2/platform/countries Returns a list of Countries
SpreeClient::CountriesApi show_country GET /api/v2/platform/countries/{id} Returns a Country
SpreeClient::DataFeedsApi create_data_feed POST /api/v2/platform/data_feeds Create a Data Feed
SpreeClient::DataFeedsApi data_feeds_list GET /api/v2/platform/data_feeds Return a list of Data Feeds
SpreeClient::DataFeedsApi delete_data_feed DELETE /api/v2/platform/data_feeds/{id} Delete a Data Feed
SpreeClient::DataFeedsApi show_data_feed GET /api/v2/platform/data_feeds/{id} Return a Data Feed
SpreeClient::DataFeedsApi update_data_feed PATCH /api/v2/platform/data_feeds/{id} Update a Data Feed
SpreeClient::DigitalAssetsApi create_digital POST /api/v2/platform/digitals Create a Digital Asset
SpreeClient::DigitalAssetsApi delete_digital DELETE /api/v2/platform/digitals/{id} Delete a Digital Asset
SpreeClient::DigitalAssetsApi digitals_list GET /api/v2/platform/digitals Return a list of Digital Assets
SpreeClient::DigitalAssetsApi show_digital GET /api/v2/platform/digitals/{id} Return a Digital Asset
SpreeClient::DigitalAssetsApi update_digital PATCH /api/v2/platform/digitals/{id} Update a Digital Asset
SpreeClient::DigitalLinksApi create_digital_link POST /api/v2/platform/digital_links Create a Digital Link
SpreeClient::DigitalLinksApi delete_digital_link DELETE /api/v2/platform/digital_links/{id} Delete a Digital Link
SpreeClient::DigitalLinksApi digital_links_list GET /api/v2/platform/digital_links Return a list of Digital Links
SpreeClient::DigitalLinksApi reset_digital_link PATCH /api/v2/platform/digital_links/{id}/reset Reset a Digital Link
SpreeClient::DigitalLinksApi show_digital_link GET /api/v2/platform/digital_links/{id} Return a Digital Link
SpreeClient::DigitalLinksApi update_digital_link PATCH /api/v2/platform/digital_links/{id} Update a Digital Link
SpreeClient::LineItemsApi create_line_item POST /api/v2/platform/line_items Create a Line Item
SpreeClient::LineItemsApi delete_line_item DELETE /api/v2/platform/line_items/{id} Delete a Line Item
SpreeClient::LineItemsApi line_items_list GET /api/v2/platform/line_items Return a list of Line Items
SpreeClient::LineItemsApi show_line_item GET /api/v2/platform/line_items/{id} Return a Line Item
SpreeClient::LineItemsApi update_line_item PATCH /api/v2/platform/line_items/{id} Update a Line Item
SpreeClient::MenuItemsApi create_menu_item POST /api/v2/platform/menu_items Create a Menu Item
SpreeClient::MenuItemsApi delete_menu_item DELETE /api/v2/platform/menu_items/{id} Delete a Menu Item
SpreeClient::MenuItemsApi menu_items_list GET /api/v2/platform/menu_items Return a list of Menu Items
SpreeClient::MenuItemsApi reposition_menu_item PATCH /api/v2/platform/menu_items/{id}/reposition Reposition a Menu Item
SpreeClient::MenuItemsApi show_menu_item GET /api/v2/platform/menu_items/{id} Return a Menu Item
SpreeClient::MenuItemsApi update_menu_item PATCH /api/v2/platform/menu_items/{id} Update a Menu Item
SpreeClient::MenusApi create_menu POST /api/v2/platform/menus Create a Menu
SpreeClient::MenusApi delete_menu DELETE /api/v2/platform/menus/{id} Delete a Menu
SpreeClient::MenusApi menus_list GET /api/v2/platform/menus Return a list of Menus
SpreeClient::MenusApi show_menu GET /api/v2/platform/menus/{id} Return a Menu
SpreeClient::MenusApi update_menu PATCH /api/v2/platform/menus/{id} Update a Menu
SpreeClient::OptionTypesApi create_option_type POST /api/v2/platform/option_types Create an Option Type
SpreeClient::OptionTypesApi delete_option_type DELETE /api/v2/platform/option_types/{id} Delete an Option Type
SpreeClient::OptionTypesApi option_types_list GET /api/v2/platform/option_types Return a list of Option Types
SpreeClient::OptionTypesApi show_option_type GET /api/v2/platform/option_types/{id} Return an Option Type
SpreeClient::OptionTypesApi update_option_type PATCH /api/v2/platform/option_types/{id} Update an Option Type
SpreeClient::OptionValuesApi create_option_value POST /api/v2/platform/option_values Create an Option Value
SpreeClient::OptionValuesApi delete_option_value DELETE /api/v2/platform/option_values/{id} Delete an Option Value
SpreeClient::OptionValuesApi option_values_list GET /api/v2/platform/option_values Return a list of Option Values
SpreeClient::OptionValuesApi show_option_value GET /api/v2/platform/option_values/{id} Return an Option Value
SpreeClient::OptionValuesApi update_option_value PATCH /api/v2/platform/option_values/{id} Update an Option Value
SpreeClient::OrdersApi advance_order PATCH /api/v2/platform/orders/{id}/advance Advances an Order
SpreeClient::OrdersApi apply_coupon_code_order PATCH /api/v2/platform/orders/{id}/apply_coupon_code Apply Coupon Code for an Order
SpreeClient::OrdersApi approve_order PATCH /api/v2/platform/orders/{id}/approve Approves an Order
SpreeClient::OrdersApi cancel_order PATCH /api/v2/platform/orders/{id}/cancel Cancels an Order
SpreeClient::OrdersApi complete_order PATCH /api/v2/platform/orders/{id}/complete Completes an Order
SpreeClient::OrdersApi create_order POST /api/v2/platform/orders Creates an Order
SpreeClient::OrdersApi delete_order DELETE /api/v2/platform/orders/{id} Delete an Order
SpreeClient::OrdersApi empty_order PATCH /api/v2/platform/orders/{id}/empty Empties an Order
SpreeClient::OrdersApi next_order PATCH /api/v2/platform/orders/{id}/next Next an Order
SpreeClient::OrdersApi orders_list GET /api/v2/platform/orders Return a list of Orders
SpreeClient::OrdersApi show_order GET /api/v2/platform/orders/{id} Return an Order
SpreeClient::OrdersApi update_order PATCH /api/v2/platform/orders/{id} Update an Order
SpreeClient::OrdersApi use_store_credit_order PATCH /api/v2/platform/orders/{id}/use_store_credit Use Store Credit for an Order
SpreeClient::PaymentMethodsApi create_payment_method POST /api/v2/platform/payment_methods Create a Payment Method
SpreeClient::PaymentMethodsApi delete_payment_method DELETE /api/v2/platform/payment_methods/{id} Delete a Payment Method
SpreeClient::PaymentMethodsApi payment_methods_list GET /api/v2/platform/payment_methods Return a list of Payment Methods
SpreeClient::PaymentMethodsApi show_payment_method GET /api/v2/platform/payment_methods/{id} Return a Payment Method
SpreeClient::PaymentMethodsApi update_payment_method PATCH /api/v2/platform/payment_methods/{id} Update a Payment Method
SpreeClient::PaymentsApi delete_payment DELETE /api/v2/platform/payments/{id} Delete a Payment
SpreeClient::PaymentsApi payments_list GET /api/v2/platform/payments Return a list of Payments
SpreeClient::PaymentsApi show_payment GET /api/v2/platform/payments/{id} Return a Payment
SpreeClient::ProductsApi create_product POST /api/v2/platform/products Create a Product
SpreeClient::ProductsApi delete_product DELETE /api/v2/platform/products/{id} Delete a Product
SpreeClient::ProductsApi products_list GET /api/v2/platform/products Return a list of Products
SpreeClient::ProductsApi show_product GET /api/v2/platform/products/{id} Return a Product
SpreeClient::ProductsApi update_product PATCH /api/v2/platform/products/{id} Update a Product
SpreeClient::PromotionActionsApi create_promotion_action POST /api/v2/platform/promotion_actions Create a Promotion Action
SpreeClient::PromotionActionsApi delete_promotion_action DELETE /api/v2/platform/promotion_actions/{id} Delete a Promotion Action
SpreeClient::PromotionActionsApi promotion_actions_list GET /api/v2/platform/promotion_actions Return a list of Promotion Actions
SpreeClient::PromotionActionsApi show_promotion_action GET /api/v2/platform/promotion_actions/{id} Return a Promotion Action
SpreeClient::PromotionActionsApi update_promotion_action PATCH /api/v2/platform/promotion_actions/{id} Update a Promotion Action
SpreeClient::PromotionCategoriesApi create_promotion_category POST /api/v2/platform/promotion_categories Create a Promotion Category
SpreeClient::PromotionCategoriesApi delete_promotion_category DELETE /api/v2/platform/promotion_categories/{id} Delete a Promotion Category
SpreeClient::PromotionCategoriesApi promotion_categories_list GET /api/v2/platform/promotion_categories Return a list of Promotion Categories
SpreeClient::PromotionCategoriesApi show_promotion_category GET /api/v2/platform/promotion_categories/{id} Return a Promotion Category
SpreeClient::PromotionCategoriesApi update_promotion_category PATCH /api/v2/platform/promotion_categories/{id} Update a Promotion Category
SpreeClient::PromotionRulesApi create_promotion_rule POST /api/v2/platform/promotion_rules Create a Promotion Rule
SpreeClient::PromotionRulesApi delete_promotion_rule DELETE /api/v2/platform/promotion_rules/{id} Delete a Promotion Rule
SpreeClient::PromotionRulesApi promotion_rules_list GET /api/v2/platform/promotion_rules Return a list of Promotion Rules
SpreeClient::PromotionRulesApi show_promotion_rule GET /api/v2/platform/promotion_rules/{id} Return a Promotion Rule
SpreeClient::PromotionRulesApi update_promotion_rule PATCH /api/v2/platform/promotion_rules/{id} Update a Promotion Rule
SpreeClient::PromotionsApi create_promotion POST /api/v2/platform/promotions Create a Promotion
SpreeClient::PromotionsApi delete_promotion DELETE /api/v2/platform/promotions/{id} Delete a Promotion
SpreeClient::PromotionsApi promotions_list GET /api/v2/platform/promotions Return a list of Promotions
SpreeClient::PromotionsApi show_promotion GET /api/v2/platform/promotions/{id} Return a Promotion
SpreeClient::PromotionsApi update_promotion PATCH /api/v2/platform/promotions/{id} Update a Promotion
SpreeClient::RolesApi create_role POST /api/v2/platform/roles Create a Role
SpreeClient::RolesApi delete_role DELETE /api/v2/platform/roles/{id} Delete a Role
SpreeClient::RolesApi roles_list GET /api/v2/platform/roles Return a list of Roles
SpreeClient::RolesApi show_role GET /api/v2/platform/roles/{id} Return a Role
SpreeClient::RolesApi update_role PATCH /api/v2/platform/roles/{id} Update a Role
SpreeClient::ShipmentsApi add_item_shipment PATCH /api/v2/platform/shipments/{id}/add_item Adds item (Variant) to an existing Shipment
SpreeClient::ShipmentsApi cancel_shipment PATCH /api/v2/platform/shipments/{id}/cancel Cancels the Shipment
SpreeClient::ShipmentsApi create_shipment POST /api/v2/platform/shipments Create a Shipment
SpreeClient::ShipmentsApi delete_shipment DELETE /api/v2/platform/shipments/{id} Delete a Shipment
SpreeClient::ShipmentsApi pend_shipment PATCH /api/v2/platform/shipments/{id}/pend Moves Shipment back to pending state
SpreeClient::ShipmentsApi ready_shipment PATCH /api/v2/platform/shipments/{id}/ready Mark Shipment as ready to be shipped
SpreeClient::ShipmentsApi remove_item_shipment PATCH /api/v2/platform/shipments/{id}/remove_item Removes item (Variant) from Shipment
SpreeClient::ShipmentsApi resume_shipment PATCH /api/v2/platform/shipments/{id}/resume Resumes the Shipment
SpreeClient::ShipmentsApi ship_shipment PATCH /api/v2/platform/shipments/{id}/ship Mark Shipment as shipped
SpreeClient::ShipmentsApi shipments_list GET /api/v2/platform/shipments Return a list of Shipments
SpreeClient::ShipmentsApi show_shipment GET /api/v2/platform/shipments/{id} Return a Shipment
SpreeClient::ShipmentsApi update_shipment PATCH /api/v2/platform/shipments/{id} Update a Shipment
SpreeClient::ShippingCategoriesApi create_shipping_category POST /api/v2/platform/shipping_categories Create a Shipping Category
SpreeClient::ShippingCategoriesApi delete_shipping_category DELETE /api/v2/platform/shipping_categories/{id} Delete a Shipping Category
SpreeClient::ShippingCategoriesApi shipping_categories_list GET /api/v2/platform/shipping_categories Return a list of Shipping Categories
SpreeClient::ShippingCategoriesApi show_shipping_category GET /api/v2/platform/shipping_categories/{id} Return a Shipping Category
SpreeClient::ShippingCategoriesApi update_shipping_category PATCH /api/v2/platform/shipping_categories/{id} Update a Shipping Category
SpreeClient::ShippingMethodsApi create_shipping_method POST /api/v2/platform/shipping_methods Create a Shipping Method
SpreeClient::ShippingMethodsApi delete_shipping_method DELETE /api/v2/platform/shipping_methods/{id} Delete a Shipping Method
SpreeClient::ShippingMethodsApi shipping_methods_list GET /api/v2/platform/shipping_methods Return a list of Shipping Methods
SpreeClient::ShippingMethodsApi show_shipping_method GET /api/v2/platform/shipping_methods/{id} Return a Shipping Method
SpreeClient::ShippingMethodsApi update_shipping_method PATCH /api/v2/platform/shipping_methods/{id} Update a Shipping Method
SpreeClient::StatesApi show_state GET /api/v2/platform/states/{id} Returns a State
SpreeClient::StatesApi states_list GET /api/v2/platform/states Returns a list of States
SpreeClient::StockItemsApi create_stock_item POST /api/v2/platform/stock_items Create a Stock Item
SpreeClient::StockItemsApi delete_stock_item DELETE /api/v2/platform/stock_items/{id} Delete a Stock Item
SpreeClient::StockItemsApi show_stock_item GET /api/v2/platform/stock_items/{id} Return a Stock Item
SpreeClient::StockItemsApi stock_items_list GET /api/v2/platform/stock_items Return a list of Stock Items
SpreeClient::StockItemsApi update_stock_item PATCH /api/v2/platform/stock_items/{id} Update a Stock Item
SpreeClient::StockLocationsApi create_stock_location POST /api/v2/platform/stock_locations Create a Stock Location
SpreeClient::StockLocationsApi delete_stock_location DELETE /api/v2/platform/stock_locations/{id} Delete a Stock Location
SpreeClient::StockLocationsApi show_stock_location GET /api/v2/platform/stock_locations/{id} Return a Stock Location
SpreeClient::StockLocationsApi stock_locations_list GET /api/v2/platform/stock_locations Return a list of Stock Locations
SpreeClient::StockLocationsApi update_stock_location PATCH /api/v2/platform/stock_locations/{id} Update a Stock Location
SpreeClient::StoreCreditCategoriesApi create_store_credit_category POST /api/v2/platform/store_credit_categories Create a Store Credit Category
SpreeClient::StoreCreditCategoriesApi delete_store_credit_category DELETE /api/v2/platform/store_credit_categories/{id} Delete a Store Credit Category
SpreeClient::StoreCreditCategoriesApi show_store_credit_category GET /api/v2/platform/store_credit_categories/{id} Return a Store Credit Category
SpreeClient::StoreCreditCategoriesApi store_credit_categories_list GET /api/v2/platform/store_credit_categories Return a list of Store Credit Categories
SpreeClient::StoreCreditCategoriesApi update_store_credit_category PATCH /api/v2/platform/store_credit_categories/{id} Update a Store Credit Category
SpreeClient::StoreCreditTypesApi create_store_credit_type POST /api/v2/platform/store_credit_types Create a Store Credit Type
SpreeClient::StoreCreditTypesApi delete_store_credit_type DELETE /api/v2/platform/store_credit_types/{id} Delete a Store Credit Type
SpreeClient::StoreCreditTypesApi show_store_credit_type GET /api/v2/platform/store_credit_types/{id} Return a Store Credit Type
SpreeClient::StoreCreditTypesApi store_credit_types_list GET /api/v2/platform/store_credit_types Return a list of Store Credit Types
SpreeClient::StoreCreditTypesApi update_store_credit_type PATCH /api/v2/platform/store_credit_types/{id} Update a Store Credit Type
SpreeClient::StoreCreditsApi create_store_credit POST /api/v2/platform/store_credits Create a Store Credit
SpreeClient::StoreCreditsApi delete_store_credit DELETE /api/v2/platform/store_credits/{id} Delete a Store Credit
SpreeClient::StoreCreditsApi show_store_credit GET /api/v2/platform/store_credits/{id} Return a Store Credit
SpreeClient::StoreCreditsApi store_credits_list GET /api/v2/platform/store_credits Return a list of Store Credits
SpreeClient::StoreCreditsApi update_store_credit PATCH /api/v2/platform/store_credits/{id} Update a Store Credit
SpreeClient::TaxCategoriesApi create_tax_category POST /api/v2/platform/tax_categories Create a Tax Category
SpreeClient::TaxCategoriesApi delete_tax_category DELETE /api/v2/platform/tax_categories/{id} Delete a Tax Category
SpreeClient::TaxCategoriesApi show_tax_category GET /api/v2/platform/tax_categories/{id} Return a Tax Category
SpreeClient::TaxCategoriesApi tax_categories_list GET /api/v2/platform/tax_categories Return a list of Tax Categories
SpreeClient::TaxCategoriesApi update_tax_category PATCH /api/v2/platform/tax_categories/{id} Update a Tax Category
SpreeClient::TaxRatesApi create_tax_rate POST /api/v2/platform/tax_rates Create a Tax Rate
SpreeClient::TaxRatesApi delete_tax_rate DELETE /api/v2/platform/tax_rates/{id} Delete a Tax Rate
SpreeClient::TaxRatesApi show_tax_rate GET /api/v2/platform/tax_rates/{id} Return a Tax Rate
SpreeClient::TaxRatesApi tax_rates_list GET /api/v2/platform/tax_rates Return a list of Tax Rates
SpreeClient::TaxRatesApi update_tax_rate PATCH /api/v2/platform/tax_rates/{id} Update a Tax Rate
SpreeClient::TaxonomiesApi create_taxonomy POST /api/v2/platform/taxonomies Create a Taxonomy
SpreeClient::TaxonomiesApi delete_taxonomy DELETE /api/v2/platform/taxonomies/{id} Delete a Taxonomy
SpreeClient::TaxonomiesApi show_taxonomy GET /api/v2/platform/taxonomies/{id} Return a Taxonomy
SpreeClient::TaxonomiesApi taxonomies_list GET /api/v2/platform/taxonomies Return a list of Taxonomies
SpreeClient::TaxonomiesApi update_taxonomy PATCH /api/v2/platform/taxonomies/{id} Update a Taxonomy
SpreeClient::TaxonsApi create_taxon POST /api/v2/platform/taxons Create a Taxon
SpreeClient::TaxonsApi delete_taxon DELETE /api/v2/platform/taxons/{id} Delete a Taxon
SpreeClient::TaxonsApi reposition_taxon PATCH /api/v2/platform/taxons/{id}/reposition Reposition a Taxon
SpreeClient::TaxonsApi show_taxon GET /api/v2/platform/taxons/{id} Return a Taxon
SpreeClient::TaxonsApi taxons_list GET /api/v2/platform/taxons Return a list of Taxons
SpreeClient::TaxonsApi update_taxon PATCH /api/v2/platform/taxons/{id} Update a Taxon
SpreeClient::UsersApi create_user POST /api/v2/platform/users Create a User
SpreeClient::UsersApi delete_user DELETE /api/v2/platform/users/{id} Delete a User
SpreeClient::UsersApi show_user GET /api/v2/platform/users/{id} Return a User
SpreeClient::UsersApi update_user PATCH /api/v2/platform/users/{id} Update a User
SpreeClient::UsersApi users_list GET /api/v2/platform/users Return a list of Users
SpreeClient::VariantsApi delete_variant DELETE /api/v2/platform/variants/{id} Delete a Variant
SpreeClient::VariantsApi show_variant GET /api/v2/platform/variants/{id} Return a Variant
SpreeClient::VariantsApi variants_list GET /api/v2/platform/variants Return a list of Variants
SpreeClient::WebhookEventsApi webhook_events_list GET /api/v2/platform/webhooks/events Return a list of Webhook Events
SpreeClient::WebhookSubscribersApi create_webhook_subscriber POST /api/v2/platform/webhooks/subscribers Create a Webhook Subscriber
SpreeClient::WebhookSubscribersApi delete_webhook_subscriber DELETE /api/v2/platform/webhooks/subscribers/{id} Delete a Webhook Subscriber
SpreeClient::WebhookSubscribersApi show_webhook_subscriber GET /api/v2/platform/webhooks/subscribers/{id} Return a Webhook Subscriber
SpreeClient::WebhookSubscribersApi update_webhook_subscriber PATCH /api/v2/platform/webhooks/subscribers/{id} Update a Webhook Subscriber
SpreeClient::WebhookSubscribersApi webhook_subscribers_list GET /api/v2/platform/webhooks/subscribers Return a list of Webhook Subscribers
SpreeClient::WishedItemsApi create_wished_item POST /api/v2/platform/wished_items Create a Wished Item
SpreeClient::WishedItemsApi delete_wished_item DELETE /api/v2/platform/wished_items/{id} Delete a Wished Item
SpreeClient::WishedItemsApi show_wished_item GET /api/v2/platform/wished_items/{id} Return a Wished Item
SpreeClient::WishedItemsApi update_wished_item PATCH /api/v2/platform/wished_items/{id} Update a Wished Item
SpreeClient::WishedItemsApi wished_items_list GET /api/v2/platform/wished_items Return a list of Wished Items
SpreeClient::WishlistsApi create_wishlist POST /api/v2/platform/wishlists Create a Wishlist
SpreeClient::WishlistsApi delete_wishlist DELETE /api/v2/platform/wishlists/{id} Delete a Wishlist
SpreeClient::WishlistsApi show_wishlist GET /api/v2/platform/wishlists/{id} Return a Wishlist
SpreeClient::WishlistsApi update_wishlist PATCH /api/v2/platform/wishlists/{id} Update a Wishlist
SpreeClient::WishlistsApi wishlists_list GET /api/v2/platform/wishlists Return a list of Wishlists
SpreeClient::ZonesApi create_zone POST /api/v2/platform/zones Create a Zone
SpreeClient::ZonesApi delete_zone DELETE /api/v2/platform/zones/{id} Delete a Zone
SpreeClient::ZonesApi show_zone GET /api/v2/platform/zones/{id} Return a Zone
SpreeClient::ZonesApi update_zone PATCH /api/v2/platform/zones/{id} Update a Zone
SpreeClient::ZonesApi zones_list GET /api/v2/platform/zones Return a list of Zones

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearer_auth

  • Type: Bearer authentication

About

Spree Platform API client

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages