Skip to content

Commit c32bb07

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent d3cb53c commit c32bb07

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

oas/api/openapi.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33332,10 +33332,13 @@ paths:
3333233332
get:
3333333333
security:
3333433334
- oauth_2_0:
33335+
- "view_recurrence_policies:{projectKey}"
3333533336
- "view_recurring_orders:{projectKey}"
3333633337
operationId: ByProjectKeyRecurrencePoliciesGet
3333733338
description: |-
3333833339
Retrieves Recurrence Policies in the Project.
33340+
33341+
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.
3333933342
parameters:
3334033343
- name: expand
3334133344
in: query
@@ -33425,10 +33428,13 @@ paths:
3342533428
head:
3342633429
security:
3342733430
- oauth_2_0:
33431+
- "view_recurrence_policies:{projectKey}"
3342833432
- "view_recurring_orders:{projectKey}"
3342933433
operationId: ByProjectKeyRecurrencePoliciesHead
3343033434
description: |-
3343133435
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.
33436+
33437+
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.
3343233438
parameters:
3343333439
- name: where
3343433440
in: query
@@ -33461,10 +33467,13 @@ paths:
3346133467
post:
3346233468
security:
3346333469
- oauth_2_0:
33470+
- "manage_recurrence_policies:{projectKey}"
3346433471
- "manage_recurring_orders:{projectKey}"
3346533472
operationId: ByProjectKeyRecurrencePoliciesPost
3346633473
description: |-
3346733474
Creates a Recurrence Policy in the Project.
33475+
33476+
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.
3346833477
parameters:
3346933478
- name: expand
3347033479
in: query
@@ -33519,10 +33528,13 @@ paths:
3351933528
get:
3352033529
security:
3352133530
- oauth_2_0:
33531+
- "view_recurrence_policies:{projectKey}"
3352233532
- "view_recurring_orders:{projectKey}"
3352333533
operationId: ByProjectKeyRecurrencePoliciesKeyByKeyGet
3352433534
description: |-
3352533535
Retrieves a Recurrence Policy with the provided `key`.
33536+
33537+
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.
3352633538
parameters:
3352733539
- name: expand
3352833540
in: query
@@ -33559,10 +33571,13 @@ paths:
3355933571
head:
3356033572
security:
3356133573
- oauth_2_0:
33574+
- "view_recurrence_policies:{projectKey}"
3356233575
- "view_recurring_orders:{projectKey}"
3356333576
operationId: ByProjectKeyRecurrencePoliciesKeyByKeyHead
3356433577
description: |-
3356533578
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.
33579+
33580+
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.
3356633581
responses:
3356733582
"200":
3356833583
description: |-
@@ -33585,10 +33600,13 @@ paths:
3358533600
post:
3358633601
security:
3358733602
- oauth_2_0:
33603+
- "manage_recurrence_policies:{projectKey}"
3358833604
- "manage_recurring_orders:{projectKey}"
3358933605
operationId: ByProjectKeyRecurrencePoliciesKeyByKeyPost
3359033606
description: |-
3359133607
Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
33608+
33609+
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.
3359233610
parameters:
3359333611
- name: expand
3359433612
in: query
@@ -33633,12 +33651,15 @@ paths:
3363333651
delete:
3363433652
security:
3363533653
- oauth_2_0:
33654+
- "manage_recurrence_policies:{projectKey}"
3363633655
- "manage_recurring_orders:{projectKey}"
3363733656
operationId: ByProjectKeyRecurrencePoliciesKeyByKeyDelete
3363833657
description: |-
3363933658
Deletes a Recurrence Policy in the Project.
3364033659

3364133660
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.
33661+
33662+
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.
3364233663
parameters:
3364333664
- name: version
3364433665
in: query
@@ -33697,10 +33718,13 @@ paths:
3369733718
get:
3369833719
security:
3369933720
- oauth_2_0:
33721+
- "view_recurrence_policies:{projectKey}"
3370033722
- "view_recurring_orders:{projectKey}"
3370133723
operationId: ByProjectKeyRecurrencePoliciesByIDGet
3370233724
description: |-
3370333725
Retrieves a Recurrence Policy with the provided `id`.
33726+
33727+
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.
3370433728
parameters:
3370533729
- name: expand
3370633730
in: query
@@ -33737,10 +33761,13 @@ paths:
3373733761
head:
3373833762
security:
3373933763
- oauth_2_0:
33764+
- "view_recurrence_policies:{projectKey}"
3374033765
- "view_recurring_orders:{projectKey}"
3374133766
operationId: ByProjectKeyRecurrencePoliciesByIDHead
3374233767
description: |-
3374333768
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.
33769+
33770+
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.
3374433771
responses:
3374533772
"200":
3374633773
description: |-
@@ -33763,10 +33790,13 @@ paths:
3376333790
post:
3376433791
security:
3376533792
- oauth_2_0:
33793+
- "manage_recurrence_policies:{projectKey}"
3376633794
- "manage_recurring_orders:{projectKey}"
3376733795
operationId: ByProjectKeyRecurrencePoliciesByIDPost
3376833796
description: |-
3376933797
Updates a Recurrence Policy using one or more [update actions](/../api/projects/recurrence-policies#update-actions).
33798+
33799+
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.
3377033800
parameters:
3377133801
- name: expand
3377233802
in: query
@@ -33811,12 +33841,15 @@ paths:
3381133841
delete:
3381233842
security:
3381333843
- oauth_2_0:
33844+
- "manage_recurrence_policies:{projectKey}"
3381433845
- "manage_recurring_orders:{projectKey}"
3381533846
operationId: ByProjectKeyRecurrencePoliciesByIDDelete
3381633847
description: |-
3381733848
Deletes a Recurrence Policy in the Project.
3381833849

3381933850
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.
33851+
33852+
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.
3382033853
parameters:
3382133854
- name: version
3382233855
in: query

0 commit comments

Comments
 (0)