Skip to content

Commit b62bef9

Browse files
tarcangtarcang
committed
Update for v2.7.0
1 parent f556a60 commit b62bef9

File tree

253 files changed

+7617
-308
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

253 files changed

+7617
-308
lines changed

‎CHANGELOG.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,23 @@ only use JavaScript, or if you use TypeScript but only import the client classes
1010
then your usage **will not change**. You will likely only need to make changes if
1111
you import the type definitions directly.
1212

13+
### v2.7.0
14+
15+
#### New APIs
16+
17+
* *Shopper Context* has been added to the SDK.
18+
19+
#### API Changes
20+
21+
*Shopper Login*
22+
23+
* New Endpoints
24+
25+
| **Endpoint Name** | **Description** |
26+
| ------------- |-------------|
27+
| authorizePasswordlessCustomer | Logs a customer in using Core with their customer profiles loaded in ECOM. Allows the user to authenticate when their identity provider (Core) is down. |
28+
| getPasswordLessAccessToken | Evaluate the `pwdless_token` and issue the shopper token (JWT). |
29+
1330
### v2.6.1
1431

1532
#### Bug Fixes

‎apis/customer/shopper-context/.metadata.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-context/0.0.6",
3+
"name": "Shopper Context (Beta)",
4+
"description": "The Shopper Context API enables developers to build highly contextualized shopping experiences for shoppers.",
5+
"groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
6+
"assetId": "shopper-context",
7+
"version": "0.0.6",
8+
"categories": {
9+
"API layer": [
10+
"System"
11+
],
12+
"CC API Family": [
13+
"Customer"
14+
],
15+
"CC Version Status": [
16+
"Beta"
17+
],
18+
"CC API Visibility": [
19+
"External"
20+
]
21+
}
22+
}

‎apis/customer/shopper-context/Examples/shopper-context-example.raml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#%RAML 1.0 NamedExample
2+
# This example is for shopper context request/response
3+
value:
4+
{
5+
"effectiveDateTime": "2020-12-20T00:00:00Z",
6+
"customQualifiers" :
7+
{
8+
"deviceType": "mobile",
9+
"sourceCodeGroup": "Sale",
10+
"referrerURL": "https://www.google.com",
11+
"currency": "USD",
12+
"referrerHost": "google",
13+
"authenticated": "no",
14+
"ipAddress": "189.0.0.0",
15+
"zipCode": "11111",
16+
"country": "US",
17+
"region": "West",
18+
"city": "SLC",
19+
"operatingSystem": "Android",
20+
"customergroupId": ""
21+
}
22+
}

‎apis/customer/shopper-context/Examples/shopper-context-update-request-example.raml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#%RAML 1.0 NamedExample
2+
# This example is for shopper context request/response
3+
value:
4+
{
5+
"effectiveDateTime": null,
6+
"customQualifiers" :
7+
{
8+
"deviceType": "iPad",
9+
"authenticated": null,
10+
"operatingSystem": "iOS",
11+
"storeId": "SLC1",
12+
}
13+
}

‎apis/customer/shopper-context/Examples/shopper-context-update-response-example.raml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#%RAML 1.0 NamedExample
2+
# This example is for shopper context request/response
3+
value:
4+
{
5+
"customQualifiers" :
6+
{
7+
"deviceType": "iPad",
8+
"sourceCodeGroup": "Sale",
9+
"referrerURL": "https://wwww.google.com",
10+
"currency": "USD",
11+
"referrerHost": "google",
12+
"ipAddress": "189.0.0.10",
13+
"zipCode": "11111",
14+
"country": "US",
15+
"region": "West",
16+
"city": "SLC",
17+
"operatingSystem": "iOS",
18+
"customergroupId": "",
19+
"storeId": "SLC1"
20+
}
21+
}

‎apis/customer/shopper-context/exchange.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"main":"shopper-context.raml","name":"Shopper Context","organizationId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"shopper-context","version":"0.0.6","apiVersion":"v1","classifier":"raml","dependencies":[{"assetId":"commerce-cloud-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","version":"1.0.17"},{"assetId":"api-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","version":"1.1.13"}],"tags":[]}

‎apis/customer/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.13/api-standards.raml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
#%RAML 1.0 Library
2+
3+
usage: |
4+
REST and HTTP enforce a bunch of rules around Resources and Methods along with prescriptions around responding to requests with appropriate responses. What they don't do, and rightfully so, is attempt to standardize on the commonality for disparate services. In a particular Services ecosystem, example: Commerce Platform, having services obey a set of constraints around the way they are exposed helps achieve a level of commonality via convention that will enable them to interplay easily.
5+
6+
These RAML componenets will define those constraints that RESTful Services developed at Commerce Cloud will adhere to. This API implements the version **[1.1 of the REST standard](https://confluence.internal.salesforce.com/display/ENG/RESTful+APIs+Conventions+and+Standards+v1.1)**, please make sure this is the version you are meaning to use before leveraging these RAML components.
7+
8+
In order to ease the future generation of code, this artifact is meant to be used as a RAML Library. Refrain from using this as partial includes.
9+
10+
An example RAML is provided in `/example.raml`.
11+
12+
securitySchemes:
13+
GDoT: !include securitySchemes/gdot.raml
14+
15+
types:
16+
ErrorResponse: Error.Error
17+
Offset: Pagination.offset
18+
Limit: Pagination.limit
19+
Total: Pagination.total
20+
Uuid: Identifiers.UniversallyUniqueIdentifier
21+
AbsoluteUrl: Uri.absoluteUrl
22+
ChangeControlled: BaseTypes.ChangeControlledDataType
23+
24+
uses:
25+
Pagination: dataTypes/pagination-types.raml
26+
Identifiers: dataTypes/identifers.raml
27+
Uri: dataTypes/uri.raml
28+
BaseTypes: dataTypes/base-types.raml
29+
Error: dataTypes/error-types.raml
30+
31+
traits:
32+
RangeFilter: !include traits/rangeFilter.raml
33+
DateRangeFilter:
34+
is:
35+
RangeFilter:
36+
type: date-only
37+
name: <<name>>
38+
DatetimeRangeFilter:
39+
is:
40+
RangeFilter:
41+
type: datetime
42+
name: <<name>>
43+
NumericRangeFilter:
44+
is:
45+
RangeFilter:
46+
type: number
47+
name: <<name>>
48+
IntegerRangeFilter:
49+
is:
50+
RangeFilter:
51+
type: integer
52+
name: <<name>>
53+
RateLimited: !include traits/rate-limited.raml
54+
RateLimited2: !include traits/rate-limited-2.raml
55+
RateLimited3: !include traits/rate-limited-3.raml
56+
RateLimited4: !include traits/rate-limited-4.raml
57+
RateLimited5: !include traits/rate-limited-5.raml
58+
SyncCreated: !include traits/sync-created.raml
59+
AsyncCreated: !include traits/async-created.raml
60+
DateConditionalRequest: !include traits/date-conditional-request.raml
61+
EtagConditionalRequest: !include traits/etag-conditional-request.raml
62+
EtagResponse: !include traits/etag-response.raml
63+
OffsetPaginated: !include traits/offset-paginated.raml

‎apis/customer/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.13/dataTypes/base-types.raml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#%RAML 1.0 Library
2+
usage: Library for types that act as building blocks for other types.
3+
4+
types:
5+
ChangeControlledDataType:
6+
displayName: ChangeControlled
7+
description: |-
8+
A type extending this type will provide metadata regarding changes
9+
to its data for each record. This information can be used to build
10+
a change history of the records in this data type.
11+
12+
With the exception of APIs that query such history, these fields
13+
should never appear in API input, and possibly not in API output;
14+
their values should be derived by the context in which the API is
15+
called from. For example, the `creationDate` property should come
16+
from the system time as opposed to being user provided.
17+
properties:
18+
creationDate:
19+
type: datetime
20+
#default: sysdate
21+
description: The timestamp of when this record was first created.
22+
required: false
23+
modificationDate:
24+
type: datetime
25+
#default: sysdate
26+
description: The timestamp of when this record was most recently modified.
27+
required: false
28+
createdBy:
29+
type: string
30+
description: The user id of the user who created this record.
31+
required: false
32+
pattern: /.+/
33+
lastModifiedBy:
34+
type: string
35+
description: The user id of the user who most recently modified this record.
36+
required: false
37+
pattern: /.+/
38+

‎apis/customer/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.13/dataTypes/error-response.raml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
#%RAML 1.0 DataType
2+
3+
### DEPRECATED: Use the Library instead
4+
5+
# Defines a "problem detail" as a way to carry machine-
6+
# readable details of errors in a HTTP response to avoid the need to
7+
# define new error response formats for HTTP APIs, it follows the [IETF rfc7807](https://tools.ietf.org/html/rfc7807).
8+
9+
properties:
10+
type:
11+
description: |
12+
A URI reference [RFC3986] that identifies the
13+
problem type. This specification encourages that, when
14+
dereferenced, it provide human-readable documentation for the
15+
problem type (e.g., using HTML [W3C.REC-html5-20141028]). When
16+
this member is not present, its value is assumed to be
17+
"about:blank". It accepts relative URIs; this means
18+
that they must be resolved relative to the document's base URI, as
19+
per [RFC3986], Section 5.
20+
type: string
21+
required: true
22+
example: https://example.com/probs/out-of-credit
23+
title:
24+
description: |
25+
A short, human-readable summary of the problem
26+
type. It will not change from occurrence to occurrence of the
27+
problem, except for purposes of localization.
28+
type: string
29+
required: false
30+
example: You do not have enough credit.
31+
detail:
32+
description: |
33+
A human-readable explanation specific to this
34+
occurrence of the problem.
35+
type: string
36+
required: false
37+
example: Your current balance is 30, but that costs 50.
38+
instance:
39+
description: |
40+
A URI reference that identifies the specific
41+
occurrence of the problem. It may or may not yield further
42+
information if dereferenced. It accepts relative URIs; this means
43+
that they must be resolved relative to the document's base URI, as
44+
per [RFC3986], Section 5.
45+
type: string
46+
required: false
47+
example: "/account/12345/msgs/abc"

‎apis/customer/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.13/dataTypes/error-types.raml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
#%RAML 1.0 Library
2+
usage: |-
3+
Defines a "problem detail" as a way to carry machine-
4+
readable details of errors in a HTTP response to avoid the need to
5+
define new error response formats for HTTP APIs, it follows the [IETF rfc7807](https://tools.ietf.org/html/rfc7807).
6+
7+
types:
8+
Error:
9+
description: |-
10+
Errors reported by all APIs correspond to this error document format.
11+
This format follows the RFC [IETF rfc7807](https://tools.ietf.org/html/rfc7807).
12+
This may include additional properties as necessary to provide additional details
13+
regarding the error message.
14+
type: object
15+
additionalProperties: true
16+
properties:
17+
type:
18+
description: |
19+
A URI reference [RFC3986] that identifies the
20+
problem type. This specification encourages that, when
21+
dereferenced, it provide human-readable documentation for the
22+
problem type (e.g., using HTML [W3C.REC-html5-20141028]). When
23+
this member is not present, its value is assumed to be
24+
"about:blank". It accepts relative URIs; this means
25+
that they must be resolved relative to the document's base URI, as
26+
per [RFC3986], Section 5.
27+
type: string
28+
required: true
29+
example: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/not-found
30+
title:
31+
description: |
32+
A short, human-readable summary of the problem
33+
type. It will not change from occurrence to occurrence of the
34+
problem, except for purposes of localization.
35+
type: string
36+
required: false
37+
example: Not Found.
38+
detail:
39+
description: |
40+
A human-readable explanation specific to this
41+
occurrence of the problem.
42+
type: string
43+
required: false
44+
example: The requested resource was not found.
45+
instance:
46+
description: |
47+
A URI reference that identifies the specific
48+
occurrence of the problem. It may or may not yield further
49+
information if dereferenced. It accepts relative URIs; this means
50+
that they must be resolved relative to the document's base URI, as
51+
per [RFC3986], Section 5.
52+
type: string
53+
required: false
54+
example: "/account/12345/msgs/abc"

0 commit comments

Comments
 (0)