Skip to content

api2cart/ruby-sdk

BranchesTags

Repository files navigation

openapi_client

OpenapiClient - the Ruby gem for the API2Cart OpenAPI

API2Cart

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.1
  • Package version: 1.0.0
  • Generator version: 7.11.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_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 'openapi_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 'openapi_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 'openapi_client'

# Setup authorization
OpenapiClient.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end

api_instance = OpenapiClient::AccountApi.new
account_cart_add = OpenapiClient::AccountCartAdd.new({cart_id: '3DCart'}) # AccountCartAdd | 

begin
  #account.cart.add
  result = api_instance.account_cart_add(account_cart_add)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling AccountApi->account_cart_add: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.api2cart.local.com/v1.1

Class Method HTTP request Description
OpenapiClient::AccountApi account_cart_add POST /account.cart.add.json account.cart.add
OpenapiClient::AccountApi account_cart_list GET /account.cart.list.json account.cart.list
OpenapiClient::AccountApi account_config_update PUT /account.config.update.json account.config.update
OpenapiClient::AccountApi account_failed_webhooks GET /account.failed_webhooks.json account.failed_webhooks
OpenapiClient::AccountApi account_supported_platforms GET /account.supported_platforms.json account.supported_platforms
OpenapiClient::AttributeApi attribute_add POST /attribute.add.json attribute.add
OpenapiClient::AttributeApi attribute_assign_group POST /attribute.assign.group.json attribute.assign.group
OpenapiClient::AttributeApi attribute_assign_set POST /attribute.assign.set.json attribute.assign.set
OpenapiClient::AttributeApi attribute_attributeset_list GET /attribute.attributeset.list.json attribute.attributeset.list
OpenapiClient::AttributeApi attribute_count GET /attribute.count.json attribute.count
OpenapiClient::AttributeApi attribute_delete DELETE /attribute.delete.json attribute.delete
OpenapiClient::AttributeApi attribute_group_list GET /attribute.group.list.json attribute.group.list
OpenapiClient::AttributeApi attribute_info GET /attribute.info.json attribute.info
OpenapiClient::AttributeApi attribute_list GET /attribute.list.json attribute.list
OpenapiClient::AttributeApi attribute_type_list GET /attribute.type.list.json attribute.type.list
OpenapiClient::AttributeApi attribute_unassign_group POST /attribute.unassign.group.json attribute.unassign.group
OpenapiClient::AttributeApi attribute_unassign_set POST /attribute.unassign.set.json attribute.unassign.set
OpenapiClient::AttributeApi attribute_update PUT /attribute.update.json attribute.update
OpenapiClient::AttributeApi attribute_value_add POST /attribute.value.add.json attribute.value.add
OpenapiClient::AttributeApi attribute_value_delete DELETE /attribute.value.delete.json attribute.value.delete
OpenapiClient::AttributeApi attribute_value_update PUT /attribute.value.update.json attribute.value.update
OpenapiClient::BasketApi basket_info GET /basket.info.json basket.info
OpenapiClient::BasketApi basket_item_add POST /basket.item.add.json basket.item.add
OpenapiClient::BasketApi basket_live_shipping_service_create POST /basket.live_shipping_service.create.json basket.live_shipping_service.create
OpenapiClient::BasketApi basket_live_shipping_service_delete DELETE /basket.live_shipping_service.delete.json basket.live_shipping_service.delete
OpenapiClient::BasketApi basket_live_shipping_service_list GET /basket.live_shipping_service.list.json basket.live_shipping_service.list
OpenapiClient::BatchApi batch_job_list GET /batch.job.list.json batch.job.list
OpenapiClient::BatchApi batch_job_result GET /batch.job.result.json batch.job.result
OpenapiClient::BridgeApi bridge_delete POST /bridge.delete.json bridge.delete
OpenapiClient::BridgeApi bridge_download GET /bridge.download.file bridge.download
OpenapiClient::BridgeApi bridge_update POST /bridge.update.json bridge.update
OpenapiClient::CartApi cart_catalog_price_rules_count GET /cart.catalog_price_rules.count.json cart.catalog_price_rules.count
OpenapiClient::CartApi cart_catalog_price_rules_list GET /cart.catalog_price_rules.list.json cart.catalog_price_rules.list
OpenapiClient::CartApi cart_coupon_add POST /cart.coupon.add.json cart.coupon.add
OpenapiClient::CartApi cart_coupon_condition_add POST /cart.coupon.condition.add.json cart.coupon.condition.add
OpenapiClient::CartApi cart_coupon_count GET /cart.coupon.count.json cart.coupon.count
OpenapiClient::CartApi cart_coupon_delete DELETE /cart.coupon.delete.json cart.coupon.delete
OpenapiClient::CartApi cart_coupon_list GET /cart.coupon.list.json cart.coupon.list
OpenapiClient::CartApi cart_delete DELETE /cart.delete.json cart.delete
OpenapiClient::CartApi cart_giftcard_add POST /cart.giftcard.add.json cart.giftcard.add
OpenapiClient::CartApi cart_giftcard_count GET /cart.giftcard.count.json cart.giftcard.count
OpenapiClient::CartApi cart_giftcard_delete DELETE /cart.giftcard.delete.json cart.giftcard.delete
OpenapiClient::CartApi cart_giftcard_list GET /cart.giftcard.list.json cart.giftcard.list
OpenapiClient::CartApi cart_info GET /cart.info.json cart.info
OpenapiClient::CartApi cart_meta_data_list GET /cart.meta_data.list.json cart.meta_data.list
OpenapiClient::CartApi cart_meta_data_set POST /cart.meta_data.set.json cart.meta_data.set
OpenapiClient::CartApi cart_meta_data_unset DELETE /cart.meta_data.unset.json cart.meta_data.unset
OpenapiClient::CartApi cart_methods GET /cart.methods.json cart.methods
OpenapiClient::CartApi cart_plugin_list GET /cart.plugin.list.json cart.plugin.list
OpenapiClient::CartApi cart_script_add POST /cart.script.add.json cart.script.add
OpenapiClient::CartApi cart_script_delete DELETE /cart.script.delete.json cart.script.delete
OpenapiClient::CartApi cart_script_list GET /cart.script.list.json cart.script.list
OpenapiClient::CartApi cart_shipping_zones_list GET /cart.shipping_zones.list.json cart.shipping_zones.list
OpenapiClient::CartApi cart_validate GET /cart.validate.json cart.validate
OpenapiClient::CategoryApi category_add POST /category.add.json category.add
OpenapiClient::CategoryApi category_add_batch POST /category.add.batch.json category.add.batch
OpenapiClient::CategoryApi category_assign POST /category.assign.json category.assign
OpenapiClient::CategoryApi category_count GET /category.count.json category.count
OpenapiClient::CategoryApi category_delete DELETE /category.delete.json category.delete
OpenapiClient::CategoryApi category_find GET /category.find.json category.find
OpenapiClient::CategoryApi category_image_add POST /category.image.add.json category.image.add
OpenapiClient::CategoryApi category_image_delete DELETE /category.image.delete.json category.image.delete
OpenapiClient::CategoryApi category_info GET /category.info.json category.info
OpenapiClient::CategoryApi category_list GET /category.list.json category.list
OpenapiClient::CategoryApi category_unassign POST /category.unassign.json category.unassign
OpenapiClient::CategoryApi category_update PUT /category.update.json category.update
OpenapiClient::CustomerApi customer_add POST /customer.add.json customer.add
OpenapiClient::CustomerApi customer_address_add POST /customer.address.add.json customer.address.add
OpenapiClient::CustomerApi customer_attribute_list GET /customer.attribute.list.json customer.attribute.list
OpenapiClient::CustomerApi customer_count GET /customer.count.json customer.count
OpenapiClient::CustomerApi customer_delete DELETE /customer.delete.json customer.delete
OpenapiClient::CustomerApi customer_find GET /customer.find.json customer.find
OpenapiClient::CustomerApi customer_group_add POST /customer.group.add.json customer.group.add
OpenapiClient::CustomerApi customer_group_list GET /customer.group.list.json customer.group.list
OpenapiClient::CustomerApi customer_info GET /customer.info.json customer.info
OpenapiClient::CustomerApi customer_list GET /customer.list.json customer.list
OpenapiClient::CustomerApi customer_update PUT /customer.update.json customer.update
OpenapiClient::CustomerApi customer_wishlist_list GET /customer.wishlist.list.json customer.wishlist.list
OpenapiClient::MarketplaceApi marketplace_product_find GET /marketplace.product.find.json marketplace.product.find
OpenapiClient::OrderApi order_abandoned_list GET /order.abandoned.list.json order.abandoned.list
OpenapiClient::OrderApi order_add POST /order.add.json order.add
OpenapiClient::OrderApi order_calculate POST /order.calculate.json order.calculate
OpenapiClient::OrderApi order_count GET /order.count.json order.count
OpenapiClient::OrderApi order_financial_status_list GET /order.financial_status.list.json order.financial_status.list
OpenapiClient::OrderApi order_fulfillment_status_list GET /order.fulfillment_status.list.json order.fulfillment_status.list
OpenapiClient::OrderApi order_info GET /order.info.json order.info
OpenapiClient::OrderApi order_list GET /order.list.json order.list
OpenapiClient::OrderApi order_preestimate_shipping_list POST /order.preestimate_shipping.list.json order.preestimate_shipping.list
OpenapiClient::OrderApi order_refund_add POST /order.refund.add.json order.refund.add
OpenapiClient::OrderApi order_return_add POST /order.return.add.json order.return.add
OpenapiClient::OrderApi order_return_delete DELETE /order.return.delete.json order.return.delete
OpenapiClient::OrderApi order_return_update PUT /order.return.update.json order.return.update
OpenapiClient::OrderApi order_shipment_add POST /order.shipment.add.json order.shipment.add
OpenapiClient::OrderApi order_shipment_add_batch POST /order.shipment.add.batch.json order.shipment.add.batch
OpenapiClient::OrderApi order_shipment_delete DELETE /order.shipment.delete.json order.shipment.delete
OpenapiClient::OrderApi order_shipment_info GET /order.shipment.info.json order.shipment.info
OpenapiClient::OrderApi order_shipment_list GET /order.shipment.list.json order.shipment.list
OpenapiClient::OrderApi order_shipment_tracking_add POST /order.shipment.tracking.add.json order.shipment.tracking.add
OpenapiClient::OrderApi order_shipment_update PUT /order.shipment.update.json order.shipment.update
OpenapiClient::OrderApi order_status_list GET /order.status.list.json order.status.list
OpenapiClient::OrderApi order_transaction_list GET /order.transaction.list.json order.transaction.list
OpenapiClient::OrderApi order_update PUT /order.update.json order.update
OpenapiClient::ProductApi product_add POST /product.add.json product.add
OpenapiClient::ProductApi product_add_batch POST /product.add.batch.json product.add.batch
OpenapiClient::ProductApi product_attribute_list GET /product.attribute.list.json product.attribute.list
OpenapiClient::ProductApi product_attribute_value_set POST /product.attribute.value.set.json product.attribute.value.set
OpenapiClient::ProductApi product_attribute_value_unset POST /product.attribute.value.unset.json product.attribute.value.unset
OpenapiClient::ProductApi product_brand_list GET /product.brand.list.json product.brand.list
OpenapiClient::ProductApi product_child_item_find GET /product.child_item.find.json product.child_item.find
OpenapiClient::ProductApi product_child_item_info GET /product.child_item.info.json product.child_item.info
OpenapiClient::ProductApi product_child_item_list GET /product.child_item.list.json product.child_item.list
OpenapiClient::ProductApi product_count GET /product.count.json product.count
OpenapiClient::ProductApi product_currency_add POST /product.currency.add.json product.currency.add
OpenapiClient::ProductApi product_currency_list GET /product.currency.list.json product.currency.list
OpenapiClient::ProductApi product_delete DELETE /product.delete.json product.delete
OpenapiClient::ProductApi product_delete_batch POST /product.delete.batch.json product.delete.batch
OpenapiClient::ProductApi product_find GET /product.find.json product.find
OpenapiClient::ProductApi product_image_add POST /product.image.add.json product.image.add
OpenapiClient::ProductApi product_image_delete DELETE /product.image.delete.json product.image.delete
OpenapiClient::ProductApi product_image_update PUT /product.image.update.json product.image.update
OpenapiClient::ProductApi product_info GET /product.info.json product.info
OpenapiClient::ProductApi product_list GET /product.list.json product.list
OpenapiClient::ProductApi product_manufacturer_add POST /product.manufacturer.add.json product.manufacturer.add
OpenapiClient::ProductApi product_option_add POST /product.option.add.json product.option.add
OpenapiClient::ProductApi product_option_assign POST /product.option.assign.json product.option.assign
OpenapiClient::ProductApi product_option_delete DELETE /product.option.delete.json product.option.delete
OpenapiClient::ProductApi product_option_list GET /product.option.list.json product.option.list
OpenapiClient::ProductApi product_option_value_add POST /product.option.value.add.json product.option.value.add
OpenapiClient::ProductApi product_option_value_assign POST /product.option.value.assign.json product.option.value.assign
OpenapiClient::ProductApi product_option_value_delete DELETE /product.option.value.delete.json product.option.value.delete
OpenapiClient::ProductApi product_option_value_update PUT /product.option.value.update.json product.option.value.update
OpenapiClient::ProductApi product_price_add POST /product.price.add.json product.price.add
OpenapiClient::ProductApi product_price_delete DELETE /product.price.delete.json product.price.delete
OpenapiClient::ProductApi product_price_update PUT /product.price.update.json product.price.update
OpenapiClient::ProductApi product_review_list GET /product.review.list.json product.review.list
OpenapiClient::ProductApi product_store_assign POST /product.store.assign.json product.store.assign
OpenapiClient::ProductApi product_tax_add POST /product.tax.add.json product.tax.add
OpenapiClient::ProductApi product_update PUT /product.update.json product.update
OpenapiClient::ProductApi product_update_batch POST /product.update.batch.json product.update.batch
OpenapiClient::ProductApi product_variant_add POST /product.variant.add.json product.variant.add
OpenapiClient::ProductApi product_variant_add_batch POST /product.variant.add.batch.json product.variant.add.batch
OpenapiClient::ProductApi product_variant_delete DELETE /product.variant.delete.json product.variant.delete
OpenapiClient::ProductApi product_variant_delete_batch POST /product.variant.delete.batch.json product.variant.delete.batch
OpenapiClient::ProductApi product_variant_image_add POST /product.variant.image.add.json product.variant.image.add
OpenapiClient::ProductApi product_variant_image_delete DELETE /product.variant.image.delete.json product.variant.image.delete
OpenapiClient::ProductApi product_variant_price_add POST /product.variant.price.add.json product.variant.price.add
OpenapiClient::ProductApi product_variant_price_delete DELETE /product.variant.price.delete.json product.variant.price.delete
OpenapiClient::ProductApi product_variant_price_update PUT /product.variant.price.update.json product.variant.price.update
OpenapiClient::ProductApi product_variant_update PUT /product.variant.update.json product.variant.update
OpenapiClient::ProductApi product_variant_update_batch POST /product.variant.update.batch.json product.variant.update.batch
OpenapiClient::ReturnApi return_action_list GET /return.action.list.json return.action.list
OpenapiClient::ReturnApi return_count GET /return.count.json return.count
OpenapiClient::ReturnApi return_info GET /return.info.json return.info
OpenapiClient::ReturnApi return_list GET /return.list.json return.list
OpenapiClient::ReturnApi return_reason_list GET /return.reason.list.json return.reason.list
OpenapiClient::ReturnApi return_status_list GET /return.status.list.json return.status.list
OpenapiClient::SubscriberApi subscriber_list GET /subscriber.list.json subscriber.list
OpenapiClient::TaxApi tax_class_info GET /tax.class.info.json tax.class.info
OpenapiClient::TaxApi tax_class_list GET /tax.class.list.json tax.class.list
OpenapiClient::WebhookApi webhook_count GET /webhook.count.json webhook.count
OpenapiClient::WebhookApi webhook_create POST /webhook.create.json webhook.create
OpenapiClient::WebhookApi webhook_delete DELETE /webhook.delete.json webhook.delete
OpenapiClient::WebhookApi webhook_events GET /webhook.events.json webhook.events
OpenapiClient::WebhookApi webhook_list GET /webhook.list.json webhook.list
OpenapiClient::WebhookApi webhook_update PUT /webhook.update.json webhook.update

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

StoreKeyAuth

  • Type: API key
  • API key parameter name: x-store-key
  • Location: HTTP header

About

api2cart-ruby-sdk.vercel.app

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages