Skip to content

Commit e4973c1

Browse files
committed
Updated API from documentation release
1 parent ecd43a0 commit e4973c1

File tree

5 files changed

+66
-0
lines changed

5 files changed

+66
-0
lines changed

api-specs/api/resources/recurring-orders.raml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,18 @@ post:
8484
body:
8585
application/json:
8686
example: !include ../examples/recurring-order.example.json
87+
delete:
88+
displayName: Delete RecurringOrder by ID
89+
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
90+
description: |
91+
Deletes a Recurring Order in the Project.
92+
is:
93+
- dataErasure
94+
responses:
95+
200:
96+
body:
97+
application/json:
98+
example: !include ../examples/recurring-order.example.json
8799
/key={key}:
88100
(methodName): withKey
89101
type:
@@ -119,3 +131,15 @@ post:
119131
body:
120132
application/json:
121133
example: !include ../examples/recurring-order.example.json
134+
delete:
135+
displayName: Delete RecurringOrder by Key
136+
securedBy: [oauth_2_0: { scopes: ['manage_recurring_orders:{projectKey}'] }]
137+
description: |
138+
Deletes a Recurring Order in the Project.
139+
is:
140+
- dataErasure
141+
responses:
142+
200:
143+
body:
144+
application/json:
145+
example: !include ../examples/recurring-order.example.json
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
(beta): true
5+
displayName: RecurringOrderDeletedMessage
6+
discriminatorValue: RecurringOrderDeleted
7+
description: |
8+
Generated after a successful [Delete RecurringOrder](/../api/projects/recurring-orders#delete-recurringorder) request.
9+
properties:
10+
recurringOrder:
11+
type: RecurringOrder
12+
description: |
13+
[RecurringOrder](ctp:api:type:RecurringOrder) that was deleted.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
(beta): true
5+
displayName: RecurringOrderDeletedMessagePayload
6+
discriminatorValue: RecurringOrderDeleted
7+
description: |
8+
Generated after a successful [Delete RecurringOrder](/../api/projects/recurring-orders#delete-recurringorder) request.
9+
properties:
10+
recurringOrder:
11+
type: RecurringOrder
12+
description: |
13+
[RecurringOrder](ctp:api:type:RecurringOrder) that was deleted.

api-specs/api/types/types.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1153,6 +1153,7 @@ RecurringOrderCustomFieldChangedMessage: !include message/RecurringOrderCustomFi
11531153
RecurringOrderCustomFieldRemovedMessage: !include message/RecurringOrderCustomFieldRemovedMessage.raml
11541154
RecurringOrderCustomTypeRemovedMessage: !include message/RecurringOrderCustomTypeRemovedMessage.raml
11551155
RecurringOrderCustomTypeSetMessage: !include message/RecurringOrderCustomTypeSetMessage.raml
1156+
RecurringOrderDeletedMessage: !include message/RecurringOrderDeletedMessage.raml
11561157
RecurringOrderKeySetMessage: !include message/RecurringOrderKeySetMessage.raml
11571158
RecurringOrderScheduleSetMessage: !include message/RecurringOrderScheduleSetMessage.raml
11581159
RecurringOrderStartsAtSetMessage: !include message/RecurringOrderStartsAtSetMessage.raml
@@ -1490,6 +1491,7 @@ RecurringOrderCustomFieldRemovedMessagePayload: !include message/payload/Recurri
14901491
# yamllint disable-line rule:line-length
14911492
RecurringOrderCustomTypeRemovedMessagePayload: !include message/payload/RecurringOrderCustomTypeRemovedMessagePayload.raml
14921493
RecurringOrderCustomTypeSetMessagePayload: !include message/payload/RecurringOrderCustomTypeSetMessagePayload.raml
1494+
RecurringOrderDeletedMessagePayload: !include message/payload/RecurringOrderDeletedMessagePayload.raml
14931495
RecurringOrderKeySetMessagePayload: !include message/payload/RecurringOrderKeySetMessagePayload.raml
14941496
RecurringOrderScheduleSetMessagePayload: !include message/payload/RecurringOrderScheduleSetMessagePayload.raml
14951497
RecurringOrderStartsAtSetMessagePayload: !include message/payload/RecurringOrderStartsAtSetMessagePayload.raml

api-specs/graphql/schema.sdl

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6882,6 +6882,15 @@ type Mutation {
68826882
"Queries with specified key"
68836883
key: String): RecurringOrder
68846884

6885+
"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
6886+
deleteRecurringOrder(version: Long!, personalDataErasure: Boolean = false,
6887+
6888+
"Queries with specified ID"
6889+
id: String,
6890+
6891+
"Queries with specified key"
6892+
key: String): RecurringOrder
6893+
68856894
"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
68866895
createRecurrencePolicy(draft: RecurrencePolicyDraft!): RecurrencePolicy
68876896

@@ -10839,6 +10848,11 @@ type RecurringOrderCustomTypeSet implements MessagePayload {
1083910848
type: String!
1084010849
}
1084110850

10851+
type RecurringOrderDeleted implements MessagePayload {
10852+
recurringOrder: RecurringOrder!
10853+
type: String!
10854+
}
10855+
1084210856
"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta"
1084310857
input RecurringOrderDraft {
1084410858
key: String

0 commit comments

Comments
 (0)