Skip to content

Commit d3cb53c

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent c77d3d4 commit d3cb53c

4 files changed

Lines changed: 155 additions & 23 deletions

File tree

‎api-specs/api/resources/recurrence-policies.raml‎

Lines changed: 143 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,27 +11,63 @@ type:
1111
description: A Recurrence Policy is a configuration of a schedule.
1212
get:
1313
displayName: Query RecurrencePolicies
14-
securedBy: [oauth_2_0: { scopes: ['view_recurring_orders:{projectKey}'] }]
14+
securedBy:
15+
[
16+
oauth_2_0:
17+
{
18+
scopes:
19+
[
20+
'view_recurrence_policies:{projectKey}',
21+
'view_recurring_orders:{projectKey}',
22+
],
23+
},
24+
]
1525
description: |
1626
Retrieves Recurrence Policies in the Project.
27+
28+
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
1729
responses:
1830
200:
1931
body:
2032
application/json:
2133
example: !include ../examples/recurrence-policies.example.json
2234
head:
2335
displayName: Check if RecurrencePolicy exists by Query Predicate
24-
securedBy: [oauth_2_0: { scopes: ['view_recurring_orders:{projectKey}'] }]
36+
securedBy:
37+
[
38+
oauth_2_0:
39+
{
40+
scopes:
41+
[
42+
'view_recurrence_policies:{projectKey}',
43+
'view_recurring_orders:{projectKey}',
44+
],
45+
},
46+
]
2547
description: |
2648
Checks if one or more Recurrence Policies exist for the provided query predicate. Returns a `200` status if any Recurrence Policies match the query predicate, or a [NotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
49+
50+
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
2751
queryParameters:
2852
where?:
2953
type: QueryPredicate[]
3054
post:
3155
displayName: Create RecurrencePolicy
32-
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
56+
securedBy:
57+
[
58+
oauth_2_0:
59+
{
60+
scopes:
61+
[
62+
'manage_recurrence_policies:{projectKey}',
63+
'manage_recurring_orders:{projectKey}',
64+
],
65+
},
66+
]
3367
description: |
3468
Creates a Recurrence Policy in the Project.
69+
70+
The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
3571
body:
3672
application/json:
3773
example: !include ../examples/recurrence-policy-create.example.json
@@ -49,24 +85,60 @@ post:
4985
resourceUpdateType: RecurrencePolicyUpdate
5086
get:
5187
displayName: Get RecurrencePolicy by Key
52-
securedBy: [oauth_2_0: { scopes: ['view_recurring_orders:{projectKey}'] }]
88+
securedBy:
89+
[
90+
oauth_2_0:
91+
{
92+
scopes:
93+
[
94+
'view_recurrence_policies:{projectKey}',
95+
'view_recurring_orders:{projectKey}',
96+
],
97+
},
98+
]
5399
description: |
54100
Retrieves a Recurrence Policy with the provided `key`.
101+
102+
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
55103
responses:
56104
200:
57105
body:
58106
application/json:
59107
example: !include ../examples/recurrence-policy.example.json
60108
head:
61109
displayName: Check if RecurrencePolicy exists by Key
62-
securedBy: [oauth_2_0: { scopes: ['view_recurring_orders:{projectKey}'] }]
110+
securedBy:
111+
[
112+
oauth_2_0:
113+
{
114+
scopes:
115+
[
116+
'view_recurrence_policies:{projectKey}',
117+
'view_recurring_orders:{projectKey}',
118+
],
119+
},
120+
]
63121
description: |
64122
Checks if a Recurrence Policy exists with the provided `key`. Returns a `200` status if the Recurrence Policy exists, or a [NotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
123+
124+
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
65125
post:
66126
displayName: Update RecurrencePolicy by Key
67-
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
127+
securedBy:
128+
[
129+
oauth_2_0:
130+
{
131+
scopes:
132+
[
133+
'manage_recurrence_policies:{projectKey}',
134+
'manage_recurring_orders:{projectKey}',
135+
],
136+
},
137+
]
68138
description: |
69139
Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
140+
141+
The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
70142
body:
71143
application/json:
72144
example: !include ../examples/recurrence-policy-update.example.json
@@ -77,11 +149,23 @@ post:
77149
example: !include ../examples/recurrence-policy.example.json
78150
delete:
79151
displayName: Delete RecurrencePolicy by Key
80-
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
152+
securedBy:
153+
[
154+
oauth_2_0:
155+
{
156+
scopes:
157+
[
158+
'manage_recurrence_policies:{projectKey}',
159+
'manage_recurring_orders:{projectKey}',
160+
],
161+
},
162+
]
81163
description: |
82164
Deletes a Recurrence Policy in the Project.
83165
84166
A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a [ReferenceExists](ctp:api:type:ReferenceExistsError) error is returned.
167+
168+
The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
85169
responses:
86170
200:
87171
body:
@@ -96,24 +180,60 @@ post:
96180
resourceUpdateType: RecurrencePolicyUpdate
97181
get:
98182
displayName: Get RecurrencePolicy by ID
99-
securedBy: [oauth_2_0: { scopes: ['view_recurring_orders:{projectKey}'] }]
183+
securedBy:
184+
[
185+
oauth_2_0:
186+
{
187+
scopes:
188+
[
189+
'view_recurrence_policies:{projectKey}',
190+
'view_recurring_orders:{projectKey}',
191+
],
192+
},
193+
]
100194
description: |
101195
Retrieves a Recurrence Policy with the provided `id`.
196+
197+
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
102198
responses:
103199
200:
104200
body:
105201
application/json:
106202
example: !include ../examples/recurrence-policy.example.json
107203
head:
108204
displayName: Check if RecurrencePolicy exists by ID
109-
securedBy: [oauth_2_0: { scopes: ['view_recurring_orders:{projectKey}'] }]
205+
securedBy:
206+
[
207+
oauth_2_0:
208+
{
209+
scopes:
210+
[
211+
'view_recurrence_policies:{projectKey}',
212+
'view_recurring_orders:{projectKey}',
213+
],
214+
},
215+
]
110216
description: |
111217
Checks if a Recurrence Policy exists with the provided `id`. Returns a `200` status if the Recurrence Policy exists, or a [NotFound](ctp:api:type:ResourceNotFoundError) error otherwise.
218+
219+
The `view_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `view_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
112220
post:
113221
displayName: Update RecurrencePolicy by ID
114-
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
222+
securedBy:
223+
[
224+
oauth_2_0:
225+
{
226+
scopes:
227+
[
228+
'manage_recurrence_policies:{projectKey}',
229+
'manage_recurring_orders:{projectKey}',
230+
],
231+
},
232+
]
115233
description: |
116234
Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
235+
236+
The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
117237
body:
118238
application/json:
119239
example: !include ../examples/recurrence-policy-update.example.json
@@ -124,11 +244,23 @@ post:
124244
example: !include ../examples/recurrence-policy.example.json
125245
delete:
126246
displayName: Delete RecurrencePolicy by ID
127-
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
247+
securedBy:
248+
[
249+
oauth_2_0:
250+
{
251+
scopes:
252+
[
253+
'manage_recurrence_policies:{projectKey}',
254+
'manage_recurring_orders:{projectKey}',
255+
],
256+
},
257+
]
128258
description: |
129259
Deletes a Recurrence Policy in the Project.
130260
131261
A Recurrence Policy can be deleted only if it is not referenced by any Embedded Price, Standalone Price, or (Custom) Line Item, otherwise a [ReferenceExists](ctp:api:type:ReferenceExistsError) error is returned.
262+
263+
The `manage_recurring_orders:{projectKey}` scope is deprecated for use on this endpoint. Update your clients to use the `manage_recurrence_policies:{projectKey}` scope instead. For more information, see the [Deprecations and removals](/api/deprecations-and-removals#recurrence-policies) list.
132264
responses:
133265
200:
134266
body:

‎api-specs/api/types/product-search/ProductSearchProjectionParams.raml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#%RAML 1.0 DataType
22
(package): ProductSearch
33
type: object
4-
(beta): true
4+
(markDeprecated): true
55
displayName: ProductSearchProjectionParams
66
description: |
7-
The query parameters used for [data integration with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
7+
The query parameters used for the deprecated [data integration with Product Projection parameters](/../api/deprecations-and-removals#product-projection-parameters) in Product Search.
88
properties:
99
expand?:
1010
type: Expansion[]
@@ -14,7 +14,7 @@ properties:
1414
staged?:
1515
type: boolean
1616
description: |
17-
Set to `true` to retrieve the [staged](ctp:api:type:CurrentStaged) Product Projection
17+
Set to `true` to retrieve the [staged](/../api/projects/productProjections#current--staged) Product Projection
1818
priceCurrency?:
1919
type: CurrencyCode
2020
description: |
@@ -38,15 +38,15 @@ properties:
3838
localeProjection?:
3939
type: Locale[]
4040
description: |
41-
Used for [locale-based projection](ctp:api:type:ProductProjectionLocales).
41+
Used for [locale-based projection](/../api/projects/productProjections#locales).
4242
storeProjection?:
4343
type: string
4444
description: |
4545
`key` of an existing [Store](ctp:api:type:Store).
4646
If the Store has defined `languages`, `countries`, `distributionChannels`, or `supplyChannels`,
47-
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
48-
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
47+
they are used for projections based on [locale](/../api/projects/productProjections#locales), [price](/../api/projects/productProjections#prices),
48+
and [inventory](/../api/projects/productProjections#inventory-entries).
4949
50-
For Projects with active [Product Selections](/api/projects/product-selections), the API does not take the [availability of the Product in the specified Store](/api/project-configuration-overview#products-available-in-store) into account.
50+
For Projects with active [Product Selections](/../api/projects/product-selections), the API does not take the [availability of the Product in the specified Store](/../api/project-configuration-overview#products-available-in-store) into account.
5151
52-
[Product Tailoring](/api/projects/product-tailoring) modifies the product information returned in API responses. However, you can only specify [query expressions](/api/search-query-language#simple-expressions) for the original Product data, not for tailored data.
52+
[Product Tailoring](/../api/projects/product-tailoring) modifies the product information returned in API responses. However, you can only specify [query expressions](/../api/search-query-language#simple-expressions) for the original Product data, not for tailored data.

‎api-specs/api/types/product-search/ProductSearchRequest.raml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ properties:
3838
For details, see [matching variants](/../api/projects/product-search#matching-variants).
3939
productProjectionParameters?:
4040
type: ProductSearchProjectionParams
41-
(beta): true
41+
(markDeprecated): true
4242
description: |
43-
Controls data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
43+
Controls deprecated data integration [with Product Projection parameters](/../api/deprecations-and-removals#product-projection-parameters).
4444
If not set, the result does not include the Product Projection.
4545
facets?:
4646
type: ProductSearchFacetExpression[]

‎api-specs/api/types/product-search/ProductSearchResult.raml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ properties:
1515
Only present if `markMatchingVariants` is set to `true` in the [ProductSearchRequest](ctp:api:type:ProductSearchRequest).
1616
productProjection?:
1717
type: ProductProjection
18-
(beta): true
18+
(markDeprecated): true
1919
description: |
2020
Projected data of the Product with `id`.
21-
Only present if data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters) is requested.
21+
Only present if deprecated data integration [with Product Projection parameters](/../api/deprecations-and-removals#product-projection-parameters) is requested.

0 commit comments

Comments
 (0)