Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BETA] Upgrading API for Sylius 1.9 and newer #2

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

[BETA] Upgrading API for Sylius 1.9 and newer #2

wants to merge 13 commits into from

Conversation

gplanchat
Copy link
Contributor

@gplanchat gplanchat commented Oct 16, 2021 •
edited
Loading

Create all Admin API endpoints

  • AdminUserToken
    • 👨‍💼 authenticateByPassword
  • Address
    • 👨‍💼 get
  • Adjustment
    • 👨‍💼 get
    • 👨‍💼 list (filtered on on Order Items)
  • Administrator
    • 👨‍💼 get
    • 👨‍💼 create
    • 👨‍💼 list
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • AvatarImage
    • 👨‍💼 get
    • 👨‍💼 create
    • 👨‍💼 delete
  • CatalogPromotionTranslation (v1.11)
    • 👨‍💼 get
  • CatalogPromotion (v1.11)
    • 👨‍💼 get
    • 👨‍💼 create
    • 👨‍💼 list
    • 👨‍💼 upsert
  • Channel
    • 👨‍💼 get
    • 👨‍💼 create
    • 👨‍💼 list
    • 👨‍💼 delete
  • ShopBillingData
    • 👨‍💼 get
    • 👨‍💼 list (filtered on on Channel)
  • Country
    • 👨‍💼 get
    • 👨‍💼 create
    • 👨‍💼 list
    • 👨‍💼 upsert
  • Province
    • 👨‍💼 get
    • 👨‍💼 list (filtered on on Country)
    • 👨‍💼 upsert
  • Currency
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
  • CustomerGroup
    • 👨‍💼 get
    • 👨‍💼 create
    • 👨‍💼 list
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • Customer
    • 👨‍💼 get
  • ExchangeRate
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • Locale
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
  • OrderItemUnit
    • 👨‍💼 get
  • OrderItem
    • 👨‍💼 get
  • Order
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 cancel
    • 👨‍💼 listPayments
    • 👨‍💼 listShipments
  • Payment
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 complete
  • Shipment
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 ship
  • PaymentMethod
    • 👨‍💼 get
  • ProductAssociationTypeTranslation
    • 👨‍💼 get
  • ProductAssociationType
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • ProductImage
    • 👨‍💼 get
    • 👨‍💼 list
  • ProductOptionTranslation
    • 👨‍💼 get
  • ProductOptionValue
    • 👨‍💼 get
  • ProductOption
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 listValues
  • ProductReview
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 upsert
    • 👨‍💼 delete
    • 👨‍💼 accept
    • 👨‍💼 reject
  • ProductTaxon
    • 👨‍💼 get
    • 👨‍💼 list
  • ProductTranslation
    • 👨‍💼 get
  • ProductVariantTranslation
    • 👨‍💼 get
  • ProductVariant
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
  • Product
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • Promotion
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 delete
  • ShippingCategory
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • ShippingMethodTranslation
    • 👨‍💼 get
  • ShippingMethod
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
    • 👨‍💼 archive
    • 👨‍💼 restore
  • TaxCategory
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • TaxonTranslation
    • 👨‍💼 get
    • 👨‍💼 list
  • Taxon
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
  • ZoneMember
    • 👨‍💼 get
    • 👨‍💼 list (filtered on on Zone)
  • Zone
    • 👨‍💼 get
    • 👨‍💼 list
    • 👨‍💼 create
    • 👨‍💼 upsert
    • 👨‍💼 delete
  • VerifyCustomerAccount
    • 👨‍💼 create
    • 👨‍💼 acknowledge
  • ResetPasswordRequest
    • 👨‍💼 create
    • 👨‍💼 acknowledge

Create all Shop API endpoints

  • ShopUserToken
    • 👛 authenticateByPassword
  • Address
    • 👛 list
    • 👛 create
    • 👛 get
    • 👛 delete
  • Adjustment
    • 👛 get
    • 👛 list (filtered on on Order Items)
  • CatalogPromotion
    • 👛 get
  • Channel
    • 👛 get
  • Country
    • 👛 get
    • 👛 list
  • Currency
    • 👛 get
    • 👛 list
  • Customer
    • 👛 get
    • 👛 create
    • 👛 upsert
    • 👛 changePassword
  • Locale
    • 👛 get
    • 👛 list
  • OrderItemUnit
    • 👛 get
  • OrderItem
    • 👛 get
    • 👛 list (filtered on on Order)
    • 👛 create (filtered on on Order)
    • 👛 delete (filtered on on Order)
    • 👛 changeQuantity (filtered on on Order)
    • 👛 listAdjustments (filtered on on Order and OrderItem)
  • Order
    • 👛 get
    • 👛 list
    • 👛 create
    • 👛 upsert
    • 👛 delete
    • 👛 listPaymentMethods
    • 👛 listShipmentMethods
    • 👛 listAdjustments
    • 👛 listItems
    • 👛 choosePayment
    • 👛 chooseShipment
    • 👛 complete
  • Payment
    • 👛 get
    • 👛 listMethods
  • Shipment
    • 👛 get
    • 👛 listMethods
  • PaymentMethod
    • 👛 get
    • 👛 list
  • ProductImage
    • 👛 get
  • ProductOptionValue
    • 👛 get
  • ProductOption
    • 👛 get
  • ProductReview
    • 👛 get
    • 👛 list
    • 👛 create
  • ProductTaxon
    • 👛 get
  • ProductTranslation
    • 👛 get
  • ProductVariantTranslation
    • 👛 get
  • ProductVariant
    • 👛 get
    • 👛 list
  • Product
    • 👛 get
    • 👛 getBySlug
    • 👛 list
  • ShippingMethodTranslation
    • 👛 get
  • ShippingMethod
    • 👛 get
    • 👛 list
  • TaxonTranslation
    • 👛 get
  • Taxon
    • 👛 get
    • 👛 list
  • VerifyCustomerAccount
    • 👛 create
    • 👛 verify
  • ResetPasswordRequest
    • 👛 create
    • 👛 verify

Other

  • Create a way to differentiate shop and admin APIs
  • Keep classes to access the deprecated API endpoints (Admin API and Store API)

Breaking Changes

We are making the best efforts in order to have the minimum breaking changes.

  • Every class in the namespace Diglin\Sylius\ApiClient\Api were moved to Diglin\Sylius\ApiClient\Api\Legacy

Changes with deprecation notice

  • The class Diglin\Sylius\ApiClient\SyliusClient was renamed Diglin\Sylius\ApiClient\SyliusLegacyClient
  • The class Diglin\Sylius\ApiClient\SyliusClientBuilder was renamed Diglin\Sylius\ApiClient\SyliusLegacyClientBuilder
  • The interface Diglin\Sylius\ApiClient\SyliusClientBuilderInterface was renamed Diglin\Sylius\ApiClient\SyliusLegacyClientBuilderInterface
  • The interface Diglin\Sylius\ApiClient\SyliusClientInterface was renamed Diglin\Sylius\ApiClient\SyliusLegacyClientInterface
  • The interface Diglin\Sylius\ApiClient\SyliusClientDecorator was renamed Diglin\Sylius\ApiClient\SyliusLegacyClientDecorator

@gplanchat gplanchat requested a review from sylvainraye October 16, 2021 10:17
@gplanchat gplanchat changed the title Upgrading API for Sylius 1.9 and newer [WIP] Upgrading API for Sylius 1.9 and newer Oct 16, 2021
@gplanchat gplanchat self-assigned this Oct 26, 2021
@gplanchat gplanchat added enhancement New feature or request help wanted Extra attention is needed labels Oct 26, 2021
@gplanchat gplanchat changed the title [WIP] Upgrading API for Sylius 1.9 and newer [GTM] Upgrading API for Sylius 1.9 and newer Apr 9, 2022
@gplanchat gplanchat changed the title [GTM] Upgrading API for Sylius 1.9 and newer [BETA] Upgrading API for Sylius 1.9 and newer Apr 9, 2022
@gplanchat gplanchat closed this May 23, 2022
@gplanchat gplanchat deleted the next branch May 23, 2022 08:54
@gplanchat gplanchat restored the next branch May 23, 2022 09:00
@gplanchat gplanchat reopened this May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sylvainraye sylvainraye Awaiting requested review from sylvainraye

Assignees

@gplanchat gplanchat

Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@gplanchat