workarea-api 4.4.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.editorconfig +20 -0
- data/.github/ISSUE_TEMPLATE/bug_report.md +37 -0
- data/.github/ISSUE_TEMPLATE/documentation-request.md +17 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- data/.gitignore +24 -0
- data/.yardopts +1 -0
- data/CHANGELOG.md +807 -0
- data/CODE_OF_CONDUCT.md +3 -0
- data/CONTRIBUTING.md +3 -0
- data/Gemfile +21 -0
- data/LICENSE +52 -0
- data/README.md +107 -0
- data/Rakefile +121 -0
- data/admin/.gitignore +12 -0
- data/admin/README.md +82 -0
- data/admin/Rakefile +10 -0
- data/admin/app/assets/images/workarea/api/admin/icons/api.svg +1 -0
- data/admin/app/controllers/workarea/api/admin/application_controller.rb +73 -0
- data/admin/app/controllers/workarea/api/admin/categories_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/category_product_rules_controller.rb +232 -0
- data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +299 -0
- data/admin/app/controllers/workarea/api/admin/content_controller.rb +268 -0
- data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +271 -0
- data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +108 -0
- data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +268 -0
- data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +267 -0
- data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/orders_controller.rb +160 -0
- data/admin/app/controllers/workarea/api/admin/pages_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +108 -0
- data/admin/app/controllers/workarea/api/admin/payments_controller.rb +115 -0
- data/admin/app/controllers/workarea/api/admin/prices_controller.rb +232 -0
- data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/product_images_controller.rb +232 -0
- data/admin/app/controllers/workarea/api/admin/products_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +122 -0
- data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +305 -0
- data/admin/app/controllers/workarea/api/admin/releases_controller.rb +304 -0
- data/admin/app/controllers/workarea/api/admin/saved_addresses_controller.rb +232 -0
- data/admin/app/controllers/workarea/api/admin/saved_credit_cards_controller.rb +256 -0
- data/admin/app/controllers/workarea/api/admin/shipping_rates_controller.rb +232 -0
- data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +299 -0
- data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +105 -0
- data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +41 -0
- data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +242 -0
- data/admin/app/controllers/workarea/api/admin/tax_rates_controller.rb +292 -0
- data/admin/app/controllers/workarea/api/admin/users_controller.rb +296 -0
- data/admin/app/controllers/workarea/api/admin/variants_controller.rb +232 -0
- data/admin/app/models/workarea/api/admin/bulk_upsert.rb +74 -0
- data/admin/app/models/workarea/user.decorator +7 -0
- data/admin/app/views/workarea/admin/users/_api_permissions.html.haml +6 -0
- data/admin/app/workers/workarea/perform_api_bulk_upsert.rb +15 -0
- data/admin/bin/rails +18 -0
- data/admin/config/initializers/append_points.rb +4 -0
- data/admin/config/initializers/config.rb +15 -0
- data/admin/config/locales/en.yml +9 -0
- data/admin/config/routes.rb +81 -0
- data/admin/lib/workarea/api/admin/engine.rb +14 -0
- data/admin/lib/workarea/api/admin/swagger.rb +106 -0
- data/admin/lib/workarea/api/admin.rb +21 -0
- data/admin/test/documentation/workarea/api/admin/categories_documentation_test.rb +106 -0
- data/admin/test/documentation/workarea/api/admin/category_product_rules_documentation_test.rb +78 -0
- data/admin/test/documentation/workarea/api/admin/content_assets_documentation_test.rb +94 -0
- data/admin/test/documentation/workarea/api/admin/content_documentation_test.rb +87 -0
- data/admin/test/documentation/workarea/api/admin/discounts_documentation_test.rb +85 -0
- data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +41 -0
- data/admin/test/documentation/workarea/api/admin/fulfillment_documentation_test.rb +84 -0
- data/admin/test/documentation/workarea/api/admin/inventory_skus_documentation_test.rb +95 -0
- data/admin/test/documentation/workarea/api/admin/navigation_menus_documentation_test.rb +81 -0
- data/admin/test/documentation/workarea/api/admin/navigation_taxons_documentation_test.rb +94 -0
- data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +65 -0
- data/admin/test/documentation/workarea/api/admin/pages_documentation_test.rb +93 -0
- data/admin/test/documentation/workarea/api/admin/payment_profiles_documentation_test.rb +98 -0
- data/admin/test/documentation/workarea/api/admin/payment_transactions_documentation_test.rb +43 -0
- data/admin/test/documentation/workarea/api/admin/payments_documentation_test.rb +41 -0
- data/admin/test/documentation/workarea/api/admin/prices_documentation_test.rb +82 -0
- data/admin/test/documentation/workarea/api/admin/pricing_skus_documentation_test.rb +95 -0
- data/admin/test/documentation/workarea/api/admin/product_images_documentation_test.rb +101 -0
- data/admin/test/documentation/workarea/api/admin/products_documentation_test.rb +96 -0
- data/admin/test/documentation/workarea/api/admin/promo_code_lists_documentation_test.rb +94 -0
- data/admin/test/documentation/workarea/api/admin/recommendation_settings_documentation_test.rb +37 -0
- data/admin/test/documentation/workarea/api/admin/redirects_documentation_test.rb +96 -0
- data/admin/test/documentation/workarea/api/admin/release_changes_documentation_test.rb +32 -0
- data/admin/test/documentation/workarea/api/admin/releases_documentation_test.rb +93 -0
- data/admin/test/documentation/workarea/api/admin/saved_addresses_documentation_test.rb +92 -0
- data/admin/test/documentation/workarea/api/admin/saved_credit_cards_documentation_test.rb +86 -0
- data/admin/test/documentation/workarea/api/admin/shipping_rates_documentation_test.rb +78 -0
- data/admin/test/documentation/workarea/api/admin/shipping_services_documentation_test.rb +93 -0
- data/admin/test/documentation/workarea/api/admin/shippings_documentation_test.rb +41 -0
- data/admin/test/documentation/workarea/api/admin/tax_categories_documentation_test.rb +95 -0
- data/admin/test/documentation/workarea/api/admin/tax_rates_documentation_test.rb +78 -0
- data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +99 -0
- data/admin/test/documentation/workarea/api/admin/variants_documentation_test.rb +80 -0
- data/admin/test/dummy/Rakefile +7 -0
- data/admin/test/dummy/app/assets/config/manifest.js +4 -0
- data/admin/test/dummy/app/assets/images/.keep +0 -0
- data/admin/test/dummy/app/assets/javascripts/application.js +13 -0
- data/admin/test/dummy/app/assets/stylesheets/application.css +15 -0
- data/admin/test/dummy/app/controllers/application_controller.rb +3 -0
- data/admin/test/dummy/app/controllers/concerns/.keep +0 -0
- data/admin/test/dummy/app/helpers/application_helper.rb +2 -0
- data/admin/test/dummy/app/jobs/application_job.rb +2 -0
- data/admin/test/dummy/app/mailers/.keep +0 -0
- data/admin/test/dummy/app/mailers/application_mailer.rb +4 -0
- data/admin/test/dummy/app/models/.keep +0 -0
- data/admin/test/dummy/app/models/concerns/.keep +0 -0
- data/admin/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/admin/test/dummy/app/views/layouts/mailer.html.erb +13 -0
- data/admin/test/dummy/app/views/layouts/mailer.text.erb +1 -0
- data/admin/test/dummy/bin/bundle +3 -0
- data/admin/test/dummy/bin/rails +4 -0
- data/admin/test/dummy/bin/rake +4 -0
- data/admin/test/dummy/bin/setup +34 -0
- data/admin/test/dummy/bin/update +29 -0
- data/admin/test/dummy/config/application.rb +25 -0
- data/admin/test/dummy/config/boot.rb +5 -0
- data/admin/test/dummy/config/cable.yml +9 -0
- data/admin/test/dummy/config/environment.rb +5 -0
- data/admin/test/dummy/config/environments/development.rb +55 -0
- data/admin/test/dummy/config/environments/production.rb +86 -0
- data/admin/test/dummy/config/environments/test.rb +43 -0
- data/admin/test/dummy/config/initializers/application_controller_renderer.rb +6 -0
- data/admin/test/dummy/config/initializers/assets.rb +11 -0
- data/admin/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/admin/test/dummy/config/initializers/cookies_serializer.rb +5 -0
- data/admin/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
- data/admin/test/dummy/config/initializers/inflections.rb +16 -0
- data/admin/test/dummy/config/initializers/mime_types.rb +4 -0
- data/admin/test/dummy/config/initializers/new_framework_defaults.rb +21 -0
- data/admin/test/dummy/config/initializers/session_store.rb +3 -0
- data/admin/test/dummy/config/initializers/workarea.rb +8 -0
- data/admin/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/admin/test/dummy/config/locales/en.yml +23 -0
- data/admin/test/dummy/config/puma.rb +47 -0
- data/admin/test/dummy/config/routes.rb +6 -0
- data/admin/test/dummy/config/secrets.yml +22 -0
- data/admin/test/dummy/config/spring.rb +6 -0
- data/admin/test/dummy/config.ru +4 -0
- data/admin/test/dummy/db/seeds.rb +2 -0
- data/admin/test/dummy/log/.keep +0 -0
- data/admin/test/dummy/public/404.html +67 -0
- data/admin/test/dummy/public/422.html +67 -0
- data/admin/test/dummy/public/500.html +66 -0
- data/admin/test/dummy/public/apple-touch-icon-precomposed.png +0 -0
- data/admin/test/dummy/public/apple-touch-icon.png +0 -0
- data/admin/test/dummy/public/favicon.ico +1 -0
- data/admin/test/integration/workarea/api/admin/audit_log_integration_test.rb +20 -0
- data/admin/test/integration/workarea/api/admin/authentication_integration_test.rb +61 -0
- data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +64 -0
- data/admin/test/integration/workarea/api/admin/category_product_rules_integration_test.rb +58 -0
- data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +65 -0
- data/admin/test/integration/workarea/api/admin/content_integration_test.rb +59 -0
- data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +64 -0
- data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/error_handling_integration_test.rb +16 -0
- data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +62 -0
- data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +70 -0
- data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +54 -0
- data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +63 -0
- data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +53 -0
- data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +64 -0
- data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +75 -0
- data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +45 -0
- data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +29 -0
- data/admin/test/integration/workarea/api/admin/prices_integration_test.rb +55 -0
- data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +72 -0
- data/admin/test/integration/workarea/api/admin/product_images_integration_test.rb +56 -0
- data/admin/test/integration/workarea/api/admin/products_integration_test.rb +66 -0
- data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +70 -0
- data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +41 -0
- data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +69 -0
- data/admin/test/integration/workarea/api/admin/release_changes_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +60 -0
- data/admin/test/integration/workarea/api/admin/saved_addresses_integration_test.rb +70 -0
- data/admin/test/integration/workarea/api/admin/saved_credit_cards_integration_test.rb +76 -0
- data/admin/test/integration/workarea/api/admin/shipping_rates_integration_test.rb +54 -0
- data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +64 -0
- data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +34 -0
- data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +64 -0
- data/admin/test/integration/workarea/api/admin/tax_rates_integration_test.rb +66 -0
- data/admin/test/integration/workarea/api/admin/users_integration_test.rb +67 -0
- data/admin/test/integration/workarea/api/admin/variants_integration_test.rb +59 -0
- data/admin/test/models/workarea/api/admin/bulk_upsert_test.rb +79 -0
- data/admin/test/test_helper.rb +10 -0
- data/admin/test/vcr_cassettes/product_image_from_url.yml +43 -0
- data/admin/workarea-api-admin.gemspec +18 -0
- data/app/views/workarea/api/docs/engine_index.haml +1 -0
- data/app/views/workarea/api/docs/example.haml +114 -0
- data/app/views/workarea/api/docs/index.haml +28 -0
- data/app/views/workarea/api/docs/javascripts.haml +31 -0
- data/app/views/workarea/api/docs/javascripts_head.haml +5 -0
- data/app/views/workarea/api/docs/layout.haml +32 -0
- data/app/views/workarea/api/docs/logo.haml +1 -0
- data/app/views/workarea/api/docs/nav.haml +7 -0
- data/app/views/workarea/api/docs/stylesheets.haml +278 -0
- data/config/initializers/raddocs.rb +12 -0
- data/config/initializers/workarea.rb +3 -0
- data/config/routes.rb +5 -0
- data/doc/api/admin/categories/bulk_upserting_categories.json +42 -0
- data/doc/api/admin/categories/creating_a_category.json +46 -0
- data/doc/api/admin/categories/listing_categories.json +58 -0
- data/doc/api/admin/categories/removing_a_category.json +42 -0
- data/doc/api/admin/categories/showing_a_category.json +44 -0
- data/doc/api/admin/categories/updating_a_category.json +42 -0
- data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +46 -0
- data/doc/api/admin/category_product_rules/listing_category_product_rules.json +44 -0
- data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +42 -0
- data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +42 -0
- data/doc/api/admin/content/bulk_upserting_content.json +42 -0
- data/doc/api/admin/content/creating_content.json +46 -0
- data/doc/api/admin/content/listing_content.json +57 -0
- data/doc/api/admin/content/showing_content.json +44 -0
- data/doc/api/admin/content/updating_content.json +42 -0
- data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +42 -0
- data/doc/api/admin/content_assets/creating_a_content_asset.json +46 -0
- data/doc/api/admin/content_assets/listing_content_assets.json +58 -0
- data/doc/api/admin/content_assets/removing_a_content_asset.json +42 -0
- data/doc/api/admin/content_assets/showing_a_content_asset.json +44 -0
- data/doc/api/admin/content_assets/updating_a_content_asset.json +42 -0
- data/doc/api/admin/discounts/creating_a_discount.json +46 -0
- data/doc/api/admin/discounts/listing_discounts.json +58 -0
- data/doc/api/admin/discounts/removing_a_discount.json +42 -0
- data/doc/api/admin/discounts/showing_a_discount.json +44 -0
- data/doc/api/admin/discounts/updating_discounts.json +42 -0
- data/doc/api/admin/email_signups/listing_email_signups.json +58 -0
- data/doc/api/admin/email_signups/showing_an_email_signup.json +44 -0
- data/doc/api/admin/fulfillment/listing_fulfillments.json +55 -0
- data/doc/api/admin/fulfillment/marking_items_as_canceled.json +46 -0
- data/doc/api/admin/fulfillment/marking_items_as_shipped.json +46 -0
- data/doc/api/admin/fulfillment/showing_fulfillment.json +44 -0
- data/doc/api/admin/index.json +1219 -0
- data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +42 -0
- data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +46 -0
- data/doc/api/admin/inventory_skus/listing_inventory_skus.json +58 -0
- data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +42 -0
- data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +44 -0
- data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +42 -0
- data/doc/api/admin/navigation_menus/creating_a_menu.json +46 -0
- data/doc/api/admin/navigation_menus/listing_menus.json +58 -0
- data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +42 -0
- data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +44 -0
- data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +42 -0
- data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +42 -0
- data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +46 -0
- data/doc/api/admin/navigation_taxonomy/listing_taxons.json +58 -0
- data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +42 -0
- data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +44 -0
- data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +42 -0
- data/doc/api/admin/orders/listing_orders.json +58 -0
- data/doc/api/admin/orders/showing_an_order.json +44 -0
- data/doc/api/admin/orders/viewing_orders_by_date_range.json +68 -0
- data/doc/api/admin/pages/bulk_upserting_pages.json +42 -0
- data/doc/api/admin/pages/creating_a_page.json +46 -0
- data/doc/api/admin/pages/listing_pages.json +58 -0
- data/doc/api/admin/pages/removing_a_page.json +42 -0
- data/doc/api/admin/pages/showing_a_page.json +44 -0
- data/doc/api/admin/pages/updating_a_page.json +42 -0
- data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +42 -0
- data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +46 -0
- data/doc/api/admin/payment_profiles/listing_payment_profiles.json +58 -0
- data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +42 -0
- data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +44 -0
- data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +42 -0
- data/doc/api/admin/payment_transactions/listing_payment_transactions.json +58 -0
- data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +44 -0
- data/doc/api/admin/payments/listing_payments.json +58 -0
- data/doc/api/admin/payments/showing_an_payment.json +44 -0
- data/doc/api/admin/prices/creating_a_pricing_sku_price.json +46 -0
- data/doc/api/admin/prices/listing_pricing_sku_prices.json +58 -0
- data/doc/api/admin/prices/removing_a_pricing_sku_price.json +42 -0
- data/doc/api/admin/prices/updating_a_pricing_sku_price.json +42 -0
- data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +42 -0
- data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +46 -0
- data/doc/api/admin/pricing_skus/listing_pricing_skus.json +58 -0
- data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +42 -0
- data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +44 -0
- data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +42 -0
- data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +46 -0
- data/doc/api/admin/product_images/creating_a_product_image_from_url.json +46 -0
- data/doc/api/admin/product_images/listing_product_images.json +44 -0
- data/doc/api/admin/product_images/removing_a_product_image.json +42 -0
- data/doc/api/admin/product_images/updating_a_product_image.json +42 -0
- data/doc/api/admin/products/bulk_upserting_products.json +42 -0
- data/doc/api/admin/products/creating_a_product.json +46 -0
- data/doc/api/admin/products/listing_products.json +58 -0
- data/doc/api/admin/products/removing_a_product.json +42 -0
- data/doc/api/admin/products/showing_a_product.json +44 -0
- data/doc/api/admin/products/updating_a_product.json +42 -0
- data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +42 -0
- data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +46 -0
- data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +58 -0
- data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +42 -0
- data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +44 -0
- data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +42 -0
- data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +44 -0
- data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +42 -0
- data/doc/api/admin/redirects/bulk_upserting_redirects.json +42 -0
- data/doc/api/admin/redirects/creating_a_redirect.json +46 -0
- data/doc/api/admin/redirects/listing_redirects.json +58 -0
- data/doc/api/admin/redirects/removing_a_redirect.json +42 -0
- data/doc/api/admin/redirects/showing_a_redirect.json +44 -0
- data/doc/api/admin/redirects/updating_a_redirects.json +42 -0
- data/doc/api/admin/release_changes/adding_changes_to_a_release.json +43 -0
- data/doc/api/admin/releases/bulk_upserting_releases.json +42 -0
- data/doc/api/admin/releases/creating_a_release.json +46 -0
- data/doc/api/admin/releases/listing_releases.json +58 -0
- data/doc/api/admin/releases/removing_a_release.json +42 -0
- data/doc/api/admin/releases/showing_a_release.json +44 -0
- data/doc/api/admin/releases/updating_a_release.json +42 -0
- data/doc/api/admin/saved_addresses/creating_a_saved_address.json +46 -0
- data/doc/api/admin/saved_addresses/listing_saved_address.json +44 -0
- data/doc/api/admin/saved_addresses/removing_a_saved_address.json +42 -0
- data/doc/api/admin/saved_addresses/updating_a_saved_address.json +42 -0
- data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +46 -0
- data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +55 -0
- data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +42 -0
- data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +42 -0
- data/doc/api/admin/shipping/listing_shipments.json +58 -0
- data/doc/api/admin/shipping/showing_a_shipment.json +44 -0
- data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +46 -0
- data/doc/api/admin/shipping_rates/listing_shipping_rates.json +44 -0
- data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +42 -0
- data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +42 -0
- data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +42 -0
- data/doc/api/admin/shipping_services/creating_a_shipping_service.json +46 -0
- data/doc/api/admin/shipping_services/listing_shipping_services.json +58 -0
- data/doc/api/admin/shipping_services/removing_a_shipping_service.json +42 -0
- data/doc/api/admin/shipping_services/showing_a_shipping_service.json +44 -0
- data/doc/api/admin/shipping_services/updating_a_shipping_service.json +42 -0
- data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +42 -0
- data/doc/api/admin/tax_categories/creating_a_tax_category.json +46 -0
- data/doc/api/admin/tax_categories/listing_tax_categories.json +55 -0
- data/doc/api/admin/tax_categories/removing_a_tax_category.json +42 -0
- data/doc/api/admin/tax_categories/showing_a_tax_category.json +44 -0
- data/doc/api/admin/tax_categories/updating_a_tax_categories.json +42 -0
- data/doc/api/admin/tax_rates/creating_a_tax_rate.json +46 -0
- data/doc/api/admin/tax_rates/listing_tax_rates.json +44 -0
- data/doc/api/admin/tax_rates/removing_a_tax_rate.json +42 -0
- data/doc/api/admin/tax_rates/updating_a_tax_rate.json +42 -0
- data/doc/api/admin/users/bulk_upserting_users.json +42 -0
- data/doc/api/admin/users/creating_a_user.json +46 -0
- data/doc/api/admin/users/listing_users.json +58 -0
- data/doc/api/admin/users/removing_a_user.json +42 -0
- data/doc/api/admin/users/showing_a_user.json +44 -0
- data/doc/api/admin/users/updating_a_user.json +42 -0
- data/doc/api/admin/variants/creating_a_product_variant.json +46 -0
- data/doc/api/admin/variants/listing_product_variants.json +44 -0
- data/doc/api/admin/variants/removing_a_product_variant.json +42 -0
- data/doc/api/admin/variants/updating_a_product_variant.json +42 -0
- data/doc/api/storefront/accounts/creating_an_account.json +51 -0
- data/doc/api/storefront/accounts/getting_account_details.json +50 -0
- data/doc/api/storefront/accounts/updating_an_account.json +52 -0
- data/doc/api/storefront/analytics/saving_a_category_view.json +39 -0
- data/doc/api/storefront/analytics/saving_a_product_view.json +39 -0
- data/doc/api/storefront/analytics/saving_a_search.json +39 -0
- data/doc/api/storefront/analytics/saving_a_search_abandonment.json +38 -0
- data/doc/api/storefront/analytics/saving_filters.json +38 -0
- data/doc/api/storefront/assets/showing_an_asset.json +50 -0
- data/doc/api/storefront/authentication/creating_an_authentication_token.json +51 -0
- data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +52 -0
- data/doc/api/storefront/authentication/using_an_authentication_token.json +51 -0
- data/doc/api/storefront/cart/adding_a_promo_code.json +52 -0
- data/doc/api/storefront/cart/adding_an_item.json +52 -0
- data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +52 -0
- data/doc/api/storefront/cart/creating_a_new_guest_cart.json +51 -0
- data/doc/api/storefront/cart/delete_an_item.json +52 -0
- data/doc/api/storefront/cart/listing_user_s_carts.json +51 -0
- data/doc/api/storefront/cart/showing_cart.json +51 -0
- data/doc/api/storefront/cart/updating_an_item.json +52 -0
- data/doc/api/storefront/categories/showing_a_category.json +64 -0
- data/doc/api/storefront/categories/showing_a_listing_of_categories.json +55 -0
- data/doc/api/storefront/checkout/completing_a_checkout.json +51 -0
- data/doc/api/storefront/checkout/showing_a_checkout.json +50 -0
- data/doc/api/storefront/checkout/updating_a_checkout.json +51 -0
- data/doc/api/storefront/contacts/creating_a_contact.json +51 -0
- data/doc/api/storefront/email_signups/creating_an_email_signup.json +51 -0
- data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +50 -0
- data/doc/api/storefront/index.json +527 -0
- data/doc/api/storefront/menus/listing_menus.json +51 -0
- data/doc/api/storefront/menus/showing_a_menu.json +51 -0
- data/doc/api/storefront/orders/listing_the_user_s_orders.json +51 -0
- data/doc/api/storefront/orders/showing_an_order.json +51 -0
- data/doc/api/storefront/pages/showing_a_page.json +51 -0
- data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +50 -0
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +55 -0
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +51 -0
- data/doc/api/storefront/products/showing_a_product.json +51 -0
- data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +55 -0
- data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +51 -0
- data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +55 -0
- data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +53 -0
- data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +51 -0
- data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +51 -0
- data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +48 -0
- data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +51 -0
- data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +50 -0
- data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +51 -0
- data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +51 -0
- data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +48 -0
- data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +51 -0
- data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +50 -0
- data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +51 -0
- data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +52 -0
- data/doc/api/storefront/searches/showing_search_results.json +69 -0
- data/doc/api/storefront/system_content/showing_system_content.json +51 -0
- data/doc/api/storefront/system_content/showing_the_home_page.json +51 -0
- data/doc/api/storefront/taxons/showing_a_taxon.json +51 -0
- data/doc/api/storefront/validation_errors/checkout_validation_errors.json +51 -0
- data/doc/api/storefront/validation_errors/general_validation_errors.json +45 -0
- data/lib/workarea/api/curl.rb +86 -0
- data/lib/workarea/api/documentation.rb +61 -0
- data/lib/workarea/api/documentation_test.rb +210 -0
- data/lib/workarea/api/engine.rb +8 -0
- data/lib/workarea/api/version.rb +5 -0
- data/lib/workarea/api.rb +18 -0
- data/storefront/.gitignore +12 -0
- data/storefront/README.md +58 -0
- data/storefront/Rakefile +10 -0
- data/storefront/app/controllers/workarea/api/storefront/accounts_controller.rb +31 -0
- data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +41 -0
- data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +65 -0
- data/storefront/app/controllers/workarea/api/storefront/assets_controller.rb +11 -0
- data/storefront/app/controllers/workarea/api/storefront/authentication.rb +30 -0
- data/storefront/app/controllers/workarea/api/storefront/authentication_tokens_controller.rb +50 -0
- data/storefront/app/controllers/workarea/api/storefront/cart_items_controller.rb +100 -0
- data/storefront/app/controllers/workarea/api/storefront/carts_controller.rb +47 -0
- data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +25 -0
- data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +117 -0
- data/storefront/app/controllers/workarea/api/storefront/contacts_controller.rb +20 -0
- data/storefront/app/controllers/workarea/api/storefront/current_checkout.rb +60 -0
- data/storefront/app/controllers/workarea/api/storefront/email_signups_controller.rb +15 -0
- data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +19 -0
- data/storefront/app/controllers/workarea/api/storefront/orders_controller.rb +32 -0
- data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +14 -0
- data/storefront/app/controllers/workarea/api/storefront/password_resets_controller.rb +17 -0
- data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +17 -0
- data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +46 -0
- data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +22 -0
- data/storefront/app/controllers/workarea/api/storefront/saved_addresses_controller.rb +38 -0
- data/storefront/app/controllers/workarea/api/storefront/saved_credit_cards_controller.rb +54 -0
- data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +29 -0
- data/storefront/app/controllers/workarea/api/storefront/system_content_controller.rb +16 -0
- data/storefront/app/controllers/workarea/api/storefront/taxons_controller.rb +20 -0
- data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +36 -0
- data/storefront/app/controllers/workarea/storefront/application_controller.decorator +12 -0
- data/storefront/app/helpers/workarea/api/storefront/application_helper.rb +15 -0
- data/storefront/app/helpers/workarea/api/storefront/checkouts_helper.rb +11 -0
- data/storefront/app/helpers/workarea/api/storefront/content_blocks_helper.rb +38 -0
- data/storefront/app/models/workarea/catalog/category.decorator +7 -0
- data/storefront/app/models/workarea/user/authentication_token.rb +33 -0
- data/storefront/app/models/workarea/user.decorator +8 -0
- data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +21 -0
- data/storefront/app/views/workarea/api/storefront/accounts/_account.json.jbuilder +7 -0
- data/storefront/app/views/workarea/api/storefront/accounts/create.json.jbuilder +7 -0
- data/storefront/app/views/workarea/api/storefront/accounts/show.json.jbuilder +1 -0
- data/storefront/app/views/workarea/api/storefront/assets/show.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/authentication_tokens/_authentication_token.json.jbuilder +2 -0
- data/storefront/app/views/workarea/api/storefront/authentication_tokens/create.json.jbuilder +1 -0
- data/storefront/app/views/workarea/api/storefront/authentication_tokens/update.json.jbuilder +1 -0
- data/storefront/app/views/workarea/api/storefront/cart_items/item.json.jbuilder +9 -0
- data/storefront/app/views/workarea/api/storefront/carts/index.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/carts/show.json.jbuilder +1 -0
- data/storefront/app/views/workarea/api/storefront/categories/_category.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/categories/index.json.jbuilder +3 -0
- data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +30 -0
- data/storefront/app/views/workarea/api/storefront/checkouts/_shipping_options.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/checkouts/show.json.jbuilder +17 -0
- data/storefront/app/views/workarea/api/storefront/checkouts/steps/_addresses.json.jbuilder +19 -0
- data/storefront/app/views/workarea/api/storefront/checkouts/steps/_payment.json.jbuilder +9 -0
- data/storefront/app/views/workarea/api/storefront/checkouts/steps/_shipping.json.jbuilder +9 -0
- data/storefront/app/views/workarea/api/storefront/content_blocks/_block.json.jbuilder +7 -0
- data/storefront/app/views/workarea/api/storefront/email_signups/create.json.jbuilder +2 -0
- data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/facets/_range.json.jbuilder +8 -0
- data/storefront/app/views/workarea/api/storefront/facets/_terms.json.jbuilder +8 -0
- data/storefront/app/views/workarea/api/storefront/fulfillments/_fulfillment.json.jbuilder +18 -0
- data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +11 -0
- data/storefront/app/views/workarea/api/storefront/menus/index.json.jbuilder +3 -0
- data/storefront/app/views/workarea/api/storefront/menus/show.json.jbuilder +1 -0
- data/storefront/app/views/workarea/api/storefront/orders/_item.json.jbuilder +26 -0
- data/storefront/app/views/workarea/api/storefront/orders/_order.json.jbuilder +42 -0
- data/storefront/app/views/workarea/api/storefront/orders/index.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/orders/show.json.jbuilder +7 -0
- data/storefront/app/views/workarea/api/storefront/orders/tenders/_credit_card.json.jbuilder +6 -0
- data/storefront/app/views/workarea/api/storefront/orders/tenders/_store_credit.json.jbuilder +2 -0
- data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +16 -0
- data/storefront/app/views/workarea/api/storefront/products/_image_urls.json.jbuilder +5 -0
- data/storefront/app/views/workarea/api/storefront/products/_product.json.jbuilder +41 -0
- data/storefront/app/views/workarea/api/storefront/products/show.json.jbuilder +9 -0
- data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +8 -0
- data/storefront/app/views/workarea/api/storefront/recommendations/show.json.jbuilder +3 -0
- data/storefront/app/views/workarea/api/storefront/saved_addresses/_saved_address.json.jbuilder +2 -0
- data/storefront/app/views/workarea/api/storefront/saved_addresses/index.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/saved_addresses/show.json.jbuilder +2 -0
- data/storefront/app/views/workarea/api/storefront/saved_credit_cards/_card.json.jbuilder +9 -0
- data/storefront/app/views/workarea/api/storefront/saved_credit_cards/index.json.jbuilder +4 -0
- data/storefront/app/views/workarea/api/storefront/saved_credit_cards/show.json.jbuilder +2 -0
- data/storefront/app/views/workarea/api/storefront/searches/index.json.jbuilder +1 -0
- data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +19 -0
- data/storefront/app/views/workarea/api/storefront/shared/_address.json.jbuilder +12 -0
- data/storefront/app/views/workarea/api/storefront/shared/_pagination.json.jbuilder +11 -0
- data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +12 -0
- data/storefront/app/views/workarea/api/storefront/taxons/_taxon.json.jbuilder +10 -0
- data/storefront/app/views/workarea/api/storefront/taxons/show.json.jbuilder +7 -0
- data/storefront/app/workers/workarea/remove_authentication_tokens_on_password_changes.rb +19 -0
- data/storefront/bin/rails +18 -0
- data/storefront/config/initializers/config.rb +2 -0
- data/storefront/config/locales/en.yml +13 -0
- data/storefront/config/routes.rb +41 -0
- data/storefront/lib/workarea/api/storefront/engine.rb +10 -0
- data/storefront/lib/workarea/api/storefront.rb +15 -0
- data/storefront/test/documentation/workarea/api/storefront/accounts_documentation_test.rb +70 -0
- data/storefront/test/documentation/workarea/api/storefront/analytics_documentation_test.rb +51 -0
- data/storefront/test/documentation/workarea/api/storefront/assets_documentation_test.rb +32 -0
- data/storefront/test/documentation/workarea/api/storefront/authentication_documentation_test.rb +84 -0
- data/storefront/test/documentation/workarea/api/storefront/cart_items_documentation_test.rb +104 -0
- data/storefront/test/documentation/workarea/api/storefront/carts_documentation_test.rb +121 -0
- data/storefront/test/documentation/workarea/api/storefront/categories_documentation_test.rb +90 -0
- data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +142 -0
- data/storefront/test/documentation/workarea/api/storefront/contacts_documentation_test.rb +39 -0
- data/storefront/test/documentation/workarea/api/storefront/email_signups_documentation_test.rb +53 -0
- data/storefront/test/documentation/workarea/api/storefront/menus_documentation_test.rb +67 -0
- data/storefront/test/documentation/workarea/api/storefront/orders_documentation_test.rb +127 -0
- data/storefront/test/documentation/workarea/api/storefront/pages_documentation_test.rb +66 -0
- data/storefront/test/documentation/workarea/api/storefront/password_resets_documentation_test.rb +30 -0
- data/storefront/test/documentation/workarea/api/storefront/products_documentation_test.rb +64 -0
- data/storefront/test/documentation/workarea/api/storefront/recent_views_documentation_test.rb +116 -0
- data/storefront/test/documentation/workarea/api/storefront/recommendations_documentation_test.rb +68 -0
- data/storefront/test/documentation/workarea/api/storefront/saved_addresses_documentation_test.rb +129 -0
- data/storefront/test/documentation/workarea/api/storefront/saved_credit_cards_documentation_test.rb +129 -0
- data/storefront/test/documentation/workarea/api/storefront/searches_documentation_test.rb +88 -0
- data/storefront/test/documentation/workarea/api/storefront/system_content_documentation_test.rb +66 -0
- data/storefront/test/documentation/workarea/api/storefront/taxons_documentation_test.rb +37 -0
- data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +81 -0
- data/storefront/test/dummy/Rakefile +7 -0
- data/storefront/test/dummy/app/assets/config/manifest.js +4 -0
- data/storefront/test/dummy/app/assets/images/.keep +0 -0
- data/storefront/test/dummy/app/assets/javascripts/application.js +13 -0
- data/storefront/test/dummy/app/assets/stylesheets/application.css +15 -0
- data/storefront/test/dummy/app/controllers/application_controller.rb +3 -0
- data/storefront/test/dummy/app/controllers/concerns/.keep +0 -0
- data/storefront/test/dummy/app/helpers/application_helper.rb +2 -0
- data/storefront/test/dummy/app/jobs/application_job.rb +2 -0
- data/storefront/test/dummy/app/mailers/.keep +0 -0
- data/storefront/test/dummy/app/mailers/application_mailer.rb +4 -0
- data/storefront/test/dummy/app/models/.keep +0 -0
- data/storefront/test/dummy/app/models/concerns/.keep +0 -0
- data/storefront/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/storefront/test/dummy/app/views/layouts/mailer.html.erb +13 -0
- data/storefront/test/dummy/app/views/layouts/mailer.text.erb +1 -0
- data/storefront/test/dummy/bin/bundle +3 -0
- data/storefront/test/dummy/bin/rails +4 -0
- data/storefront/test/dummy/bin/rake +4 -0
- data/storefront/test/dummy/bin/setup +34 -0
- data/storefront/test/dummy/bin/update +29 -0
- data/storefront/test/dummy/config/application.rb +25 -0
- data/storefront/test/dummy/config/boot.rb +5 -0
- data/storefront/test/dummy/config/cable.yml +9 -0
- data/storefront/test/dummy/config/environment.rb +5 -0
- data/storefront/test/dummy/config/environments/development.rb +55 -0
- data/storefront/test/dummy/config/environments/production.rb +86 -0
- data/storefront/test/dummy/config/environments/test.rb +43 -0
- data/storefront/test/dummy/config/initializers/application_controller_renderer.rb +6 -0
- data/storefront/test/dummy/config/initializers/assets.rb +11 -0
- data/storefront/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/storefront/test/dummy/config/initializers/cookies_serializer.rb +5 -0
- data/storefront/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
- data/storefront/test/dummy/config/initializers/inflections.rb +16 -0
- data/storefront/test/dummy/config/initializers/mime_types.rb +4 -0
- data/storefront/test/dummy/config/initializers/new_framework_defaults.rb +21 -0
- data/storefront/test/dummy/config/initializers/session_store.rb +3 -0
- data/storefront/test/dummy/config/initializers/workarea.rb +8 -0
- data/storefront/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/storefront/test/dummy/config/locales/en.yml +23 -0
- data/storefront/test/dummy/config/puma.rb +47 -0
- data/storefront/test/dummy/config/routes.rb +6 -0
- data/storefront/test/dummy/config/secrets.yml +22 -0
- data/storefront/test/dummy/config/spring.rb +6 -0
- data/storefront/test/dummy/config.ru +4 -0
- data/storefront/test/dummy/db/seeds.rb +2 -0
- data/storefront/test/dummy/log/.keep +0 -0
- data/storefront/test/dummy/public/404.html +67 -0
- data/storefront/test/dummy/public/422.html +67 -0
- data/storefront/test/dummy/public/500.html +66 -0
- data/storefront/test/dummy/public/apple-touch-icon-precomposed.png +0 -0
- data/storefront/test/dummy/public/apple-touch-icon.png +0 -0
- data/storefront/test/dummy/public/favicon.ico +1 -0
- data/storefront/test/integration/workarea/api/storefront/accounts_integration_test.rb +49 -0
- data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +36 -0
- data/storefront/test/integration/workarea/api/storefront/assets_integration_test.rb +24 -0
- data/storefront/test/integration/workarea/api/storefront/authentication_integration_test.rb +50 -0
- data/storefront/test/integration/workarea/api/storefront/authentication_tokens_integration_test.rb +87 -0
- data/storefront/test/integration/workarea/api/storefront/cart_items_integration_test.rb +149 -0
- data/storefront/test/integration/workarea/api/storefront/carts_integration_test.rb +114 -0
- data/storefront/test/integration/workarea/api/storefront/categories_integration_test.rb +84 -0
- data/storefront/test/integration/workarea/api/storefront/checkouts_integration_test.rb +203 -0
- data/storefront/test/integration/workarea/api/storefront/contacts_integration_test.rb +28 -0
- data/storefront/test/integration/workarea/api/storefront/email_signups_integration_test.rb +35 -0
- data/storefront/test/integration/workarea/api/storefront/menus_integration_test.rb +53 -0
- data/storefront/test/integration/workarea/api/storefront/orders_integration_test.rb +115 -0
- data/storefront/test/integration/workarea/api/storefront/pages_integration_test.rb +57 -0
- data/storefront/test/integration/workarea/api/storefront/password_resets_integration_test.rb +20 -0
- data/storefront/test/integration/workarea/api/storefront/products_integration_test.rb +50 -0
- data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +118 -0
- data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +51 -0
- data/storefront/test/integration/workarea/api/storefront/saved_addresses_integration_test.rb +100 -0
- data/storefront/test/integration/workarea/api/storefront/saved_credit_cards_integration_test.rb +107 -0
- data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +128 -0
- data/storefront/test/integration/workarea/api/storefront/system_content_integration_test.rb +35 -0
- data/storefront/test/integration/workarea/api/storefront/taxons_integration_test.rb +44 -0
- data/storefront/test/integration/workarea/api/storefront/user_carts_integration_test.rb +55 -0
- data/storefront/test/models/workarea/user/authentication_token_test.rb +30 -0
- data/storefront/test/support/authentication_test.rb +25 -0
- data/storefront/test/support/orders_test.rb +18 -0
- data/storefront/test/test_helper.rb +10 -0
- data/storefront/workarea-api-storefront.gemspec +18 -0
- data/workarea-api.gemspec +25 -0
- metadata +741 -0
@@ -0,0 +1,58 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
{
|
4
|
+
"name": "page",
|
5
|
+
"description": "Current page"
|
6
|
+
},
|
7
|
+
{
|
8
|
+
"name": "sort_by",
|
9
|
+
"description": "Field on which to sort (see responses for possible values)"
|
10
|
+
},
|
11
|
+
{
|
12
|
+
"name": "sort_direction",
|
13
|
+
"description": "Direction to sort (asc or desc)"
|
14
|
+
}
|
15
|
+
],
|
16
|
+
"response_fields": [
|
17
|
+
|
18
|
+
],
|
19
|
+
"requests": [
|
20
|
+
{
|
21
|
+
"request_headers": {
|
22
|
+
},
|
23
|
+
"request_query_parameters": {
|
24
|
+
"page": "1",
|
25
|
+
"sort_by": "created_at",
|
26
|
+
"sort_direction": "desc"
|
27
|
+
},
|
28
|
+
"response_headers": {
|
29
|
+
"X-Frame-Options": "SAMEORIGIN",
|
30
|
+
"X-XSS-Protection": "1; mode=block",
|
31
|
+
"X-Content-Type-Options": "nosniff",
|
32
|
+
"X-Download-Options": "noopen",
|
33
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
34
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
35
|
+
"Content-Type": "application/json; charset=utf-8",
|
36
|
+
"ETag": "W/\"dee327c1543a978c05168695949b287f\"",
|
37
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
38
|
+
"X-Request-Id": "8543309c-f212-4102-be13-4330e28b2f44",
|
39
|
+
"X-Runtime": "0.006967",
|
40
|
+
"Expires": "0",
|
41
|
+
"Content-Length": "967"
|
42
|
+
},
|
43
|
+
"request_method": "GET",
|
44
|
+
"request_path": "/api/admin/navigation_taxons?page=1&sort_by=created_at&sort_direction=desc",
|
45
|
+
"request_body": null,
|
46
|
+
"request_content_type": null,
|
47
|
+
"response_status": 200,
|
48
|
+
"response_status_text": "OK",
|
49
|
+
"response_body": "{\n \"navigation_taxons\": [\n {\n \"_id\": \"5d5dbcd0d4322a4b69d7895a\",\n \"children_count\": 0,\n \"created_at\": \"2019-08-21T21:51:12.979Z\",\n \"depth\": 1,\n \"name\": \"Test Taxon\",\n \"navigable_id\": null,\n \"navigable_slug\": null,\n \"navigable_type\": null,\n \"parent_id\": \"5d5dbcd0d4322a4b69d7895b\",\n \"parent_ids\": [\n \"5d5dbcd0d4322a4b69d7895b\"\n ],\n \"position\": 0,\n \"updated_at\": \"2019-08-21T21:51:12.979Z\",\n \"url\": null\n },\n {\n \"_id\": \"5d5dbcd0d4322a4b69d7895b\",\n \"children_count\": 2,\n \"created_at\": \"2019-08-21T21:51:12.972Z\",\n \"depth\": 0,\n \"name\": \"Home\",\n \"navigable_id\": null,\n \"navigable_slug\": null,\n \"navigable_type\": null,\n \"parent_id\": null,\n \"parent_ids\": [\n\n ],\n \"position\": 0,\n \"updated_at\": \"2019-08-21T21:51:12.998Z\",\n \"url\": \"/\"\n },\n {\n \"_id\": \"5d5dbcd0d4322a4b69d7895c\",\n \"children_count\": 0,\n \"created_at\": \"2019-08-21T21:51:12.993Z\",\n \"depth\": 1,\n \"name\": \"Test Taxon\",\n \"navigable_id\": null,\n \"navigable_slug\": null,\n \"navigable_type\": null,\n \"parent_id\": \"5d5dbcd0d4322a4b69d7895b\",\n \"parent_ids\": [\n \"5d5dbcd0d4322a4b69d7895b\"\n ],\n \"position\": 1,\n \"updated_at\": \"2019-08-21T21:51:12.993Z\",\n \"url\": null\n }\n ]\n}",
|
50
|
+
"response_content_type": "application/json",
|
51
|
+
"curl": "curl -g \"https://www.example.com/api/admin/navigation_taxons?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
|
52
|
+
}
|
53
|
+
],
|
54
|
+
"resource": "Navigation taxonomy",
|
55
|
+
"description": "Listing taxons",
|
56
|
+
"route": "/api/admin/navigation_taxons",
|
57
|
+
"http_method": "GET"
|
58
|
+
}
|
@@ -0,0 +1,42 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
"Content-Type": "application/x-www-form-urlencoded"
|
12
|
+
},
|
13
|
+
"request_query_parameters": {
|
14
|
+
},
|
15
|
+
"response_headers": {
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
19
|
+
"X-Download-Options": "noopen",
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
22
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
23
|
+
"X-Request-Id": "f73eb101-58ae-4c8b-915a-e1a00a7fbcf8",
|
24
|
+
"X-Runtime": "0.011319",
|
25
|
+
"Expires": "0"
|
26
|
+
},
|
27
|
+
"request_method": "DELETE",
|
28
|
+
"request_path": "/api/admin/navigation_taxons/5d5dbcd1d4322a4b69d78960",
|
29
|
+
"request_body": null,
|
30
|
+
"request_content_type": "application/x-www-form-urlencoded",
|
31
|
+
"response_status": 204,
|
32
|
+
"response_status_text": "No Content",
|
33
|
+
"response_body": null,
|
34
|
+
"response_content_type": null,
|
35
|
+
"curl": "curl \"https://www.example.com/api/admin/navigation_taxons/5d5dbcd1d4322a4b69d78960\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
|
36
|
+
}
|
37
|
+
],
|
38
|
+
"resource": "Navigation taxonomy",
|
39
|
+
"description": "Removing a navigation taxon",
|
40
|
+
"route": "/api/admin/navigation_taxons/:id",
|
41
|
+
"http_method": "DELETE"
|
42
|
+
}
|
@@ -0,0 +1,44 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
},
|
12
|
+
"request_query_parameters": {
|
13
|
+
},
|
14
|
+
"response_headers": {
|
15
|
+
"X-Frame-Options": "SAMEORIGIN",
|
16
|
+
"X-XSS-Protection": "1; mode=block",
|
17
|
+
"X-Content-Type-Options": "nosniff",
|
18
|
+
"X-Download-Options": "noopen",
|
19
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
20
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
21
|
+
"Content-Type": "application/json; charset=utf-8",
|
22
|
+
"ETag": "W/\"5074164767a48dd518dbd01a78894b31\"",
|
23
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
24
|
+
"X-Request-Id": "b45cfce9-aa27-4fc5-a626-13c7444dbc69",
|
25
|
+
"X-Runtime": "0.005554",
|
26
|
+
"Expires": "0",
|
27
|
+
"Content-Length": "353"
|
28
|
+
},
|
29
|
+
"request_method": "GET",
|
30
|
+
"request_path": "/api/admin/navigation_taxons/5d5dbcd2d4322a4b69d7896c",
|
31
|
+
"request_body": null,
|
32
|
+
"request_content_type": null,
|
33
|
+
"response_status": 200,
|
34
|
+
"response_status_text": "OK",
|
35
|
+
"response_body": "{\n \"navigation_taxon\": {\n \"_id\": \"5d5dbcd2d4322a4b69d7896c\",\n \"children_count\": 0,\n \"created_at\": \"2019-08-21T21:51:14.757Z\",\n \"depth\": 1,\n \"name\": \"Test Taxon\",\n \"navigable_id\": null,\n \"navigable_slug\": null,\n \"navigable_type\": null,\n \"parent_id\": \"5d5dbcd2d4322a4b69d7896d\",\n \"parent_ids\": [\n \"5d5dbcd2d4322a4b69d7896d\"\n ],\n \"position\": 0,\n \"updated_at\": \"2019-08-21T21:51:14.757Z\",\n \"url\": null\n }\n}",
|
36
|
+
"response_content_type": "application/json",
|
37
|
+
"curl": "curl -g \"https://www.example.com/api/admin/navigation_taxons/5d5dbcd2d4322a4b69d7896c\" -X GET "
|
38
|
+
}
|
39
|
+
],
|
40
|
+
"resource": "Navigation taxonomy",
|
41
|
+
"description": "Showing a navigation taxon",
|
42
|
+
"route": "/api/admin/navigation_taxons/:id",
|
43
|
+
"http_method": "GET"
|
44
|
+
}
|
@@ -0,0 +1,42 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
"Content-Type": "application/json"
|
12
|
+
},
|
13
|
+
"request_query_parameters": {
|
14
|
+
},
|
15
|
+
"response_headers": {
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
19
|
+
"X-Download-Options": "noopen",
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
22
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
23
|
+
"X-Request-Id": "9a67dd97-5691-4961-86a6-55cccb82f462",
|
24
|
+
"X-Runtime": "0.017186",
|
25
|
+
"Expires": "0"
|
26
|
+
},
|
27
|
+
"request_method": "PATCH",
|
28
|
+
"request_path": "/api/admin/navigation_taxons/5d5dbcd2d4322a4b69d78966",
|
29
|
+
"request_body": "{\"navigation_taxon\":{\"name\":\"foo\"}}",
|
30
|
+
"request_content_type": "application/json",
|
31
|
+
"response_status": 204,
|
32
|
+
"response_status_text": "No Content",
|
33
|
+
"response_body": null,
|
34
|
+
"response_content_type": null,
|
35
|
+
"curl": "curl \"https://www.example.com/api/admin/navigation_taxons/5d5dbcd2d4322a4b69d78966\" -d '{\"navigation_taxon\":{\"name\":\"foo\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
|
36
|
+
}
|
37
|
+
],
|
38
|
+
"resource": "Navigation taxonomy",
|
39
|
+
"description": "Updating a navigation taxons",
|
40
|
+
"route": "/api/admin/navigation_taxons/:id",
|
41
|
+
"http_method": "PATCH"
|
42
|
+
}
|
@@ -0,0 +1,58 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
{
|
4
|
+
"name": "page",
|
5
|
+
"description": "Current page"
|
6
|
+
},
|
7
|
+
{
|
8
|
+
"name": "sort_by",
|
9
|
+
"description": "Field on which to sort (see responses for possible values)"
|
10
|
+
},
|
11
|
+
{
|
12
|
+
"name": "sort_direction",
|
13
|
+
"description": "Direction to sort (asc or desc)"
|
14
|
+
}
|
15
|
+
],
|
16
|
+
"response_fields": [
|
17
|
+
|
18
|
+
],
|
19
|
+
"requests": [
|
20
|
+
{
|
21
|
+
"request_headers": {
|
22
|
+
},
|
23
|
+
"request_query_parameters": {
|
24
|
+
"page": "1",
|
25
|
+
"sort_by": "created_at",
|
26
|
+
"sort_direction": "desc "
|
27
|
+
},
|
28
|
+
"response_headers": {
|
29
|
+
"X-Frame-Options": "SAMEORIGIN",
|
30
|
+
"X-XSS-Protection": "1; mode=block",
|
31
|
+
"X-Content-Type-Options": "nosniff",
|
32
|
+
"X-Download-Options": "noopen",
|
33
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
34
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
35
|
+
"Content-Type": "application/json; charset=utf-8",
|
36
|
+
"ETag": "W/\"39ce482c07bf8a7a23e1eeb17bc1af2b\"",
|
37
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
38
|
+
"X-Request-Id": "0534490d-5284-4ea2-a5f8-af2e6b3b0d13",
|
39
|
+
"X-Runtime": "0.013140",
|
40
|
+
"Expires": "0",
|
41
|
+
"Content-Length": "4254"
|
42
|
+
},
|
43
|
+
"request_method": "GET",
|
44
|
+
"request_path": "/api/admin/orders?page=1&sort_by=created_at&sort_direction=desc+",
|
45
|
+
"request_body": null,
|
46
|
+
"request_content_type": null,
|
47
|
+
"response_status": 200,
|
48
|
+
"response_status_text": "OK",
|
49
|
+
"response_body": "{\n \"orders\": [\n {\n \"_id\": \"1001\",\n \"canceled_at\": null,\n \"checkout_by_id\": null,\n \"checkout_started_at\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-08-21T21:50:24.890Z\",\n \"discount_ids\": [\n\n ],\n \"email\": \"bcrouse-new@workarea.com\",\n \"ip_address\": null,\n \"items\": [\n {\n \"_id\": \"5d5dbca0d4322a4b69d78540\",\n \"category_ids\": [\n\n ],\n \"created_at\": \"2019-08-21T21:50:24.890Z\",\n \"customizations\": {\n },\n \"discountable\": true,\n \"free_gift\": false,\n \"price_adjustments\": [\n {\n \"_id\": \"5d5dbca2d4322a4b69d7857f\",\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"calculator\": \"Workarea::Pricing::Calculators::ItemCalculator\",\n \"created_at\": null,\n \"data\": {\n \"on_sale\": false,\n \"original_price\": 5.0,\n \"tax_code\": null\n },\n \"description\": \"Item Subtotal\",\n \"price\": \"item\",\n \"quantity\": 2,\n \"updated_at\": null\n }\n ],\n \"product_attributes\": {\n \"_id\": \"0F90E0586D\",\n \"tags\": [\n\n ],\n \"active\": {\n \"en\": true\n },\n \"subscribed_user_ids\": [\n\n ],\n \"details\": {\n \"en\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n }\n },\n \"filters\": {\n \"en\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n }\n },\n \"template\": \"generic\",\n \"purchasable\": true,\n \"name\": {\n \"en\": \"Test Product\"\n },\n \"digital\": false,\n \"slug\": \"test-product\",\n \"updated_at\": \"2019-08-21T21:50:24.657Z\",\n \"created_at\": \"2019-08-21T21:50:21.733Z\",\n \"variants\": [\n {\n \"_id\": \"5d5dbc9dd4322a4b69d7850d\",\n \"active\": {\n \"en\": true\n },\n \"details\": {\n \"en\": {\n }\n },\n \"sku\": \"SKU\",\n \"name\": {\n \"en\": \"SKU\"\n },\n \"position\": 0\n }\n ],\n \"last_indexed_at\": \"2019-08-21T21:50:24.742Z\"\n },\n \"product_id\": \"0F90E0586D\",\n \"quantity\": 2,\n \"sku\": \"SKU\",\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:24.890Z\",\n \"via\": null\n }\n ],\n \"lock_expires_at\": null,\n \"metrics_saved_at\": \"2019-08-21T21:50:27.312Z\",\n \"placed_at\": \"2019-08-21T21:50:27.129Z\",\n \"pricing_cache_key\": \"f467ba59268880433f7083f2ac0a4279de777747\",\n \"promo_codes\": [\n\n ],\n \"reminded_at\": null,\n \"shipping_total\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"source\": null,\n \"subscribed_user_ids\": [\n\n ],\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"token\": \"xeeuLKT31WyjY59YTWcgmFoy\",\n \"total_price\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:27.132Z\",\n \"user_activity_id\": null,\n \"user_agent\": null,\n \"user_id\": null\n },\n {\n \"_id\": \"1000\",\n \"canceled_at\": null,\n \"checkout_by_id\": null,\n \"checkout_started_at\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-08-21T21:50:21.897Z\",\n \"discount_ids\": [\n\n ],\n \"email\": \"bcrouse-new@workarea.com\",\n \"ip_address\": null,\n \"items\": [\n {\n \"_id\": \"5d5dbc9dd4322a4b69d7850e\",\n \"category_ids\": [\n\n ],\n \"created_at\": \"2019-08-21T21:50:21.896Z\",\n \"customizations\": {\n },\n \"discountable\": true,\n \"free_gift\": false,\n \"price_adjustments\": [\n {\n \"_id\": \"5d5dbc9fd4322a4b69d78536\",\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"calculator\": \"Workarea::Pricing::Calculators::ItemCalculator\",\n \"created_at\": null,\n \"data\": {\n \"on_sale\": false,\n \"original_price\": 5.0,\n \"tax_code\": null\n },\n \"description\": \"Item Subtotal\",\n \"price\": \"item\",\n \"quantity\": 2,\n \"updated_at\": null\n }\n ],\n \"product_attributes\": {\n \"_id\": \"0F90E0586D\",\n \"tags\": [\n\n ],\n \"active\": {\n \"en\": true\n },\n \"subscribed_user_ids\": [\n\n ],\n \"details\": {\n \"en\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n }\n },\n \"filters\": {\n \"en\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n }\n },\n \"template\": \"generic\",\n \"purchasable\": true,\n \"name\": {\n \"en\": \"Test Product\"\n },\n \"digital\": false,\n \"slug\": \"test-product\",\n \"updated_at\": \"2019-08-21T21:50:21.733Z\",\n \"created_at\": \"2019-08-21T21:50:21.733Z\",\n \"variants\": [\n {\n \"_id\": \"5d5dbc9dd4322a4b69d7850d\",\n \"active\": {\n \"en\": true\n },\n \"details\": {\n \"en\": {\n }\n },\n \"sku\": \"SKU\",\n \"name\": {\n \"en\": \"SKU\"\n },\n \"position\": 0\n }\n ],\n \"last_indexed_at\": \"2019-08-21T21:50:21.878Z\"\n },\n \"product_id\": \"0F90E0586D\",\n \"quantity\": 2,\n \"sku\": \"SKU\",\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:21.896Z\",\n \"via\": null\n }\n ],\n \"lock_expires_at\": null,\n \"metrics_saved_at\": \"2019-08-21T21:50:24.321Z\",\n \"placed_at\": \"2019-08-21T21:50:24.149Z\",\n \"pricing_cache_key\": \"578f6f63239199653be4fb309fdebf22cd1dca10\",\n \"promo_codes\": [\n\n ],\n \"reminded_at\": null,\n \"shipping_total\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"source\": null,\n \"subscribed_user_ids\": [\n\n ],\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"token\": \"439tPWVDsKfkqNJZgFAW3J5v\",\n \"total_price\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:24.153Z\",\n \"user_activity_id\": null,\n \"user_agent\": null,\n \"user_id\": null\n }\n ]\n}",
|
50
|
+
"response_content_type": "application/json",
|
51
|
+
"curl": "curl -g \"https://www.example.com/api/admin/orders?page=1&sort_by=created_at&sort_direction=desc+\" -X GET "
|
52
|
+
}
|
53
|
+
],
|
54
|
+
"resource": "Orders",
|
55
|
+
"description": "Listing orders",
|
56
|
+
"route": "/api/admin/orders",
|
57
|
+
"http_method": "GET"
|
58
|
+
}
|
@@ -0,0 +1,44 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
},
|
12
|
+
"request_query_parameters": {
|
13
|
+
},
|
14
|
+
"response_headers": {
|
15
|
+
"X-Frame-Options": "SAMEORIGIN",
|
16
|
+
"X-XSS-Protection": "1; mode=block",
|
17
|
+
"X-Content-Type-Options": "nosniff",
|
18
|
+
"X-Download-Options": "noopen",
|
19
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
20
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
21
|
+
"Content-Type": "application/json; charset=utf-8",
|
22
|
+
"ETag": "W/\"f870f0afa3ec87dd338c9aaefac4364d\"",
|
23
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
24
|
+
"X-Request-Id": "8c2593f6-369e-4cda-b9ee-45293db07901",
|
25
|
+
"X-Runtime": "0.016652",
|
26
|
+
"Expires": "0",
|
27
|
+
"Content-Length": "4703"
|
28
|
+
},
|
29
|
+
"request_method": "GET",
|
30
|
+
"request_path": "/api/admin/orders/1234",
|
31
|
+
"request_body": null,
|
32
|
+
"request_content_type": null,
|
33
|
+
"response_status": 200,
|
34
|
+
"response_status_text": "OK",
|
35
|
+
"response_body": "{\n \"order\": {\n \"_id\": \"1234\",\n \"canceled_at\": null,\n \"checkout_by_id\": null,\n \"checkout_started_at\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-08-21T21:50:38.045Z\",\n \"discount_ids\": [\n\n ],\n \"email\": \"bcrouse-new@workarea.com\",\n \"ip_address\": null,\n \"items\": [\n {\n \"_id\": \"5d5dbcaed4322a4b69d7866a\",\n \"category_ids\": [\n\n ],\n \"created_at\": \"2019-08-21T21:50:38.044Z\",\n \"customizations\": {\n },\n \"discountable\": true,\n \"free_gift\": false,\n \"price_adjustments\": [\n {\n \"_id\": \"5d5dbcafd4322a4b69d78692\",\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"calculator\": \"Workarea::Pricing::Calculators::ItemCalculator\",\n \"created_at\": null,\n \"data\": {\n \"on_sale\": false,\n \"original_price\": 5.0,\n \"tax_code\": null\n },\n \"description\": \"Item Subtotal\",\n \"price\": \"item\",\n \"quantity\": 2,\n \"updated_at\": null\n }\n ],\n \"product_attributes\": {\n \"_id\": \"342D34776D\",\n \"tags\": [\n\n ],\n \"active\": {\n \"en\": true\n },\n \"subscribed_user_ids\": [\n\n ],\n \"details\": {\n \"en\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n }\n },\n \"filters\": {\n \"en\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n }\n },\n \"template\": \"generic\",\n \"purchasable\": true,\n \"name\": {\n \"en\": \"Test Product\"\n },\n \"digital\": false,\n \"slug\": \"test-product\",\n \"updated_at\": \"2019-08-21T21:50:37.876Z\",\n \"created_at\": \"2019-08-21T21:50:37.876Z\",\n \"variants\": [\n {\n \"_id\": \"5d5dbcadd4322a4b69d78669\",\n \"active\": {\n \"en\": true\n },\n \"details\": {\n \"en\": {\n }\n },\n \"sku\": \"SKU\",\n \"name\": {\n \"en\": \"SKU\"\n },\n \"position\": 0\n }\n ],\n \"last_indexed_at\": \"2019-08-21T21:50:38.029Z\"\n },\n \"product_id\": \"342D34776D\",\n \"quantity\": 2,\n \"sku\": \"SKU\",\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:38.044Z\",\n \"via\": null\n }\n ],\n \"lock_expires_at\": null,\n \"metrics_saved_at\": \"2019-08-21T21:50:40.449Z\",\n \"placed_at\": \"2019-08-21T21:50:40.271Z\",\n \"pricing_cache_key\": \"61decf1431fc672399c64fb960b3d15f99ab4d86\",\n \"promo_codes\": [\n\n ],\n \"reminded_at\": null,\n \"shipping_total\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"source\": null,\n \"subscribed_user_ids\": [\n\n ],\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"token\": \"H4X1kFCgBXcqoJe19JXzh8Yu\",\n \"total_price\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:40.274Z\",\n \"user_activity_id\": null,\n \"user_agent\": null,\n \"user_id\": null\n },\n \"payment\": {\n \"_id\": \"1234\",\n \"address\": {\n \"_id\": \"5d5dbcaed4322a4b69d7867a\",\n \"city\": \"Philadelphia\",\n \"company\": null,\n \"country\": \"US\",\n \"created_at\": null,\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"phone_extension\": null,\n \"phone_number\": null,\n \"postal_code\": \"19106\",\n \"region\": \"PA\",\n \"street\": \"22 S. 3rd St.\",\n \"street_2\": \"Second Floor\",\n \"updated_at\": null\n },\n \"created_at\": \"2019-08-21T21:50:38.344Z\",\n \"credit_card\": {\n \"_id\": \"5d5dbcafd4322a4b69d78689\",\n \"amount\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"created_at\": null,\n \"display_number\": \"XXXX-XXXX-XXXX-1\",\n \"issuer\": \"Test Card\",\n \"month\": 1,\n \"saved_card_id\": null,\n \"token\": \"1\",\n \"updated_at\": \"2019-08-21T21:50:40.023Z\",\n \"year\": 2020\n },\n \"profile_id\": \"5d5dbcaed4322a4b69d78688\",\n \"updated_at\": \"2019-08-21T21:50:40.032Z\"\n },\n \"payment_transactions\": [\n {\n \"_id\": \"5d5dbcb0d4322a4b69d78696\",\n \"action\": \"authorize\",\n \"amount\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"canceled_at\": null,\n \"cancellation\": null,\n \"created_at\": \"2019-08-21T21:50:40.026Z\",\n \"payment_id\": \"1234\",\n \"reference_id\": null,\n \"response\": {\n \"success\": true,\n \"message\": \"Bogus Gateway: Forced success\",\n \"params\": {\n \"authorized_amount\": \"11.00\"\n },\n \"options\": {\n \"test\": true,\n \"authorization\": \"53433\",\n \"avs_result\": {\n \"code\": null,\n \"message\": null,\n \"street_match\": null,\n \"postal_match\": null\n },\n \"cvv_result\": null\n }\n },\n \"success\": true,\n \"tender_id\": \"5d5dbcafd4322a4b69d78689\",\n \"updated_at\": \"2019-08-21T21:50:40.026Z\"\n }\n ],\n \"fulfillment\": {\n \"_id\": \"1234\",\n \"created_at\": \"2019-08-21T21:50:40.455Z\",\n \"items\": [\n {\n \"_id\": \"5d5dbcb0d4322a4b69d78697\",\n \"created_at\": null,\n \"order_item_id\": \"5d5dbcaed4322a4b69d7866a\",\n \"quantity\": 2,\n \"updated_at\": null\n }\n ],\n \"updated_at\": \"2019-08-21T21:50:40.455Z\"\n },\n \"shippings\": [\n {\n \"_id\": \"5d5dbcaed4322a4b69d7866b\",\n \"address\": {\n \"_id\": \"5d5dbcaed4322a4b69d7866c\",\n \"city\": \"Philadelphia\",\n \"company\": null,\n \"country\": \"US\",\n \"created_at\": null,\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"phone_extension\": null,\n \"phone_number\": null,\n \"postal_code\": \"19106\",\n \"region\": \"PA\",\n \"street\": \"22 S. 3rd St.\",\n \"street_2\": \"Second Floor\",\n \"updated_at\": null\n },\n \"created_at\": \"2019-08-21T21:50:38.141Z\",\n \"discount_ids\": [\n\n ],\n \"instructions\": \"\",\n \"order_id\": \"1234\",\n \"price_adjustments\": [\n {\n \"_id\": \"5d5dbcaed4322a4b69d78687\",\n \"amount\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"calculator\": \"Workarea::Shipping\",\n \"created_at\": null,\n \"data\": {\n \"tax_code\": null\n },\n \"description\": \"Test 13\",\n \"price\": \"shipping\",\n \"quantity\": 1,\n \"updated_at\": null\n }\n ],\n \"quantities\": {\n },\n \"shipping_service\": {\n \"_id\": \"5d5dbcaed4322a4b69d78678\",\n \"carrier\": null,\n \"created_at\": null,\n \"name\": \"Test 13\",\n \"service_code\": null,\n \"tax_code\": null,\n \"updated_at\": null\n },\n \"shipping_total\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:39.484Z\"\n }\n ]\n}",
|
36
|
+
"response_content_type": "application/json",
|
37
|
+
"curl": "curl -g \"https://www.example.com/api/admin/orders/1234\" -X GET "
|
38
|
+
}
|
39
|
+
],
|
40
|
+
"resource": "Orders",
|
41
|
+
"description": "Showing an order",
|
42
|
+
"route": "/api/admin/orders/:id",
|
43
|
+
"http_method": "GET"
|
44
|
+
}
|
@@ -0,0 +1,68 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
{
|
4
|
+
"name": "page",
|
5
|
+
"description": "Current page"
|
6
|
+
},
|
7
|
+
{
|
8
|
+
"name": "sort_by",
|
9
|
+
"description": "Field on which to sort (see responses for possible values)"
|
10
|
+
},
|
11
|
+
{
|
12
|
+
"name": "sort_direction",
|
13
|
+
"description": "Direction to sort (asc or desc)"
|
14
|
+
},
|
15
|
+
{
|
16
|
+
"name": "placed_at_greater_than",
|
17
|
+
"description": "Start of a placed_at date range"
|
18
|
+
},
|
19
|
+
{
|
20
|
+
"name": "placed_at_less_than",
|
21
|
+
"description": "End of a placed_at date range"
|
22
|
+
}
|
23
|
+
],
|
24
|
+
"response_fields": [
|
25
|
+
|
26
|
+
],
|
27
|
+
"requests": [
|
28
|
+
{
|
29
|
+
"request_headers": {
|
30
|
+
},
|
31
|
+
"request_query_parameters": {
|
32
|
+
"page": "1",
|
33
|
+
"sort_by": "created_at",
|
34
|
+
"sort_direction": "desc",
|
35
|
+
"placed_at_greater_than": "2019-08-06 21:50:37 UTC",
|
36
|
+
"placed_at_less_than": "2019-08-08 21:50:37 UTC"
|
37
|
+
},
|
38
|
+
"response_headers": {
|
39
|
+
"X-Frame-Options": "SAMEORIGIN",
|
40
|
+
"X-XSS-Protection": "1; mode=block",
|
41
|
+
"X-Content-Type-Options": "nosniff",
|
42
|
+
"X-Download-Options": "noopen",
|
43
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
44
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
45
|
+
"Content-Type": "application/json; charset=utf-8",
|
46
|
+
"ETag": "W/\"e69f67c45914437c3894b540dbff015c\"",
|
47
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
48
|
+
"X-Request-Id": "3da811e5-6712-4707-bf20-422df4581498",
|
49
|
+
"X-Runtime": "0.009365",
|
50
|
+
"Expires": "0",
|
51
|
+
"Content-Length": "2133"
|
52
|
+
},
|
53
|
+
"request_method": "GET",
|
54
|
+
"request_path": "/api/admin/orders?page=1&sort_by=created_at&sort_direction=desc&placed_at_greater_than=2019-08-06+21%3A50%3A37+UTC&placed_at_less_than=2019-08-08+21%3A50%3A37+UTC",
|
55
|
+
"request_body": null,
|
56
|
+
"request_content_type": null,
|
57
|
+
"response_status": 200,
|
58
|
+
"response_status_text": "OK",
|
59
|
+
"response_body": "{\n \"orders\": [\n {\n \"_id\": \"1002\",\n \"canceled_at\": null,\n \"checkout_by_id\": null,\n \"checkout_started_at\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-08-21T21:50:34.468Z\",\n \"discount_ids\": [\n\n ],\n \"email\": \"bcrouse-new@workarea.com\",\n \"ip_address\": null,\n \"items\": [\n {\n \"_id\": \"5d5dbcaad4322a4b69d78607\",\n \"category_ids\": [\n\n ],\n \"created_at\": \"2019-08-21T21:50:34.467Z\",\n \"customizations\": {\n },\n \"discountable\": true,\n \"free_gift\": false,\n \"price_adjustments\": [\n {\n \"_id\": \"5d5dbcabd4322a4b69d7865d\",\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"calculator\": \"Workarea::Pricing::Calculators::ItemCalculator\",\n \"created_at\": null,\n \"data\": {\n \"on_sale\": false,\n \"original_price\": 5.0,\n \"tax_code\": null\n },\n \"description\": \"Item Subtotal\",\n \"price\": \"item\",\n \"quantity\": 2,\n \"updated_at\": null\n }\n ],\n \"product_attributes\": {\n \"_id\": \"1C0FC41DF4\",\n \"tags\": [\n\n ],\n \"active\": {\n \"en\": true\n },\n \"subscribed_user_ids\": [\n\n ],\n \"details\": {\n \"en\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n }\n },\n \"filters\": {\n \"en\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n }\n },\n \"template\": \"generic\",\n \"purchasable\": true,\n \"name\": {\n \"en\": \"Test Product\"\n },\n \"digital\": false,\n \"slug\": \"test-product\",\n \"updated_at\": \"2019-08-21T21:50:34.149Z\",\n \"created_at\": \"2019-08-21T21:50:28.250Z\",\n \"variants\": [\n {\n \"_id\": \"5d5dbca4d4322a4b69d7858b\",\n \"active\": {\n \"en\": true\n },\n \"details\": {\n \"en\": {\n }\n },\n \"sku\": \"SKU\",\n \"name\": {\n \"en\": \"SKU\"\n },\n \"position\": 0\n }\n ],\n \"last_indexed_at\": \"2019-08-21T21:50:34.279Z\"\n },\n \"product_id\": \"1C0FC41DF4\",\n \"quantity\": 2,\n \"sku\": \"SKU\",\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:34.467Z\",\n \"via\": null\n }\n ],\n \"lock_expires_at\": null,\n \"metrics_saved_at\": \"2019-08-21T21:50:36.937Z\",\n \"placed_at\": \"2019-08-07T21:50:34.134Z\",\n \"pricing_cache_key\": \"de4cc6c12ae2fa9c7ea4c3e54b195a0034eecc80\",\n \"promo_codes\": [\n\n ],\n \"reminded_at\": null,\n \"shipping_total\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"source\": null,\n \"subscribed_user_ids\": [\n\n ],\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"token\": \"7JbWx9XWJFZEfiWCULbRnGPK\",\n \"total_price\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2019-08-21T21:50:37.087Z\",\n \"user_activity_id\": null,\n \"user_agent\": null,\n \"user_id\": null\n }\n ]\n}",
|
60
|
+
"response_content_type": "application/json",
|
61
|
+
"curl": "curl -g \"https://www.example.com/api/admin/orders?page=1&sort_by=created_at&sort_direction=desc&placed_at_greater_than=2019-08-06+21%3A50%3A37+UTC&placed_at_less_than=2019-08-08+21%3A50%3A37+UTC\" -X GET "
|
62
|
+
}
|
63
|
+
],
|
64
|
+
"resource": "Orders",
|
65
|
+
"description": "Viewing orders by date range",
|
66
|
+
"route": "/api/admin/orders",
|
67
|
+
"http_method": "GET"
|
68
|
+
}
|
@@ -0,0 +1,42 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
"Content-Type": "application/json"
|
12
|
+
},
|
13
|
+
"request_query_parameters": {
|
14
|
+
},
|
15
|
+
"response_headers": {
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
19
|
+
"X-Download-Options": "noopen",
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
22
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
23
|
+
"X-Request-Id": "cf5eeacd-0570-478b-8c1f-94dd3564c4c2",
|
24
|
+
"X-Runtime": "0.181760",
|
25
|
+
"Expires": "0"
|
26
|
+
},
|
27
|
+
"request_method": "PATCH",
|
28
|
+
"request_path": "/api/admin/pages/bulk",
|
29
|
+
"request_body": "{\"pages\":[{\"active\":true,\"created_at\":\"2019-08-21T21:54:48.807Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:48.807Z\"},{\"active\":true,\"created_at\":\"2019-08-21T21:54:48.807Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:48.807Z\"},{\"active\":true,\"created_at\":\"2019-08-21T21:54:48.807Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:48.807Z\"}]}",
|
30
|
+
"request_content_type": "application/json",
|
31
|
+
"response_status": 204,
|
32
|
+
"response_status_text": "No Content",
|
33
|
+
"response_body": null,
|
34
|
+
"response_content_type": null,
|
35
|
+
"curl": "curl \"https://www.example.com/api/admin/pages/bulk\" -d '{\"pages\":[{\"active\":true,\"created_at\":\"2019-08-21T21:54:48.807Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:48.807Z\"},{\"active\":true,\"created_at\":\"2019-08-21T21:54:48.807Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:48.807Z\"},{\"active\":true,\"created_at\":\"2019-08-21T21:54:48.807Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:48.807Z\"}]}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
|
36
|
+
}
|
37
|
+
],
|
38
|
+
"resource": "Pages",
|
39
|
+
"description": "Bulk upserting pages",
|
40
|
+
"route": "/api/admin/pages/bulk",
|
41
|
+
"http_method": "PATCH"
|
42
|
+
}
|
@@ -0,0 +1,46 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
"Content-Type": "application/json"
|
12
|
+
},
|
13
|
+
"request_query_parameters": {
|
14
|
+
},
|
15
|
+
"response_headers": {
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
19
|
+
"X-Download-Options": "noopen",
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
22
|
+
"Location": "/api/admin/pages/5d5dbdabd4322a4b69d793d3",
|
23
|
+
"Content-Type": "application/json; charset=utf-8",
|
24
|
+
"ETag": "W/\"66acfe119cf06f348d807975acc2b021\"",
|
25
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
26
|
+
"X-Request-Id": "2d25c387-8f42-4ef7-8986-bda5bc5879ca",
|
27
|
+
"X-Runtime": "0.049330",
|
28
|
+
"Expires": "0",
|
29
|
+
"Content-Length": "275"
|
30
|
+
},
|
31
|
+
"request_method": "POST",
|
32
|
+
"request_path": "/api/admin/pages",
|
33
|
+
"request_body": "{\"active\":true,\"created_at\":\"2019-08-21T21:54:51.644Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:51.644Z\"}",
|
34
|
+
"request_content_type": "application/json",
|
35
|
+
"response_status": 201,
|
36
|
+
"response_status_text": "Created",
|
37
|
+
"response_body": "{\n \"page\": {\n \"_id\": \"5d5dbdabd4322a4b69d793d3\",\n \"active\": true,\n \"created_at\": \"2019-08-21T21:54:51.644Z\",\n \"display_h1\": true,\n \"name\": \"Test Page\",\n \"show_navigation\": false,\n \"slug\": \"test-page-1\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-08-21T21:54:51.644Z\"\n }\n}",
|
38
|
+
"response_content_type": "application/json",
|
39
|
+
"curl": "curl \"https://www.example.com/api/admin/pages\" -d '{\"active\":true,\"created_at\":\"2019-08-21T21:54:51.644Z\",\"display_h1\":true,\"name\":\"Test Page\",\"show_navigation\":false,\"subscribed_user_ids\":[],\"tags\":[],\"template\":\"generic\",\"updated_at\":\"2019-08-21T21:54:51.644Z\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
40
|
+
}
|
41
|
+
],
|
42
|
+
"resource": "Pages",
|
43
|
+
"description": "Creating a page",
|
44
|
+
"route": "/api/admin/pages",
|
45
|
+
"http_method": "POST"
|
46
|
+
}
|
@@ -0,0 +1,58 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
{
|
4
|
+
"name": "page",
|
5
|
+
"description": "Current page"
|
6
|
+
},
|
7
|
+
{
|
8
|
+
"name": "sort_by",
|
9
|
+
"description": "Field on which to sort (see responses for possible values)"
|
10
|
+
},
|
11
|
+
{
|
12
|
+
"name": "sort_direction",
|
13
|
+
"description": "Direction to sort (asc or desc)"
|
14
|
+
}
|
15
|
+
],
|
16
|
+
"response_fields": [
|
17
|
+
|
18
|
+
],
|
19
|
+
"requests": [
|
20
|
+
{
|
21
|
+
"request_headers": {
|
22
|
+
},
|
23
|
+
"request_query_parameters": {
|
24
|
+
"page": "1",
|
25
|
+
"sort_by": "created_at",
|
26
|
+
"sort_direction": "desc"
|
27
|
+
},
|
28
|
+
"response_headers": {
|
29
|
+
"X-Frame-Options": "SAMEORIGIN",
|
30
|
+
"X-XSS-Protection": "1; mode=block",
|
31
|
+
"X-Content-Type-Options": "nosniff",
|
32
|
+
"X-Download-Options": "noopen",
|
33
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
34
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
35
|
+
"Content-Type": "application/json; charset=utf-8",
|
36
|
+
"ETag": "W/\"3d4b32e59c81ecc7e415f152459fe9ef\"",
|
37
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
38
|
+
"X-Request-Id": "c0e56b81-31c9-47f8-bd57-52c8f51aecff",
|
39
|
+
"X-Runtime": "0.008159",
|
40
|
+
"Expires": "0",
|
41
|
+
"Content-Length": "543"
|
42
|
+
},
|
43
|
+
"request_method": "GET",
|
44
|
+
"request_path": "/api/admin/pages?page=1&sort_by=created_at&sort_direction=desc",
|
45
|
+
"request_body": null,
|
46
|
+
"request_content_type": null,
|
47
|
+
"response_status": 200,
|
48
|
+
"response_status_text": "OK",
|
49
|
+
"response_body": "{\n \"pages\": [\n {\n \"_id\": \"5d5dbda9d4322a4b69d793bf\",\n \"active\": true,\n \"created_at\": \"2019-08-21T21:54:49.689Z\",\n \"display_h1\": true,\n \"name\": \"Test Page\",\n \"show_navigation\": false,\n \"slug\": \"test-page-1\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-08-21T21:54:49.689Z\"\n },\n {\n \"_id\": \"5d5dbda9d4322a4b69d793bd\",\n \"active\": true,\n \"created_at\": \"2019-08-21T21:54:49.626Z\",\n \"display_h1\": true,\n \"name\": \"Test Page\",\n \"show_navigation\": false,\n \"slug\": \"test-page\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-08-21T21:54:49.626Z\"\n }\n ]\n}",
|
50
|
+
"response_content_type": "application/json",
|
51
|
+
"curl": "curl -g \"https://www.example.com/api/admin/pages?page=1&sort_by=created_at&sort_direction=desc\" -X GET "
|
52
|
+
}
|
53
|
+
],
|
54
|
+
"resource": "Pages",
|
55
|
+
"description": "Listing pages",
|
56
|
+
"route": "/api/admin/pages",
|
57
|
+
"http_method": "GET"
|
58
|
+
}
|
@@ -0,0 +1,42 @@
|
|
1
|
+
{
|
2
|
+
"parameters": [
|
3
|
+
|
4
|
+
],
|
5
|
+
"response_fields": [
|
6
|
+
|
7
|
+
],
|
8
|
+
"requests": [
|
9
|
+
{
|
10
|
+
"request_headers": {
|
11
|
+
"Content-Type": "application/json"
|
12
|
+
},
|
13
|
+
"request_query_parameters": {
|
14
|
+
},
|
15
|
+
"response_headers": {
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
19
|
+
"X-Download-Options": "noopen",
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
22
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
23
|
+
"X-Request-Id": "765252e5-6000-420d-8a31-011dff909e70",
|
24
|
+
"X-Runtime": "0.026635",
|
25
|
+
"Expires": "0"
|
26
|
+
},
|
27
|
+
"request_method": "DELETE",
|
28
|
+
"request_path": "/api/admin/pages/5d5dbda8d4322a4b69d7939f",
|
29
|
+
"request_body": null,
|
30
|
+
"request_content_type": "application/json",
|
31
|
+
"response_status": 204,
|
32
|
+
"response_status_text": "No Content",
|
33
|
+
"response_body": null,
|
34
|
+
"response_content_type": null,
|
35
|
+
"curl": "curl \"https://www.example.com/api/admin/pages/5d5dbda8d4322a4b69d7939f\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\""
|
36
|
+
}
|
37
|
+
],
|
38
|
+
"resource": "Pages",
|
39
|
+
"description": "Removing a page",
|
40
|
+
"route": "/api/admin/pages/:id",
|
41
|
+
"http_method": "DELETE"
|
42
|
+
}
|