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.

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

Subscriptions update #333

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion changelog/2018/changelog-2018-12-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: 'Changelog 2018-12-04'
date: '2018-12-04'
---
- Updated search to return a 400 error explaining the search contains [unsupported characters](/docs/commerce-cloud/api-overview/filtering#supported-characters).
- Updated search to return a 400 error explaining the search contains [unsupported characters](/guides/Getting-Started/filtering#supported-characters).
2 changes: 1 addition & 1 deletion changelog/2021/changelog-2021-01-05.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ date: '2021-01-05'
tags:
- Commerce Manager
---
**Minor** Moved the Swift SDK examples from the API Reference documentation to the community-supported `ios-sdk` repository [Readme file](https://github.com/moltin/ios-sdk/blob/master/README.md).
**Minor** Moved the Swift SDK examples from the API Reference documentation to the community-supported `ios-sdk` repository [Readme file](https://github.com/moltin/ios-sdk/blob/master/README).
2 changes: 1 addition & 1 deletion changelog/2022/changelog-2022-05-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- Commerce Manager
- Product Experience Manager
---
**Major** Added PayPal Express Checkout payment method. For more information, see [PayPal Express Checkout](/docs/commerce-cloud/payments/payment-gateway/configure-paypal-express-checkout) and [PayPal Express Checkout Payments](/docs/api/payments/update-paypal-express-checkout-gateway). You can also use PayPal Express Checkout in Commerce Manager.
**Major** Added PayPal Express Checkout payment method. For more information, see [PayPal Express Checkout](/docs/api/payments/update-paypal-express-checkout-gateway) and [PayPal Express Checkout Payments](/docs/api/payments/update-paypal-express-checkout-gateway). You can also use PayPal Express Checkout in Commerce Manager.

**Major** Commerce Manager: You can now localize your product names and descriptions. See [Configuring Locales](/docs/api/pxm/products/create-product).

Expand Down
4 changes: 2 additions & 2 deletions changelog/2022/changelog-2022-05-26.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ tags:

**Minor** Commerce Manager: When viewing an order, you can now click a product name to view the product details. See [Orders](/docs/commerce-manager/orders/orders-cm).

**Minor** Commerce Manager: New **Total Orders** and **Total Value of All Orders** fields and improved layout available in **Analytics**. See [Analytics](/docs/commerce-cloud/analytics/analytics).
**Minor** Commerce Manager: New **Total Orders** and **Total Value of All Orders** fields and improved layout available in **Analytics**. See [Analytics](/docs/commerce-manager/analytics/).

**Minor** Commerce Manager: The **Rename store** field is now moved to **Settings > Store Settings** page. For more information, see [Renaming a Store](/docs/commerce-cloud/global-project-settings/general-settings).
**Minor** Commerce Manager: The **Rename store** field is now moved to **Settings > Store Settings** page. For more information, see [Renaming a Store](/docs/commerce-manager/settings/general-settings).
2 changes: 1 addition & 1 deletion changelog/2023/2023-08-22-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ hide_blog_post_date: false
* Removed store type label previously displayed next to store names, and replaced with **STORE** label instead to help distinguish from when a user is managing an Organization.
* Added rate limit details for stores under **SYSTEM > Store Settings > General Settings**, which have been reorganized to group together related settings.

For more information, see **[General Settings in Commerce Manager](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/general-settings)**.
For more information, see **[General Settings in Commerce Manager](/docs/commerce-manager/settings/general-settings)**.
2 changes: 1 addition & 1 deletion changelog/2024/2024-04-10-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ hide_blog_post_date: false
---
**MAJOR** We have introduced a new feature, called **Promotions Builder,** powered by our Rule Promotion engine. This feature offers you the flexibility in providing diverse discounts to shoppers, supporting discounts of varying complexities, ranging from code-based customer discounts to Buy X Get Y discounts, fixed price promotions, cart fixed discount, and many more based on your business needs. Moreover, it is compatible with our existing legacy promotions capability, ensuring a smooth transition to the new Promotions Builder. For more information, see **[Promotions Builder in Commerce Manager](https://elasticpath.dev/docs/commerce-cloud/rule-promotions/promotions-in-commerce-manager/overview)**. To create promotions using API, see **[Rule Promotions](https://elasticpath.dev/docs/commerce-cloud/rule-promotions/overview)**. To apply Rule Promotions API in carts and orders, you must enable the **use\_rule\_promotion** field in **[Cart Settings](https://elasticpath.dev/docs/commerce-cloud/carts/cart-management/cart-settings/update-cart-settings)**.

**MINOR** The **[Get all Products](https://elasticpath.dev/docs/pxm/products/ep-pxm-products-api/get-all-products)** and **[Get all Promotions](https://elasticpath.dev/docs/commerce-cloud/promotions/promotion-management/get-all-promotions)** endpoints now support beta filtering. The new syntax is an evolution of the original syntax, and allows more characters and formats. For more information, see **[Beta Filtering](https://elasticpath.dev/docs/commerce-cloud/api-overview/filtering#beta-filtering)**.
**MINOR** The **[Get all Products](https://elasticpath.dev/docs/pxm/products/ep-pxm-products-api/get-all-products)** and **[Get all Promotions](https://elasticpath.dev/docs/commerce-cloud/promotions/promotion-management/get-all-promotions)** endpoints now support beta filtering. The new syntax is an evolution of the original syntax, and allows more characters and formats. For more information, see **[Beta Filtering](https://elasticpath.dev/guides/Getting-Started/filtering#beta-filtering)**.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ getting to it along with a number of other editor improvements.

* Added intro video for the editor.
* Added deep-links. Among other things, this allows us to provide one URL that all users can use to access a specific
part of their account. For example, <https://app.CX-Studio.com/goto/landing-pages> will now take you to the landing
part of their account. For example, `<https://app.CX-Studio.com/goto/landing-pages>` will now take you to the landing
pages section in *your* account.
* Adjusted media policy to allow product images to be used any place where media can be used.
* Updated the Studio UI to account for Shopify plans which use the proxy by default.
Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/single-sign-on/openid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ When users authenticate using an external authentication provider, authenticatio
An authentication realm is a container that consists of the following:

- Users - Represented by [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/overview) objects
- Authentication profiles - Ways for the users to authenticate, such as one or more [OpenID Connect Profiles](/docs/authentication/single-sign-on/openid-connect-profiles-api/openid-connect-profiles-api-overview) or [Password Profiles](/docs/authentication/single-sign-on/password-profiles-api/overview.md)
- Mappings between users and authentication profiles - [User Authentication OpenID Connect Profile Info](/docs/authentication/single-sign-on/user-authentication-openid-connect-profile-api/openid-connect-profile-overview.md) or [User Authentication Password Profile Infos](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/password-profile-overview.md)
- Authentication profiles - Ways for the users to authenticate, such as one or more [OpenID Connect Profiles](/docs/authentication/single-sign-on/openid-connect-profiles-api/openid-connect-profiles-api-overview) or [Password Profiles](/docs/authentication/single-sign-on/password-profiles-api/overview)
- Mappings between users and authentication profiles - [User Authentication OpenID Connect Profile Info](/docs/authentication/single-sign-on/user-authentication-openid-connect-profile-api/openid-connect-profile-overview) or [User Authentication Password Profile Infos](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/password-profile-overview)

Here's a domain diagram showing these relationships
![authentication realm](/assets/authentication-realm-domain.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_label: User Authentication Password Profile Infos
sidebar_position: 10
---

The `user-authentication-password-profile-info` object is the information object about the relationship between a [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/overview) and a [Password Profile](/docs/authentication/single-sign-on/password-profiles-api/overview.md) object.
The `user-authentication-password-profile-info` object is the information object about the relationship between a [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/overview) and a [Password Profile](/docs/authentication/single-sign-on/password-profiles-api/overview) object.

## The User Authentication Password Profile Info Object

Expand Down
2 changes: 1 addition & 1 deletion docs/commerce-manager/payments/paypal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Follow the instructions below or, alternatively, watch a video:

1. Click **Save**. From PayPal Express platform, you can verify that Elastic Path is onboarded to PayPal Express. Watch the following video:

<Video
<Video
mediaSrc="https://www.youtube.com/embed/M-ILzcZreM4"
mediaType="embed"
title="Verifying Elastic Path to Paypal Express Checkout" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Offerings can have any combination of a product and plans. The pricing of an off
| Example | Product | Plans | Offering |
| --- | --- | --- | --- |
| Single product and plan | One product with a product price of $50 | A monthly plan with a 5% discount | An offering with a monthly plan for $47.50 a month |
| Single product with multiple plans | One product with a product price of $50 | <ul><li>A monthly plan with a 5% discount</li><li>A yearly plan with a 10% discount</li></ul> | An offering with two plans: <ul><li>A monthly plan for $47.50 a month</li><li>A yearly plan for $45 a month<</li></ul> |
| Single product with multiple plans | One product with a product price of $50 | A monthly plan with a 5% discountA yearly plan with a 10% discount | An offering with two plans: A monthly plan for $47.50 a monthA yearly plan for $45 a month |

## Building Offerings: An Overview

Expand Down
10 changes: 5 additions & 5 deletions docs/composer/builder/builder-components/amazon-cognito.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The component has the following actions.
|:--- |:--- | :--- |
| **AWS Region** | `string` | AWS provides services in multiple regions, like `us-west-2` or `eu-east-1`. AWS region indicates the region in which your buckets are stored. |
| **AWS Cognito User Pool Request** | `code` | The API request to create a user pool. See [CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html). |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of https://*<domain_prefix>*.auth.<*region*>.amazoncognito.com. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. | `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com` |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of `https://{domain_prefix}.auth.{region}.amazoncognito.com`. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |
| **Custom Domain Certificate ARN** | `string` | The SSL certificate for your custom domain. You can use Amazon Cognito to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. |

### Delete User Pool Domain
Expand All @@ -49,15 +49,15 @@ The component has the following actions.
|:--- |:--- | :--- |
| **AWS Region** | `string` | AWS provides services in multiple regions, like `us-west-2` or `eu-east-1`. AWS region indicates the region in which your buckets are stored. |
| **AWS Cognito User Pool ID** | `string` | The ID of your user pool. |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of https://*<domain_prefix>*.auth.<*region*>.amazoncognito.com. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of `https://{domain_prefix}.auth.{region}.amazoncognito.com`. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |

### Describe User Pool

| Input | Type | Description |
|:--- |:--- | :--- |
| **AWS Region** | `string` | AWS provides services in multiple regions, like `us-west-2` or `eu-east-1`. AWS region indicates the region in which your buckets are stored. |
| **AWS Cognito User Pool ID** | `string` | The ID of your user pool. |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of https://*<domain_prefix>*.auth.<*region*>.amazoncognito.com. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of `https://{domain_prefix}.auth.{region}.amazoncognito.com`. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |

### Describe User Pool Client

Expand All @@ -72,7 +72,7 @@ The component has the following actions.
| Input | Type | Description |
|:--- |:--- | :--- |
| **AWS Region** | `string` | AWS provides services in multiple regions, like `us-west-2` or `eu-east-1`. AWS region indicates the region in which your buckets are stored. |
**Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of https://*<domain_prefix>*.auth.<*region*>.amazoncognito.com. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of `https://{domain_prefix}.auth.{region}.amazoncognito.com`. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |

### List User Pool

Expand Down Expand Up @@ -108,5 +108,5 @@ The component has the following actions.
|:--- |:--- | :--- |
| **AWS Region** | `string` | AWS provides services in multiple regions, like `us-west-2` or `eu-east-1`. AWS region indicates the region in which your buckets are stored. |
| **AWS Cognito User Pool Request** | `code` | The API request to update your user pool. See [UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html). |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of https://*<domain_prefix>*.auth.<*region*>.amazoncognito.com. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. | `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com` |
| **Domain Name** | `string` | The domain name you want to use for your user pool. It must be unique. We recommend that your domain name is alphanumeric and you only use the `-` special character. The domain is in the format of `https://{domain_prefix}.auth.{region}.amazoncognito.com`. For example, if your domain name is `elasticpath-commerce-cloud` and your AWS region is `us-east-1` then your login URL is `elastic-path-commerce-cloud.auth.us-east-1.amazoncognito.com`. The Amazon Cognito Integration creates a subdomain within an Amazon Cognito domain. If you want to use your business domain, then you must configure this directly in Amazon Cognito. |
| **Custom Domain Certificate ARN** | `string` | The SSL certificate for your custom domain. You can use Amazon Cognito to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. |
Loading