Updated API from documentation release

api-specs/api/examples/ApprovalFlow/ApprovalFlowSetCustomFieldAction.json

@@ -0,0 +1,5 @@
+{
+  "action": "setCustomField",
+  "name": "ExampleStringTypeField",
+  "value": "TextString"
+}

api-specs/api/examples/ApprovalFlow/ApprovalFlowSetCustomTypeAction.json

@@ -0,0 +1,10 @@
+{
+  "action": "setCustomType",
+  "type": {
+    "id": "{{type-id}}",
+    "typeId": "type"
+  },
+  "fields": {
+    "exampleStringTypeField": "TextString"
+  }
+}

api-specs/api/types/approval-flow/ApprovalFlow.raml

@@ -70,3 +70,7 @@ properties:
     type: RuleApprover[]
     description: |
       Associate Roles required for approval based on the approver hierarchy tiers defined in `rules` only for the currently active tier(s).
+  custom?:
+    type: CustomFields
+    description: |
+      Custom Fields on the Approval Flow.

api-specs/api/types/approval-flow/ApprovalFlowSetCustomFieldAction.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 DataType
+(package): ApprovalFlow
+(docs-uri): https://docs.commercetools.com/api/projects/approvalflows#set-custom-field
+type: ApprovalFlowUpdateAction
+displayName: ApprovalFlowSetCustomFieldAction
+discriminatorValue: setCustomField
+example: !include ../../examples/ApprovalFlow/ApprovalFlowSetCustomFieldAction.json
+properties:
+  name:
+    type: string
+    description: |
+      Name of the [Custom Field](ctp:api:type:CustomFields).
+  value?:
+    type: CustomFieldValue
+    description: |
+      If `value` is absent or `null`, this field will be removed if it exists.
+      Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+      If `value` is provided, it is set for the field defined by `name`.

api-specs/api/types/approval-flow/ApprovalFlowSetCustomTypeAction.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): ApprovalFlow
+(docs-uri): https://docs.commercetools.com/api/projects/approvalflows#set-custom-type
+type: ApprovalFlowUpdateAction
+displayName: ApprovalFlowSetCustomTypeAction
+discriminatorValue: setCustomType
+example: !include ../../examples/ApprovalFlow/ApprovalFlowSetCustomTypeAction.json
+properties:
+  type?:
+    type: TypeResourceIdentifier
+    description: |
+      Defines the [Type](ctp:api:type:Type) that extends the ApprovalFlow with [Custom Fields](ctp:api:type:CustomFields).
+      If absent, any existing Type and Custom Fields are removed from the ApprovalFlow.
+  fields?:
+    type: FieldContainer
+    description: |
+      Sets the [Custom Fields](ctp:api:type:CustomFields) fields for the ApprovalFlow.

api-specs/api/types/type/CustomFieldReferenceValue.raml

@@ -5,6 +5,7 @@ type: string
 description: |
   Defines which resource type a [CustomFieldReferenceType](ctp:api:type:CustomFieldReferenceType) can reference.
 enum:
+  - approval-flow
   - associate-role
   - business-unit
   - cart
@@ -20,6 +21,8 @@ enum:
   - shipping-method
   - zone
 (enumDescriptions):
+  approval-flow: |
+    [ApprovalFlow](ctp:api:type:ApprovalFlow)
   associate-role: |
     [AssociateRole](ctp:api:type:AssociateRole)
   business-unit: |

api-specs/api/types/type/ResourceTypeId.raml

@@ -7,6 +7,7 @@ description: |
 enum:
   - address
   - asset
+  - approval-flow
   - associate-role
   - business-unit
   - cart-discount
@@ -41,6 +42,8 @@ enum:
     [Address](ctp:api:type:Address) on [BusinessUnit](ctp:api:type:BusinessUnit), [Cart](ctp:api:type:Cart), [Order](ctp:api:type:Order), [OrderEdit](ctp:api:type:OrderEdit), [Customer](ctp:api:type:Customer), and [Channel](ctp:api:type:Channel)
   asset: |
     [Asset](ctp:api:type:Asset) on [Category](ctp:api:type:Category) and [ProductVariant](ctp:api:type:ProductVariant)
+  approval-flow: |
+    [ApprovalFlow](ctp:api:type:ApprovalFlow)
   associate-role: |
     [AssociateRole](ctp:api:type:AssociateRole)
   business-unit: |

api-specs/api/types/types.raml

@@ -10,6 +10,8 @@ ApprovalFlowApproveAction: !include approval-flow/ApprovalFlowApproveAction.raml
 ApprovalFlowPagedQueryResponse: !include approval-flow/ApprovalFlowPagedQueryResponse.raml
 ApprovalFlowRejectAction: !include approval-flow/ApprovalFlowRejectAction.raml
 ApprovalFlowRejection: !include approval-flow/ApprovalFlowRejection.raml
+ApprovalFlowSetCustomFieldAction: !include approval-flow/ApprovalFlowSetCustomFieldAction.raml
+ApprovalFlowSetCustomTypeAction: !include approval-flow/ApprovalFlowSetCustomTypeAction.raml
 ApprovalFlowStatus: !include approval-flow/ApprovalFlowStatus.raml
 ApprovalFlowUpdate: !include approval-flow/ApprovalFlowUpdate.raml
 ApprovalFlowUpdateAction: !include approval-flow/ApprovalFlowUpdateAction.raml

api-specs/graphql/schema.sdl

@@ -668,6 +668,7 @@ type ApprovalFlow implements Versioned {
   eligibleApprovers: [RuleApprover!]!
   pendingApprovers: [RuleApprover!]!
   currentTierPendingApprovers: [RuleApprover!]!
+  custom: CustomFieldsType
   id: String!
   version: Long!
   createdAt: DateTime!
@@ -727,6 +728,8 @@ type ApprovalFlowRejection {
 input ApprovalFlowUpdateAction {
   approve: ApproveApprovalFlow
   reject: RejectApprovalFlow
+  setCustomField: SetApprovalFlowCustomField
+  setCustomType: SetApprovalFlowCustomType
 }
 
 type ApprovalRule implements Versioned {
@@ -1796,6 +1799,7 @@ type CartDiscountTotalPriceTarget implements CartDiscountTarget {
 input CartDiscountTotalPriceTargetInput {
   dummy: String
 }
+
 input CartDiscountUpdateAction {
   setStores: SetCartDiscountStores
   addStore: AddCartDiscountStore
@@ -9764,6 +9768,18 @@ type SelectionOfProductQueryResult {
 "A set."
 scalar Set
 
+input SetApprovalFlowCustomField {
+  name: String!
+  value: String
+}
+
+input SetApprovalFlowCustomType {
+  fields: [CustomFieldInput!]
+  type: ResourceIdentifierInput
+  typeKey: String
+  typeId: String
+}
+
 input SetApprovalRuleApprovers {
   approvers: ApproverHierarchyDraft!
 }