order_cloud 1.0.45.pre.staging → 1.0.57
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +28 -0
- data/Gemfile.lock +34 -0
- data/LICENSE +201 -0
- data/README.md +552 -0
- data/Rakefile +31 -0
- data/docs/AccessToken.md +11 -0
- data/docs/Address.md +20 -0
- data/docs/AddressApi.md +520 -0
- data/docs/AddressAssignment.md +12 -0
- data/docs/AdminAddressApi.md +324 -0
- data/docs/AdminUserApi.md +324 -0
- data/docs/AdminUserGroupApi.md +482 -0
- data/docs/ApprovalRule.md +13 -0
- data/docs/ApprovalRuleApi.md +342 -0
- data/docs/BaseSpec.md +16 -0
- data/docs/Buyer.md +12 -0
- data/docs/BuyerAddress.md +23 -0
- data/docs/BuyerApi.md +324 -0
- data/docs/BuyerCreditCard.md +16 -0
- data/docs/BuyerProduct.md +23 -0
- data/docs/BuyerShipment.md +19 -0
- data/docs/BuyerSpec.md +17 -0
- data/docs/Catalog.md +13 -0
- data/docs/CatalogApi.md +640 -0
- data/docs/CatalogAssignment.md +11 -0
- data/docs/Category.md +15 -0
- data/docs/CategoryApi.md +690 -0
- data/docs/CategoryAssignment.md +12 -0
- data/docs/CategoryProductAssignment.md +10 -0
- data/docs/CostCenter.md +11 -0
- data/docs/CostCenterApi.md +516 -0
- data/docs/CostCenterAssignment.md +9 -0
- data/docs/CreditCard.md +15 -0
- data/docs/CreditCardApi.md +516 -0
- data/docs/CreditCardAssignment.md +10 -0
- data/docs/ImpersonateTokenRequest.md +9 -0
- data/docs/ImpersonationConfig.md +16 -0
- data/docs/ImpersonationConfigApi.md +324 -0
- data/docs/Inventory.md +13 -0
- data/docs/LineItem.md +24 -0
- data/docs/LineItemApi.md +478 -0
- data/docs/LineItemProduct.md +16 -0
- data/docs/LineItemSpec.md +11 -0
- data/docs/ListAddress.md +9 -0
- data/docs/ListAddressAssignment.md +9 -0
- data/docs/ListApprovalRule.md +9 -0
- data/docs/ListArgs.md +13 -0
- data/docs/ListBuyer.md +9 -0
- data/docs/ListBuyerAddress.md +9 -0
- data/docs/ListBuyerCreditCard.md +9 -0
- data/docs/ListBuyerProduct.md +9 -0
- data/docs/ListBuyerShipment.md +9 -0
- data/docs/ListBuyerSpec.md +9 -0
- data/docs/ListCatalog.md +9 -0
- data/docs/ListCatalogAssignment.md +9 -0
- data/docs/ListCategory.md +9 -0
- data/docs/ListCategoryAssignment.md +9 -0
- data/docs/ListCategoryProductAssignment.md +9 -0
- data/docs/ListCostCenter.md +9 -0
- data/docs/ListCostCenterAssignment.md +9 -0
- data/docs/ListCreditCard.md +9 -0
- data/docs/ListCreditCardAssignment.md +9 -0
- data/docs/ListImpersonationConfig.md +9 -0
- data/docs/ListLineItem.md +9 -0
- data/docs/ListMessageCCListenerAssignment.md +9 -0
- data/docs/ListMessageConfig.md +9 -0
- data/docs/ListMessageSender.md +9 -0
- data/docs/ListMessageSenderAssignment.md +9 -0
- data/docs/ListOrder.md +9 -0
- data/docs/ListOrderApproval.md +9 -0
- data/docs/ListOrderPromotion.md +9 -0
- data/docs/ListPayment.md +9 -0
- data/docs/ListPriceSchedule.md +9 -0
- data/docs/ListProduct.md +9 -0
- data/docs/ListProductAssignment.md +9 -0
- data/docs/ListProductCatalogAssignment.md +9 -0
- data/docs/ListPromotion.md +9 -0
- data/docs/ListPromotionAssignment.md +9 -0
- data/docs/ListSecurityProfile.md +9 -0
- data/docs/ListSecurityProfileAssignment.md +9 -0
- data/docs/ListShipment.md +9 -0
- data/docs/ListShipmentItem.md +9 -0
- data/docs/ListSpec.md +9 -0
- data/docs/ListSpecOption.md +9 -0
- data/docs/ListSpecProductAssignment.md +9 -0
- data/docs/ListSpendingAccount.md +9 -0
- data/docs/ListSpendingAccountAssignment.md +9 -0
- data/docs/ListSupplier.md +9 -0
- data/docs/ListUser.md +9 -0
- data/docs/ListUserGroup.md +9 -0
- data/docs/ListUserGroupAssignment.md +9 -0
- data/docs/ListVariant.md +9 -0
- data/docs/MeApi.md +2002 -0
- data/docs/MeBuyer.md +9 -0
- data/docs/MeUser.md +19 -0
- data/docs/MessageCCListenerAssignment.md +13 -0
- data/docs/MessageConfig.md +14 -0
- data/docs/MessageSender.md +10 -0
- data/docs/MessageSenderAssignment.md +11 -0
- data/docs/MessageSendersApi.md +398 -0
- data/docs/Meta.md +12 -0
- data/docs/Order.md +30 -0
- data/docs/OrderApi.md +1161 -0
- data/docs/OrderApproval.md +14 -0
- data/docs/OrderApprovalInfo.md +9 -0
- data/docs/OrderPromotion.md +22 -0
- data/docs/PasswordReset.md +10 -0
- data/docs/PasswordResetApi.md +109 -0
- data/docs/PasswordResetRequest.md +11 -0
- data/docs/Payment.md +17 -0
- data/docs/PaymentApi.md +418 -0
- data/docs/PaymentTransaction.md +15 -0
- data/docs/PriceBreak.md +9 -0
- data/docs/PriceSchedule.md +17 -0
- data/docs/PriceScheduleApi.md +429 -0
- data/docs/Product.md +23 -0
- data/docs/ProductApi.md +953 -0
- data/docs/ProductAssignment.md +11 -0
- data/docs/ProductBase.md +22 -0
- data/docs/ProductCatalogAssignment.md +9 -0
- data/docs/Promotion.md +21 -0
- data/docs/PromotionApi.md +494 -0
- data/docs/PromotionAssignment.md +10 -0
- data/docs/SecurityProfile.md +10 -0
- data/docs/SecurityProfileApi.md +292 -0
- data/docs/SecurityProfileAssignment.md +12 -0
- data/docs/Shipment.md +20 -0
- data/docs/ShipmentApi.md +554 -0
- data/docs/ShipmentItem.md +16 -0
- data/docs/Spec.md +17 -0
- data/docs/SpecApi.md +820 -0
- data/docs/SpecOption.md +14 -0
- data/docs/SpecProductAssignment.md +11 -0
- data/docs/SpendingAccount.md +15 -0
- data/docs/SpendingAccountApi.md +516 -0
- data/docs/SpendingAccountAssignment.md +11 -0
- data/docs/Supplier.md +11 -0
- data/docs/SupplierApi.md +324 -0
- data/docs/SupplierUserApi.md +400 -0
- data/docs/SupplierUserGroupApi.md +509 -0
- data/docs/TokenPasswordReset.md +8 -0
- data/docs/User.md +18 -0
- data/docs/UserApi.md +400 -0
- data/docs/UserGroup.md +11 -0
- data/docs/UserGroupApi.md +509 -0
- data/docs/UserGroupAssignment.md +9 -0
- data/docs/Variant.md +12 -0
- data/git_push.sh +67 -0
- data/lib/order_cloud.rb +193 -0
- data/lib/order_cloud/api/address_api.rb +628 -0
- data/lib/order_cloud/api/admin_address_api.rb +397 -0
- data/lib/order_cloud/api/admin_user_api.rb +397 -0
- data/lib/order_cloud/api/admin_user_group_api.rb +578 -0
- data/lib/order_cloud/api/approval_rule_api.rb +421 -0
- data/lib/order_cloud/api/auth_api.rb +138 -0
- data/lib/order_cloud/api/buyer_api.rb +397 -0
- data/lib/order_cloud/api/catalog_api.rb +760 -0
- data/lib/order_cloud/api/category_api.rb +826 -0
- data/lib/order_cloud/api/cost_center_api.rb +622 -0
- data/lib/order_cloud/api/credit_card_api.rb +622 -0
- data/lib/order_cloud/api/impersonation_config_api.rb +397 -0
- data/lib/order_cloud/api/line_item_api.rb +583 -0
- data/lib/order_cloud/api/me_api.rb +2345 -0
- data/lib/order_cloud/api/message_senders_api.rb +484 -0
- data/lib/order_cloud/api/order_api.rb +1377 -0
- data/lib/order_cloud/api/password_reset_api.rb +150 -0
- data/lib/order_cloud/api/payment_api.rb +513 -0
- data/lib/order_cloud/api/price_schedule_api.rb +519 -0
- data/lib/order_cloud/api/product_api.rb +1126 -0
- data/lib/order_cloud/api/promotion_api.rb +594 -0
- data/lib/order_cloud/api/security_profile_api.rb +363 -0
- data/lib/order_cloud/api/shipment_api.rb +665 -0
- data/lib/order_cloud/api/spec_api.rb +971 -0
- data/lib/order_cloud/api/spending_account_api.rb +622 -0
- data/lib/order_cloud/api/supplier_api.rb +397 -0
- data/lib/order_cloud/api/supplier_user_api.rb +489 -0
- data/lib/order_cloud/api/supplier_user_group_api.rb +614 -0
- data/lib/order_cloud/api/user_api.rb +489 -0
- data/lib/order_cloud/api/user_group_api.rb +614 -0
- data/lib/order_cloud/api_client.rb +385 -0
- data/lib/order_cloud/api_error.rb +47 -0
- data/lib/order_cloud/configuration.rb +245 -0
- data/lib/order_cloud/models/access_token.rb +226 -0
- data/lib/order_cloud/models/address.rb +307 -0
- data/lib/order_cloud/models/address_assignment.rb +235 -0
- data/lib/order_cloud/models/approval_rule.rb +244 -0
- data/lib/order_cloud/models/base_spec.rb +271 -0
- data/lib/order_cloud/models/buyer.rb +235 -0
- data/lib/order_cloud/models/buyer_address.rb +334 -0
- data/lib/order_cloud/models/buyer_credit_card.rb +271 -0
- data/lib/order_cloud/models/buyer_product.rb +334 -0
- data/lib/order_cloud/models/buyer_shipment.rb +298 -0
- data/lib/order_cloud/models/buyer_spec.rb +282 -0
- data/lib/order_cloud/models/catalog.rb +244 -0
- data/lib/order_cloud/models/catalog_assignment.rb +226 -0
- data/lib/order_cloud/models/category.rb +262 -0
- data/lib/order_cloud/models/category_assignment.rb +235 -0
- data/lib/order_cloud/models/category_product_assignment.rb +217 -0
- data/lib/order_cloud/models/cost_center.rb +226 -0
- data/lib/order_cloud/models/cost_center_assignment.rb +208 -0
- data/lib/order_cloud/models/credit_card.rb +262 -0
- data/lib/order_cloud/models/credit_card_assignment.rb +217 -0
- data/lib/order_cloud/models/impersonate_token_request.rb +210 -0
- data/lib/order_cloud/models/impersonation_config.rb +271 -0
- data/lib/order_cloud/models/inventory.rb +244 -0
- data/lib/order_cloud/models/line_item.rb +345 -0
- data/lib/order_cloud/models/line_item_product.rb +271 -0
- data/lib/order_cloud/models/line_item_spec.rb +226 -0
- data/lib/order_cloud/models/list_address.rb +210 -0
- data/lib/order_cloud/models/list_address_assignment.rb +210 -0
- data/lib/order_cloud/models/list_approval_rule.rb +210 -0
- data/lib/order_cloud/models/list_args.rb +248 -0
- data/lib/order_cloud/models/list_buyer.rb +210 -0
- data/lib/order_cloud/models/list_buyer_address.rb +210 -0
- data/lib/order_cloud/models/list_buyer_credit_card.rb +210 -0
- data/lib/order_cloud/models/list_buyer_product.rb +210 -0
- data/lib/order_cloud/models/list_buyer_shipment.rb +210 -0
- data/lib/order_cloud/models/list_buyer_spec.rb +210 -0
- data/lib/order_cloud/models/list_catalog.rb +210 -0
- data/lib/order_cloud/models/list_catalog_assignment.rb +210 -0
- data/lib/order_cloud/models/list_category.rb +210 -0
- data/lib/order_cloud/models/list_category_assignment.rb +210 -0
- data/lib/order_cloud/models/list_category_product_assignment.rb +210 -0
- data/lib/order_cloud/models/list_cost_center.rb +210 -0
- data/lib/order_cloud/models/list_cost_center_assignment.rb +210 -0
- data/lib/order_cloud/models/list_credit_card.rb +210 -0
- data/lib/order_cloud/models/list_credit_card_assignment.rb +210 -0
- data/lib/order_cloud/models/list_impersonation_config.rb +210 -0
- data/lib/order_cloud/models/list_line_item.rb +210 -0
- data/lib/order_cloud/models/list_message_cc_listener_assignment.rb +210 -0
- data/lib/order_cloud/models/list_message_config.rb +210 -0
- data/lib/order_cloud/models/list_message_sender.rb +210 -0
- data/lib/order_cloud/models/list_message_sender_assignment.rb +210 -0
- data/lib/order_cloud/models/list_order.rb +210 -0
- data/lib/order_cloud/models/list_order_approval.rb +210 -0
- data/lib/order_cloud/models/list_order_promotion.rb +210 -0
- data/lib/order_cloud/models/list_payment.rb +210 -0
- data/lib/order_cloud/models/list_price_schedule.rb +210 -0
- data/lib/order_cloud/models/list_product.rb +210 -0
- data/lib/order_cloud/models/list_product_assignment.rb +210 -0
- data/lib/order_cloud/models/list_product_catalog_assignment.rb +210 -0
- data/lib/order_cloud/models/list_promotion.rb +210 -0
- data/lib/order_cloud/models/list_promotion_assignment.rb +210 -0
- data/lib/order_cloud/models/list_security_profile.rb +210 -0
- data/lib/order_cloud/models/list_security_profile_assignment.rb +210 -0
- data/lib/order_cloud/models/list_shipment.rb +210 -0
- data/lib/order_cloud/models/list_shipment_item.rb +210 -0
- data/lib/order_cloud/models/list_spec.rb +210 -0
- data/lib/order_cloud/models/list_spec_option.rb +210 -0
- data/lib/order_cloud/models/list_spec_product_assignment.rb +210 -0
- data/lib/order_cloud/models/list_spending_account.rb +210 -0
- data/lib/order_cloud/models/list_spending_account_assignment.rb +210 -0
- data/lib/order_cloud/models/list_supplier.rb +210 -0
- data/lib/order_cloud/models/list_user.rb +210 -0
- data/lib/order_cloud/models/list_user_group.rb +210 -0
- data/lib/order_cloud/models/list_user_group_assignment.rb +210 -0
- data/lib/order_cloud/models/list_variant.rb +210 -0
- data/lib/order_cloud/models/me_buyer.rb +208 -0
- data/lib/order_cloud/models/me_user.rb +300 -0
- data/lib/order_cloud/models/message_cc_listener_assignment.rb +244 -0
- data/lib/order_cloud/models/message_config.rb +255 -0
- data/lib/order_cloud/models/message_sender.rb +219 -0
- data/lib/order_cloud/models/message_sender_assignment.rb +226 -0
- data/lib/order_cloud/models/meta.rb +237 -0
- data/lib/order_cloud/models/order.rb +397 -0
- data/lib/order_cloud/models/order_approval.rb +253 -0
- data/lib/order_cloud/models/order_approval_info.rb +208 -0
- data/lib/order_cloud/models/order_promotion.rb +325 -0
- data/lib/order_cloud/models/password_reset.rb +217 -0
- data/lib/order_cloud/models/password_reset_request.rb +226 -0
- data/lib/order_cloud/models/payment.rb +282 -0
- data/lib/order_cloud/models/payment_transaction.rb +262 -0
- data/lib/order_cloud/models/price_break.rb +208 -0
- data/lib/order_cloud/models/price_schedule.rb +282 -0
- data/lib/order_cloud/models/product.rb +334 -0
- data/lib/order_cloud/models/product_assignment.rb +226 -0
- data/lib/order_cloud/models/product_base.rb +325 -0
- data/lib/order_cloud/models/product_catalog_assignment.rb +208 -0
- data/lib/order_cloud/models/promotion.rb +316 -0
- data/lib/order_cloud/models/promotion_assignment.rb +217 -0
- data/lib/order_cloud/models/security_profile.rb +219 -0
- data/lib/order_cloud/models/security_profile_assignment.rb +235 -0
- data/lib/order_cloud/models/shipment.rb +307 -0
- data/lib/order_cloud/models/shipment_item.rb +273 -0
- data/lib/order_cloud/models/spec.rb +280 -0
- data/lib/order_cloud/models/spec_option.rb +253 -0
- data/lib/order_cloud/models/spec_product_assignment.rb +226 -0
- data/lib/order_cloud/models/spending_account.rb +262 -0
- data/lib/order_cloud/models/spending_account_assignment.rb +226 -0
- data/lib/order_cloud/models/supplier.rb +226 -0
- data/lib/order_cloud/models/token_password_reset.rb +199 -0
- data/lib/order_cloud/models/user.rb +291 -0
- data/lib/order_cloud/models/user_group.rb +226 -0
- data/lib/order_cloud/models/user_group_assignment.rb +208 -0
- data/lib/order_cloud/models/variant.rb +235 -0
- data/lib/order_cloud/version.rb +26 -0
- data/order_cloud-1.0.56.gem +0 -0
- data/order_cloud.gemspec +56 -0
- data/spec/api/address_api_spec.rb +179 -0
- data/spec/api/admin_address_api_spec.rb +125 -0
- data/spec/api/admin_user_api_spec.rb +125 -0
- data/spec/api/admin_user_group_api_spec.rb +165 -0
- data/spec/api/approval_rule_api_spec.rb +131 -0
- data/spec/api/auth_api_spec.rb +165 -0
- data/spec/api/buyer_api_spec.rb +125 -0
- data/spec/api/catalog_api_spec.rb +205 -0
- data/spec/api/category_api_spec.rb +223 -0
- data/spec/api/cost_center_api_spec.rb +177 -0
- data/spec/api/credit_card_api_spec.rb +177 -0
- data/spec/api/impersonation_config_api_spec.rb +125 -0
- data/spec/api/line_item_api_spec.rb +167 -0
- data/spec/api/me_api_spec.rb +568 -0
- data/spec/api/message_senders_api_spec.rb +149 -0
- data/spec/api/order_api_spec.rb +344 -0
- data/spec/api/password_reset_api_spec.rb +71 -0
- data/spec/api/payment_api_spec.rb +152 -0
- data/spec/api/price_schedule_api_spec.rb +151 -0
- data/spec/api/product_api_spec.rb +290 -0
- data/spec/api/promotion_api_spec.rb +170 -0
- data/spec/api/security_profile_api_spec.rb +122 -0
- data/spec/api/shipment_api_spec.rb +185 -0
- data/spec/api/spec_api_spec.rb +252 -0
- data/spec/api/spending_account_api_spec.rb +177 -0
- data/spec/api/supplier_api_spec.rb +125 -0
- data/spec/api/supplier_user_api_spec.rb +146 -0
- data/spec/api/supplier_user_group_api_spec.rb +174 -0
- data/spec/api/user_api_spec.rb +146 -0
- data/spec/api/user_group_api_spec.rb +174 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +80 -0
- data/spec/models/access_token_spec.rb +71 -0
- data/spec/models/address_assignment_spec.rb +77 -0
- data/spec/models/address_spec.rb +125 -0
- data/spec/models/approval_rule_spec.rb +83 -0
- data/spec/models/base_spec_spec.rb +101 -0
- data/spec/models/buyer_address_spec.rb +143 -0
- data/spec/models/buyer_credit_card_spec.rb +101 -0
- data/spec/models/buyer_product_spec.rb +143 -0
- data/spec/models/buyer_shipment_spec.rb +119 -0
- data/spec/models/buyer_spec.rb +77 -0
- data/spec/models/buyer_spec_spec.rb +107 -0
- data/spec/models/catalog_assignment_spec.rb +71 -0
- data/spec/models/catalog_spec.rb +83 -0
- data/spec/models/category_assignment_spec.rb +77 -0
- data/spec/models/category_product_assignment_spec.rb +65 -0
- data/spec/models/category_spec.rb +95 -0
- data/spec/models/cost_center_assignment_spec.rb +59 -0
- data/spec/models/cost_center_spec.rb +71 -0
- data/spec/models/credit_card_assignment_spec.rb +65 -0
- data/spec/models/credit_card_spec.rb +95 -0
- data/spec/models/impersonate_token_request_spec.rb +59 -0
- data/spec/models/impersonation_config_spec.rb +101 -0
- data/spec/models/inventory_spec.rb +83 -0
- data/spec/models/line_item_product_spec.rb +101 -0
- data/spec/models/line_item_spec.rb +149 -0
- data/spec/models/line_item_spec_spec.rb +71 -0
- data/spec/models/list_address_assignment_spec.rb +59 -0
- data/spec/models/list_address_spec.rb +59 -0
- data/spec/models/list_approval_rule_spec.rb +59 -0
- data/spec/models/list_args_spec.rb +83 -0
- data/spec/models/list_buyer_address_spec.rb +59 -0
- data/spec/models/list_buyer_credit_card_spec.rb +59 -0
- data/spec/models/list_buyer_product_spec.rb +59 -0
- data/spec/models/list_buyer_shipment_spec.rb +59 -0
- data/spec/models/list_buyer_spec.rb +59 -0
- data/spec/models/list_buyer_spec_spec.rb +59 -0
- data/spec/models/list_catalog_assignment_spec.rb +59 -0
- data/spec/models/list_catalog_spec.rb +59 -0
- data/spec/models/list_category_assignment_spec.rb +59 -0
- data/spec/models/list_category_product_assignment_spec.rb +59 -0
- data/spec/models/list_category_spec.rb +59 -0
- data/spec/models/list_cost_center_assignment_spec.rb +59 -0
- data/spec/models/list_cost_center_spec.rb +59 -0
- data/spec/models/list_credit_card_assignment_spec.rb +59 -0
- data/spec/models/list_credit_card_spec.rb +59 -0
- data/spec/models/list_impersonation_config_spec.rb +59 -0
- data/spec/models/list_line_item_spec.rb +59 -0
- data/spec/models/list_message_cc_listener_assignment_spec.rb +59 -0
- data/spec/models/list_message_config_spec.rb +59 -0
- data/spec/models/list_message_sender_assignment_spec.rb +59 -0
- data/spec/models/list_message_sender_spec.rb +59 -0
- data/spec/models/list_order_approval_spec.rb +59 -0
- data/spec/models/list_order_promotion_spec.rb +59 -0
- data/spec/models/list_order_spec.rb +59 -0
- data/spec/models/list_payment_spec.rb +59 -0
- data/spec/models/list_price_schedule_spec.rb +59 -0
- data/spec/models/list_product_assignment_spec.rb +59 -0
- data/spec/models/list_product_catalog_assignment_spec.rb +59 -0
- data/spec/models/list_product_spec.rb +59 -0
- data/spec/models/list_promotion_assignment_spec.rb +59 -0
- data/spec/models/list_promotion_spec.rb +59 -0
- data/spec/models/list_security_profile_assignment_spec.rb +59 -0
- data/spec/models/list_security_profile_spec.rb +59 -0
- data/spec/models/list_shipment_item_spec.rb +59 -0
- data/spec/models/list_shipment_spec.rb +59 -0
- data/spec/models/list_spec_option_spec.rb +59 -0
- data/spec/models/list_spec_product_assignment_spec.rb +59 -0
- data/spec/models/list_spec_spec.rb +59 -0
- data/spec/models/list_spending_account_assignment_spec.rb +59 -0
- data/spec/models/list_spending_account_spec.rb +59 -0
- data/spec/models/list_supplier_spec.rb +59 -0
- data/spec/models/list_user_group_assignment_spec.rb +59 -0
- data/spec/models/list_user_group_spec.rb +59 -0
- data/spec/models/list_user_spec.rb +59 -0
- data/spec/models/list_variant_spec.rb +59 -0
- data/spec/models/me_buyer_spec.rb +59 -0
- data/spec/models/me_user_spec.rb +119 -0
- data/spec/models/message_cc_listener_assignment_spec.rb +83 -0
- data/spec/models/message_config_spec.rb +89 -0
- data/spec/models/message_sender_assignment_spec.rb +71 -0
- data/spec/models/message_sender_spec.rb +65 -0
- data/spec/models/meta_spec.rb +77 -0
- data/spec/models/order_approval_info_spec.rb +59 -0
- data/spec/models/order_approval_spec.rb +89 -0
- data/spec/models/order_promotion_spec.rb +137 -0
- data/spec/models/order_spec.rb +185 -0
- data/spec/models/password_reset_request_spec.rb +71 -0
- data/spec/models/password_reset_spec.rb +65 -0
- data/spec/models/payment_spec.rb +107 -0
- data/spec/models/payment_transaction_spec.rb +95 -0
- data/spec/models/price_break_spec.rb +59 -0
- data/spec/models/price_schedule_spec.rb +107 -0
- data/spec/models/product_assignment_spec.rb +71 -0
- data/spec/models/product_base_spec.rb +137 -0
- data/spec/models/product_catalog_assignment_spec.rb +59 -0
- data/spec/models/product_spec.rb +143 -0
- data/spec/models/promotion_assignment_spec.rb +65 -0
- data/spec/models/promotion_spec.rb +131 -0
- data/spec/models/security_profile_assignment_spec.rb +77 -0
- data/spec/models/security_profile_spec.rb +65 -0
- data/spec/models/shipment_item_spec.rb +101 -0
- data/spec/models/shipment_spec.rb +125 -0
- data/spec/models/spec_option_spec.rb +89 -0
- data/spec/models/spec_product_assignment_spec.rb +71 -0
- data/spec/models/spec_spec.rb +107 -0
- data/spec/models/spending_account_assignment_spec.rb +71 -0
- data/spec/models/spending_account_spec.rb +95 -0
- data/spec/models/supplier_spec.rb +71 -0
- data/spec/models/token_password_reset_spec.rb +53 -0
- data/spec/models/user_group_assignment_spec.rb +59 -0
- data/spec/models/user_group_spec.rb +71 -0
- data/spec/models/user_spec.rb +113 -0
- data/spec/models/variant_spec.rb +77 -0
- data/spec/spec_helper.rb +122 -0
- metadata +596 -6
@@ -0,0 +1,385 @@
|
|
1
|
+
=begin
|
2
|
+
#OrderCloud
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0
|
7
|
+
Contact: ordercloud@four51.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
11
|
+
you may not use this file except in compliance with the License.
|
12
|
+
You may obtain a copy of the License at
|
13
|
+
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
15
|
+
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
19
|
+
See the License for the specific language governing permissions and
|
20
|
+
limitations under the License.
|
21
|
+
|
22
|
+
=end
|
23
|
+
|
24
|
+
require 'date'
|
25
|
+
require 'json'
|
26
|
+
require 'logger'
|
27
|
+
require 'tempfile'
|
28
|
+
require 'typhoeus'
|
29
|
+
require 'uri'
|
30
|
+
|
31
|
+
module OrderCloud
|
32
|
+
class ApiClient
|
33
|
+
# The Configuration object holding settings to be used in the API client.
|
34
|
+
attr_accessor :config
|
35
|
+
|
36
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
37
|
+
#
|
38
|
+
# @return [Hash]
|
39
|
+
attr_accessor :default_headers
|
40
|
+
|
41
|
+
# Initializes the ApiClient
|
42
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
43
|
+
def initialize(config = Configuration.default)
|
44
|
+
@config = config
|
45
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
46
|
+
@default_headers = {
|
47
|
+
'Content-Type' => "application/json",
|
48
|
+
'User-Agent' => @user_agent
|
49
|
+
}
|
50
|
+
end
|
51
|
+
|
52
|
+
def self.default
|
53
|
+
@@default ||= ApiClient.new
|
54
|
+
end
|
55
|
+
|
56
|
+
# Call an API with given options.
|
57
|
+
#
|
58
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
59
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
60
|
+
def call_api(http_method, path, opts = {})
|
61
|
+
request = build_request(http_method, path, opts)
|
62
|
+
response = request.run
|
63
|
+
|
64
|
+
if @config.debugging
|
65
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
66
|
+
end
|
67
|
+
|
68
|
+
unless response.success?
|
69
|
+
fail ApiError.new(:code => response.code,
|
70
|
+
:response_headers => response.headers,
|
71
|
+
:response_body => response.body),
|
72
|
+
response.status_message
|
73
|
+
end
|
74
|
+
|
75
|
+
if opts[:return_type]
|
76
|
+
data = deserialize(response, opts[:return_type])
|
77
|
+
else
|
78
|
+
data = nil
|
79
|
+
end
|
80
|
+
return data, response.code, response.headers
|
81
|
+
end
|
82
|
+
|
83
|
+
# Builds the HTTP request
|
84
|
+
#
|
85
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
86
|
+
# @param [String] path URL path (e.g. /account/new)
|
87
|
+
# @option opts [Hash] :header_params Header parameters
|
88
|
+
# @option opts [Hash] :query_params Query parameters
|
89
|
+
# @option opts [Hash] :form_params Query parameters
|
90
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
91
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
92
|
+
def build_request(http_method, path, opts = {})
|
93
|
+
url = build_request_url(path)
|
94
|
+
http_method = http_method.to_sym.downcase
|
95
|
+
|
96
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
97
|
+
query_params = opts[:query_params] || {}
|
98
|
+
form_params = opts[:form_params] || {}
|
99
|
+
|
100
|
+
if query_params[:filters]
|
101
|
+
query_params[:filters].each { |key, value|
|
102
|
+
query_params[key] = value
|
103
|
+
}
|
104
|
+
end
|
105
|
+
|
106
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
107
|
+
|
108
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
109
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
110
|
+
|
111
|
+
req_opts = {
|
112
|
+
:method => http_method,
|
113
|
+
:headers => header_params,
|
114
|
+
:params => query_params,
|
115
|
+
:params_encoding => @config.params_encoding,
|
116
|
+
:timeout => @config.timeout,
|
117
|
+
:ssl_verifypeer => @config.verify_ssl,
|
118
|
+
:ssl_verifyhost => _verify_ssl_host,
|
119
|
+
:sslcert => @config.cert_file,
|
120
|
+
:sslkey => @config.key_file,
|
121
|
+
:verbose => @config.debugging
|
122
|
+
}
|
123
|
+
|
124
|
+
# set custom cert, if provided
|
125
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
126
|
+
|
127
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
128
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
129
|
+
req_opts.update :body => req_body
|
130
|
+
if @config.debugging
|
131
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
Typhoeus::Request.new(url, req_opts)
|
136
|
+
end
|
137
|
+
|
138
|
+
# Check if the given MIME is a JSON MIME.
|
139
|
+
# JSON MIME examples:
|
140
|
+
# application/json
|
141
|
+
# application/json; charset=UTF8
|
142
|
+
# APPLICATION/JSON
|
143
|
+
# @param [String] mime MIME
|
144
|
+
# @return [Boolean] True if the MIME is applicaton/json
|
145
|
+
def json_mime?(mime)
|
146
|
+
!(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
|
147
|
+
end
|
148
|
+
|
149
|
+
# Deserialize the response to the given return type.
|
150
|
+
#
|
151
|
+
# @param [Response] response HTTP response
|
152
|
+
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
153
|
+
def deserialize(response, return_type)
|
154
|
+
body = response.body
|
155
|
+
return nil if body.nil? || body.empty?
|
156
|
+
|
157
|
+
# return response body directly for String return type
|
158
|
+
return body if return_type == 'String'
|
159
|
+
|
160
|
+
# handle file downloading - save response body into a tmp file and return the File instance
|
161
|
+
return download_file(response) if return_type == 'File'
|
162
|
+
|
163
|
+
# ensuring a default content type
|
164
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
165
|
+
|
166
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
167
|
+
|
168
|
+
begin
|
169
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
170
|
+
rescue JSON::ParserError => e
|
171
|
+
if %w(String Date DateTime).include?(return_type)
|
172
|
+
data = body
|
173
|
+
else
|
174
|
+
raise e
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
178
|
+
convert_to_type data, return_type
|
179
|
+
end
|
180
|
+
|
181
|
+
# Convert data to the given return type.
|
182
|
+
# @param [Object] data Data to be converted
|
183
|
+
# @param [String] return_type Return type
|
184
|
+
# @return [Mixed] Data in a particular type
|
185
|
+
def convert_to_type(data, return_type)
|
186
|
+
return nil if data.nil?
|
187
|
+
case return_type
|
188
|
+
when 'String'
|
189
|
+
data.to_s
|
190
|
+
when 'Integer'
|
191
|
+
data.to_i
|
192
|
+
when 'Float'
|
193
|
+
data.to_f
|
194
|
+
when 'BOOLEAN'
|
195
|
+
data == true
|
196
|
+
when 'DateTime'
|
197
|
+
# parse date time (expecting ISO 8601 format)
|
198
|
+
DateTime.parse data
|
199
|
+
when 'Date'
|
200
|
+
# parse date time (expecting ISO 8601 format)
|
201
|
+
Date.parse data
|
202
|
+
when 'Object'
|
203
|
+
# generic object (usually a Hash), return directly
|
204
|
+
data
|
205
|
+
when /\AArray<(.+)>\z/
|
206
|
+
# e.g. Array<Pet>
|
207
|
+
sub_type = $1
|
208
|
+
data.map {|item| convert_to_type(item, sub_type) }
|
209
|
+
when /\AHash\<String, (.+)\>\z/
|
210
|
+
# e.g. Hash<String, Integer>
|
211
|
+
sub_type = $1
|
212
|
+
{}.tap do |hash|
|
213
|
+
data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
|
214
|
+
end
|
215
|
+
else
|
216
|
+
# models, e.g. Pet
|
217
|
+
OrderCloud.const_get(return_type).new.tap do |model|
|
218
|
+
model.build_from_hash data
|
219
|
+
end
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
224
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
225
|
+
#
|
226
|
+
# @see Configuration#temp_folder_path
|
227
|
+
# @return [Tempfile] the file downloaded
|
228
|
+
def download_file(response)
|
229
|
+
content_disposition = response.headers['Content-Disposition']
|
230
|
+
if content_disposition and content_disposition =~ /filename=/i
|
231
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
232
|
+
prefix = sanitize_filename(filename)
|
233
|
+
else
|
234
|
+
prefix = 'download-'
|
235
|
+
end
|
236
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
237
|
+
|
238
|
+
tempfile = nil
|
239
|
+
encoding = response.body.encoding
|
240
|
+
Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
|
241
|
+
file.write(response.body)
|
242
|
+
tempfile = file
|
243
|
+
end
|
244
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
245
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
246
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
247
|
+
"explicitly with `tempfile.delete`"
|
248
|
+
tempfile
|
249
|
+
end
|
250
|
+
|
251
|
+
# Sanitize filename by removing path.
|
252
|
+
# e.g. ../../sun.gif becomes sun.gif
|
253
|
+
#
|
254
|
+
# @param [String] filename the filename to be sanitized
|
255
|
+
# @return [String] the sanitized filename
|
256
|
+
def sanitize_filename(filename)
|
257
|
+
filename.gsub(/.*[\/\\]/, '')
|
258
|
+
end
|
259
|
+
|
260
|
+
def build_request_url(path)
|
261
|
+
# Add leading and trailing slashes to path
|
262
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
263
|
+
URI.encode(@config.base_url + path)
|
264
|
+
end
|
265
|
+
|
266
|
+
# Builds the HTTP request body
|
267
|
+
#
|
268
|
+
# @param [Hash] header_params Header parameters
|
269
|
+
# @param [Hash] form_params Query parameters
|
270
|
+
# @param [Object] body HTTP body (JSON/XML)
|
271
|
+
# @return [String] HTTP body data in the form of string
|
272
|
+
def build_request_body(header_params, form_params, body)
|
273
|
+
# http form
|
274
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
275
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
276
|
+
data = {}
|
277
|
+
form_params.each do |key, value|
|
278
|
+
case value
|
279
|
+
when File, Array, nil
|
280
|
+
# let typhoeus handle File, Array and nil parameters
|
281
|
+
data[key] = value
|
282
|
+
else
|
283
|
+
data[key] = value.to_s
|
284
|
+
end
|
285
|
+
end
|
286
|
+
elsif body
|
287
|
+
data = body.is_a?(String) ? body : body.to_json
|
288
|
+
else
|
289
|
+
data = nil
|
290
|
+
end
|
291
|
+
data
|
292
|
+
end
|
293
|
+
|
294
|
+
# Update hearder and query params based on authentication settings.
|
295
|
+
#
|
296
|
+
# @param [Hash] header_params Header parameters
|
297
|
+
# @param [Hash] form_params Query parameters
|
298
|
+
# @param [String] auth_names Authentication scheme name
|
299
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
300
|
+
Array(auth_names).each do |auth_name|
|
301
|
+
auth_setting = @config.auth_settings[auth_name]
|
302
|
+
next unless auth_setting
|
303
|
+
case auth_setting[:in]
|
304
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
305
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
306
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
307
|
+
end
|
308
|
+
end
|
309
|
+
end
|
310
|
+
|
311
|
+
# Sets user agent in HTTP header
|
312
|
+
#
|
313
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
314
|
+
def user_agent=(user_agent)
|
315
|
+
@user_agent = user_agent
|
316
|
+
@default_headers['User-Agent'] = @user_agent
|
317
|
+
end
|
318
|
+
|
319
|
+
# Return Accept header based on an array of accepts provided.
|
320
|
+
# @param [Array] accepts array for Accept
|
321
|
+
# @return [String] the Accept header (e.g. application/json)
|
322
|
+
def select_header_accept(accepts)
|
323
|
+
return nil if accepts.nil? || accepts.empty?
|
324
|
+
# use JSON when present, otherwise use all of the provided
|
325
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
326
|
+
return json_accept || accepts.join(',')
|
327
|
+
end
|
328
|
+
|
329
|
+
# Return Content-Type header based on an array of content types provided.
|
330
|
+
# @param [Array] content_types array for Content-Type
|
331
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
332
|
+
def select_header_content_type(content_types)
|
333
|
+
# use application/json by default
|
334
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
335
|
+
# use JSON when present, otherwise use the first one
|
336
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
337
|
+
return json_content_type || content_types.first
|
338
|
+
end
|
339
|
+
|
340
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
341
|
+
# @param [Object] model object to be converted into JSON string
|
342
|
+
# @return [String] JSON string representation of the object
|
343
|
+
def object_to_http_body(model)
|
344
|
+
return model if model.nil? || model.is_a?(String)
|
345
|
+
local_body = nil
|
346
|
+
if model.is_a?(Array)
|
347
|
+
local_body = model.map{|m| object_to_hash(m) }
|
348
|
+
else
|
349
|
+
local_body = object_to_hash(model)
|
350
|
+
end
|
351
|
+
local_body.to_json
|
352
|
+
end
|
353
|
+
|
354
|
+
# Convert object(non-array) to hash.
|
355
|
+
# @param [Object] obj object to be converted into JSON string
|
356
|
+
# @return [String] JSON string representation of the object
|
357
|
+
def object_to_hash(obj)
|
358
|
+
if obj.respond_to?(:to_hash)
|
359
|
+
obj.to_hash
|
360
|
+
else
|
361
|
+
obj
|
362
|
+
end
|
363
|
+
end
|
364
|
+
|
365
|
+
# Build parameter value according to the given collection format.
|
366
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
367
|
+
def build_collection_param(param, collection_format)
|
368
|
+
case collection_format
|
369
|
+
when :csv
|
370
|
+
param.join(',')
|
371
|
+
when :ssv
|
372
|
+
param.join(' ')
|
373
|
+
when :tsv
|
374
|
+
param.join("\t")
|
375
|
+
when :pipes
|
376
|
+
param.join('|')
|
377
|
+
when :multi
|
378
|
+
# return the array directly as typhoeus will handle it as expected
|
379
|
+
param
|
380
|
+
else
|
381
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
382
|
+
end
|
383
|
+
end
|
384
|
+
end
|
385
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
=begin
|
2
|
+
#OrderCloud
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0
|
7
|
+
Contact: ordercloud@four51.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
11
|
+
you may not use this file except in compliance with the License.
|
12
|
+
You may obtain a copy of the License at
|
13
|
+
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
15
|
+
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
19
|
+
See the License for the specific language governing permissions and
|
20
|
+
limitations under the License.
|
21
|
+
|
22
|
+
=end
|
23
|
+
|
24
|
+
module OrderCloud
|
25
|
+
class ApiError < StandardError
|
26
|
+
attr_reader :code, :response_headers, :response_body
|
27
|
+
|
28
|
+
# Usage examples:
|
29
|
+
# ApiError.new
|
30
|
+
# ApiError.new("message")
|
31
|
+
# ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
|
32
|
+
# ApiError.new(:code => 404, :message => "Not Found")
|
33
|
+
def initialize(arg = nil)
|
34
|
+
if arg.is_a? Hash
|
35
|
+
arg.each do |k, v|
|
36
|
+
if k.to_s == 'message'
|
37
|
+
super v
|
38
|
+
else
|
39
|
+
instance_variable_set "@#{k}", v
|
40
|
+
end
|
41
|
+
end
|
42
|
+
else
|
43
|
+
super arg
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,245 @@
|
|
1
|
+
=begin
|
2
|
+
#OrderCloud
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0
|
7
|
+
Contact: ordercloud@four51.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
11
|
+
you may not use this file except in compliance with the License.
|
12
|
+
You may obtain a copy of the License at
|
13
|
+
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
15
|
+
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
19
|
+
See the License for the specific language governing permissions and
|
20
|
+
limitations under the License.
|
21
|
+
|
22
|
+
=end
|
23
|
+
|
24
|
+
require 'uri'
|
25
|
+
|
26
|
+
module OrderCloud
|
27
|
+
class Configuration
|
28
|
+
## OrderCloud specific configuration
|
29
|
+
attr_accessor :client_id
|
30
|
+
attr_accessor :scopes
|
31
|
+
attr_accessor :auth_url
|
32
|
+
attr_accessor :impersonation_token
|
33
|
+
|
34
|
+
# Returns true if impersonation is on, false otherwise
|
35
|
+
def impersonating?
|
36
|
+
@impersonation_token
|
37
|
+
end
|
38
|
+
|
39
|
+
# Returns the appropriate token
|
40
|
+
def get_access_token
|
41
|
+
if impersonating?
|
42
|
+
@impersonation_token
|
43
|
+
else
|
44
|
+
@access_token
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# Defines url scheme
|
49
|
+
attr_accessor :scheme
|
50
|
+
|
51
|
+
# Defines url host
|
52
|
+
attr_accessor :host
|
53
|
+
|
54
|
+
# Defines url base path
|
55
|
+
attr_accessor :base_path
|
56
|
+
|
57
|
+
# Defines API keys used with API Key authentications.
|
58
|
+
#
|
59
|
+
# @return [Hash] key: parameter name, value: parameter value (API key)
|
60
|
+
#
|
61
|
+
# @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
|
62
|
+
# config.api_key['api_key'] = 'xxx'
|
63
|
+
attr_accessor :api_key
|
64
|
+
|
65
|
+
# Defines API key prefixes used with API Key authentications.
|
66
|
+
#
|
67
|
+
# @return [Hash] key: parameter name, value: API key prefix
|
68
|
+
#
|
69
|
+
# @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
|
70
|
+
# config.api_key_prefix['api_key'] = 'Token'
|
71
|
+
attr_accessor :api_key_prefix
|
72
|
+
|
73
|
+
# Defines the username used with HTTP basic authentication.
|
74
|
+
#
|
75
|
+
# @return [String]
|
76
|
+
attr_accessor :username
|
77
|
+
|
78
|
+
# Defines the password used with HTTP basic authentication.
|
79
|
+
#
|
80
|
+
# @return [String]
|
81
|
+
attr_accessor :password
|
82
|
+
|
83
|
+
# Defines the access token (Bearer) used with OAuth2.
|
84
|
+
attr_accessor :access_token
|
85
|
+
|
86
|
+
# Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
|
87
|
+
# details will be logged with `logger.debug` (see the `logger` attribute).
|
88
|
+
# Default to false.
|
89
|
+
#
|
90
|
+
# @return [true, false]
|
91
|
+
attr_accessor :debugging
|
92
|
+
|
93
|
+
# Defines the logger used for debugging.
|
94
|
+
# Default to `Rails.logger` (when in Rails) or logging to STDOUT.
|
95
|
+
#
|
96
|
+
# @return [#debug]
|
97
|
+
attr_accessor :logger
|
98
|
+
|
99
|
+
# Defines the temporary folder to store downloaded files
|
100
|
+
# (for API endpoints that have file response).
|
101
|
+
# Default to use `Tempfile`.
|
102
|
+
#
|
103
|
+
# @return [String]
|
104
|
+
attr_accessor :temp_folder_path
|
105
|
+
|
106
|
+
# The time limit for HTTP request in seconds.
|
107
|
+
# Default to 0 (never times out).
|
108
|
+
attr_accessor :timeout
|
109
|
+
|
110
|
+
### TLS/SSL setting
|
111
|
+
# Set this to false to skip verifying SSL certificate when calling API from https server.
|
112
|
+
# Default to true.
|
113
|
+
#
|
114
|
+
# @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
|
115
|
+
#
|
116
|
+
# @return [true, false]
|
117
|
+
attr_accessor :verify_ssl
|
118
|
+
|
119
|
+
### TLS/SSL setting
|
120
|
+
# Set this to false to skip verifying SSL host name
|
121
|
+
# Default to true.
|
122
|
+
#
|
123
|
+
# @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
|
124
|
+
#
|
125
|
+
# @return [true, false]
|
126
|
+
attr_accessor :verify_ssl_host
|
127
|
+
|
128
|
+
### TLS/SSL setting
|
129
|
+
# Set this to customize the certificate file to verify the peer.
|
130
|
+
#
|
131
|
+
# @return [String] the path to the certificate file
|
132
|
+
#
|
133
|
+
# @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
|
134
|
+
# https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
|
135
|
+
attr_accessor :ssl_ca_cert
|
136
|
+
|
137
|
+
### TLS/SSL setting
|
138
|
+
# Client certificate file (for client certificate)
|
139
|
+
attr_accessor :cert_file
|
140
|
+
|
141
|
+
### TLS/SSL setting
|
142
|
+
# Client private key file (for client certificate)
|
143
|
+
attr_accessor :key_file
|
144
|
+
|
145
|
+
# Set this to customize parameters encoding of array parameter with multi collectionFormat.
|
146
|
+
# Default to nil.
|
147
|
+
#
|
148
|
+
# @see The params_encoding option of Ethon. Related source code:
|
149
|
+
# https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
|
150
|
+
attr_accessor :params_encoding
|
151
|
+
|
152
|
+
attr_accessor :inject_format
|
153
|
+
|
154
|
+
attr_accessor :force_ending_format
|
155
|
+
|
156
|
+
def initialize
|
157
|
+
@scheme = 'https'
|
158
|
+
@host = 'api.ordercloud.io'
|
159
|
+
@base_path = '/v1'
|
160
|
+
@api_key = {}
|
161
|
+
@api_key_prefix = {}
|
162
|
+
@timeout = 0
|
163
|
+
@verify_ssl = true
|
164
|
+
@verify_ssl_host = true
|
165
|
+
@params_encoding = nil
|
166
|
+
@cert_file = nil
|
167
|
+
@key_file = nil
|
168
|
+
@debugging = false
|
169
|
+
@inject_format = false
|
170
|
+
@force_ending_format = false
|
171
|
+
@logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
|
172
|
+
|
173
|
+
@auth_url = 'https://auth.ordercloud.io/oauth/token'
|
174
|
+
@impersonation_token = nil
|
175
|
+
@access_token = nil
|
176
|
+
@client_id = ''
|
177
|
+
@scopes = []
|
178
|
+
|
179
|
+
yield(self) if block_given?
|
180
|
+
end
|
181
|
+
|
182
|
+
# The default Configuration object.
|
183
|
+
def self.default
|
184
|
+
@@default ||= Configuration.new
|
185
|
+
end
|
186
|
+
|
187
|
+
## Resets the default configuration object to a clean one
|
188
|
+
def self.reset
|
189
|
+
@@default = Configuration.new
|
190
|
+
end
|
191
|
+
|
192
|
+
def configure
|
193
|
+
yield(self) if block_given?
|
194
|
+
end
|
195
|
+
|
196
|
+
def scheme=(scheme)
|
197
|
+
# remove :// from scheme
|
198
|
+
@scheme = scheme.sub(/:\/\//, '')
|
199
|
+
end
|
200
|
+
|
201
|
+
def host=(host)
|
202
|
+
# remove http(s):// and anything after a slash
|
203
|
+
@host = host.sub(/https?:\/\//, '').split('/').first
|
204
|
+
end
|
205
|
+
|
206
|
+
def base_path=(base_path)
|
207
|
+
# Add leading and trailing slashes to base_path
|
208
|
+
@base_path = "/#{base_path}".gsub(/\/+/, '/')
|
209
|
+
@base_path = "" if @base_path == "/"
|
210
|
+
end
|
211
|
+
|
212
|
+
def base_url
|
213
|
+
url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
|
214
|
+
URI.encode(url)
|
215
|
+
end
|
216
|
+
|
217
|
+
# Gets API key (with prefix if set).
|
218
|
+
# @param [String] param_name the parameter name of API key auth
|
219
|
+
def api_key_with_prefix(param_name)
|
220
|
+
if @api_key_prefix[param_name]
|
221
|
+
"#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
|
222
|
+
else
|
223
|
+
@api_key[param_name]
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
# Gets Basic Auth token string
|
228
|
+
def basic_auth_token
|
229
|
+
'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
|
230
|
+
end
|
231
|
+
|
232
|
+
# Returns Auth Settings hash for api client.
|
233
|
+
def auth_settings
|
234
|
+
{
|
235
|
+
'oauth2' =>
|
236
|
+
{
|
237
|
+
type: 'oauth2',
|
238
|
+
in: 'header',
|
239
|
+
key: 'Authorization',
|
240
|
+
value: "Bearer #{get_access_token.access_token}"
|
241
|
+
},
|
242
|
+
}
|
243
|
+
end
|
244
|
+
end
|
245
|
+
end
|