Module: OrderCloud

Defined in:
lib/order_cloud/version.rb,
lib/order_cloud.rb,
lib/order_cloud/api_auth.rb,
lib/order_cloud/api_error.rb,
lib/order_cloud/api/me_api.rb,
lib/order_cloud/api_client.rb,
lib/order_cloud/models/file.rb,
lib/order_cloud/models/meta.rb,
lib/order_cloud/models/spec.rb,
lib/order_cloud/models/user.rb,
lib/order_cloud/api/file_api.rb,
lib/order_cloud/api/spec_api.rb,
lib/order_cloud/api/user_api.rb,
lib/order_cloud/models/buyer.rb,
lib/order_cloud/models/order.rb,
lib/order_cloud/api/buyer_api.rb,
lib/order_cloud/api/order_api.rb,
lib/order_cloud/configuration.rb,
lib/order_cloud/models/address.rb,
lib/order_cloud/models/payment.rb,
lib/order_cloud/models/product.rb,
lib/order_cloud/models/variant.rb,
lib/order_cloud/api/address_api.rb,
lib/order_cloud/api/payment_api.rb,
lib/order_cloud/api/product_api.rb,
lib/order_cloud/models/category.rb,
lib/order_cloud/models/shipment.rb,
lib/order_cloud/models/web_hook.rb,
lib/order_cloud/models/xp_index.rb,
lib/order_cloud/api/category_api.rb,
lib/order_cloud/api/shipment_api.rb,
lib/order_cloud/models/base_spec.rb,
lib/order_cloud/models/inventory.rb,
lib/order_cloud/models/line_item.rb,
lib/order_cloud/models/list_file.rb,
lib/order_cloud/models/list_spec.rb,
lib/order_cloud/models/list_user.rb,
lib/order_cloud/models/promotion.rb,
lib/order_cloud/api/line_item_api.rb,
lib/order_cloud/api/promotion_api.rb,
lib/order_cloud/models/buyer_spec.rb,
lib/order_cloud/models/list_buyer.rb,
lib/order_cloud/models/list_order.rb,
lib/order_cloud/models/user_group.rb,
lib/order_cloud/api/admin_user_api.rb,
lib/order_cloud/api/user_group_api.rb,
lib/order_cloud/models/cost_center.rb,
lib/order_cloud/models/credit_card.rb,
lib/order_cloud/models/price_break.rb,
lib/order_cloud/models/spec_option.rb,
lib/order_cloud/api/cost_center_api.rb,
lib/order_cloud/api/credit_card_api.rb,
lib/order_cloud/models/access_token.rb,
lib/order_cloud/models/list_address.rb,
lib/order_cloud/models/list_payment.rb,
lib/order_cloud/models/list_product.rb,
lib/order_cloud/models/list_variant.rb,
lib/order_cloud/models/admin_company.rb,
lib/order_cloud/models/approval_rule.rb,
lib/order_cloud/models/buyer_address.rb,
lib/order_cloud/models/buyer_product.rb,
lib/order_cloud/models/list_category.rb,
lib/order_cloud/models/list_shipment.rb,
lib/order_cloud/models/list_web_hook.rb,
lib/order_cloud/models/list_xp_index.rb,
lib/order_cloud/models/ping_response.rb,
lib/order_cloud/models/shipment_item.rb,
lib/order_cloud/api/admin_address_api.rb,
lib/order_cloud/api/approval_rule_api.rb,
lib/order_cloud/models/email_template.rb,
lib/order_cloud/models/line_item_spec.rb,
lib/order_cloud/models/list_inventory.rb,
lib/order_cloud/models/list_line_item.rb,
lib/order_cloud/models/list_promotion.rb,
lib/order_cloud/models/order_approval.rb,
lib/order_cloud/models/password_reset.rb,
lib/order_cloud/models/price_schedule.rb,
lib/order_cloud/models/web_hook_route.rb,
lib/order_cloud/api/email_template_api.rb,
lib/order_cloud/api/password_reset_api.rb,
lib/order_cloud/api/price_schedule_api.rb,
lib/order_cloud/models/list_api_client.rb,
lib/order_cloud/models/list_buyer_spec.rb,
lib/order_cloud/models/list_user_group.rb,
lib/order_cloud/models/order_promotion.rb,
lib/order_cloud/models/list_cost_center.rb,
lib/order_cloud/models/list_credit_card.rb,
lib/order_cloud/models/list_spec_option.rb,
lib/order_cloud/models/security_profile.rb,
lib/order_cloud/models/spending_account.rb,
lib/order_cloud/api/security_profile_api.rb,
lib/order_cloud/api/spending_account_api.rb,
lib/order_cloud/models/buyer_credit_card.rb,
lib/order_cloud/models/address_assignment.rb,
lib/order_cloud/models/list_admin_company.rb,
lib/order_cloud/models/list_approval_rule.rb,
lib/order_cloud/models/list_buyer_address.rb,
lib/order_cloud/models/list_buyer_product.rb,
lib/order_cloud/models/product_assignment.rb,
lib/order_cloud/models/admin_model_on_view.rb,
lib/order_cloud/models/category_assignment.rb,
lib/order_cloud/models/list_order_approval.rb,
lib/order_cloud/models/list_price_schedule.rb,
lib/order_cloud/models/list_web_hook_route.rb,
lib/order_cloud/models/payment_transaction.rb,
lib/order_cloud/models/list_order_promotion.rb,
lib/order_cloud/models/promotion_assignment.rb,
lib/order_cloud/models/list_security_profile.rb,
lib/order_cloud/models/list_spending_account.rb,
lib/order_cloud/models/user_group_assignment.rb,
lib/order_cloud/models/cost_center_assignment.rb,
lib/order_cloud/models/credit_card_assignment.rb,
lib/order_cloud/models/list_buyer_credit_card.rb,
lib/order_cloud/models/password_reset_request.rb,
lib/order_cloud/models/list_address_assignment.rb,
lib/order_cloud/models/list_product_assignment.rb,
lib/order_cloud/models/spec_product_assignment.rb,
lib/order_cloud/models/list_category_assignment.rb,
lib/order_cloud/models/impersonate_token_request.rb,
lib/order_cloud/models/list_promotion_assignment.rb,
lib/order_cloud/models/list_user_group_assignment.rb,
lib/order_cloud/models/category_product_assignment.rb,
lib/order_cloud/models/list_cost_center_assignment.rb,
lib/order_cloud/models/list_credit_card_assignment.rb,
lib/order_cloud/models/list_dev_accessible_company.rb,
lib/order_cloud/models/security_profile_assignment.rb,
lib/order_cloud/models/spending_account_assignment.rb,
lib/order_cloud/models/list_spec_product_assignment.rb,
lib/order_cloud/models/list_category_product_assignment.rb,
lib/order_cloud/models/list_security_profile_assignment.rb,
lib/order_cloud/models/list_spending_account_assignment.rb

Overview

#OrderCloud

#A full ecommerce backend as a service.

OpenAPI spec version: 1.0 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

Classes: AccessToken, Address, AddressApi, AddressAssignment, AdminAddressApi, AdminCompany, AdminModelOnView, AdminUserApi, ApiAuth, ApiClient, ApiError, ApprovalRule, ApprovalRuleApi, BaseSpec, Buyer, BuyerAddress, BuyerApi, BuyerCreditCard, BuyerProduct, BuyerSpec, Category, CategoryApi, CategoryAssignment, CategoryProductAssignment, Configuration, CostCenter, CostCenterApi, CostCenterAssignment, CreditCard, CreditCardApi, CreditCardAssignment, EmailTemplate, EmailTemplateApi, File, FileApi, ImpersonateTokenRequest, Inventory, LineItem, LineItemApi, LineItemSpec, ListAddress, ListAddressAssignment, ListAdminCompany, ListApiClient, ListApprovalRule, ListBuyer, ListBuyerAddress, ListBuyerCreditCard, ListBuyerProduct, ListBuyerSpec, ListCategory, ListCategoryAssignment, ListCategoryProductAssignment, ListCostCenter, ListCostCenterAssignment, ListCreditCard, ListCreditCardAssignment, ListDevAccessibleCompany, ListFile, ListInventory, ListLineItem, ListOrder, ListOrderApproval, ListOrderPromotion, ListPayment, ListPriceSchedule, ListProduct, ListProductAssignment, ListPromotion, ListPromotionAssignment, ListSecurityProfile, ListSecurityProfileAssignment, ListShipment, ListSpec, ListSpecOption, ListSpecProductAssignment, ListSpendingAccount, ListSpendingAccountAssignment, ListUser, ListUserGroup, ListUserGroupAssignment, ListVariant, ListWebHook, ListWebHookRoute, ListXpIndex, MeApi, Meta, Order, OrderApi, OrderApproval, OrderPromotion, PasswordReset, PasswordResetApi, PasswordResetRequest, Payment, PaymentApi, PaymentTransaction, PingResponse, PriceBreak, PriceSchedule, PriceScheduleApi, Product, ProductApi, ProductAssignment, Promotion, PromotionApi, PromotionAssignment, SecurityProfile, SecurityProfileApi, SecurityProfileAssignment, Shipment, ShipmentApi, ShipmentItem, Spec, SpecApi, SpecOption, SpecProductAssignment, SpendingAccount, SpendingAccountApi, SpendingAccountAssignment, User, UserApi, UserGroup, UserGroupApi, UserGroupAssignment, Variant, WebHook, WebHookRoute, XpIndex

Constant Summary collapse

VERSION = 
"0.0.4"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

OrderCloud.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



168
169
170
171
172
173
174
 
# File 'lib/order_cloud.rb', line 168

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end