Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/examples/ApprovalRule/ApprovalRuleSetCustomFieldAction.json

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

api-specs/api/examples/ApprovalRule/ApprovalRuleSetCustomTypeAction.json

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

api-specs/api/types/approval-rule/ApprovalRule.raml

@@ -69,3 +69,7 @@ properties:
     type: BusinessUnitKeyReference
     description: |
       The [Business Unit](ctp:api:type:BusinessUnit) the Approval Rule belongs to.
+  custom?:
+    type: CustomFields
+    description: |
+      Custom Fields on the Approval Rule.

api-specs/api/types/approval-rule/ApprovalRuleSetCustomFieldAction.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): ApprovalRule
+type: ApprovalRuleUpdateAction
+displayName: ApprovalRuleSetCustomFieldAction
+discriminatorValue: setCustomField
+example: !include ../../examples/ApprovalRule/ApprovalRuleSetCustomFieldAction.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-rule/ApprovalRuleSetCustomTypeAction.raml

@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): ApprovalRule
+type: ApprovalRuleUpdateAction
+displayName: ApprovalRuleSetCustomTypeAction
+discriminatorValue: setCustomType
+example: !include ../../examples/ApprovalRule/ApprovalRuleSetCustomTypeAction.json
+properties:
+  type?:
+    type: TypeResourceIdentifier
+    description: |
+      Defines the [Type](ctp:api:type:Type) that extends the ApprovalRule with [Custom Fields](ctp:api:type:CustomFields).
+      If absent, any existing Type and Custom Fields are removed from the ApprovalRule.
+  fields?:
+    type: FieldContainer
+    description: |
+      Sets the [Custom Fields](ctp:api:type:CustomFields) fields for the ApprovalRule.

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

@@ -6,6 +6,7 @@ description: |
   Defines which resource type a [CustomFieldReferenceType](ctp:api:type:CustomFieldReferenceType) can reference.
 enum:
   - approval-flow
+  - approval-rule
   - associate-role
   - business-unit
   - cart
@@ -25,6 +26,8 @@ enum:
 (enumDescriptions):
   approval-flow: |
     [ApprovalFlow](ctp:api:type:ApprovalFlow)
+  approval-rule: |
+    [ApprovalRule](ctp:api:type:ApprovalRule)
   associate-role: |
     [AssociateRole](ctp:api:type:AssociateRole)
   business-unit: |

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

@@ -8,6 +8,7 @@ enum:
   - address
   - asset
   - approval-flow
+  - approval-rule
   - associate-role
   - business-unit
   - cart-discount
@@ -45,6 +46,8 @@ enum:
     [Asset](ctp:api:type:Asset) on [Category](ctp:api:type:Category) and [ProductVariant](ctp:api:type:ProductVariant)
   approval-flow: |
     [ApprovalFlow](ctp:api:type:ApprovalFlow)
+  approval-rule: |
+    [ApprovalRule](ctp:api:type:ApprovalRule)
   associate-role: |
     [AssociateRole](ctp:api:type:AssociateRole)
   business-unit: |

api-specs/api/types/types.raml

@@ -19,6 +19,8 @@ ApprovalRule: !include approval-rule/ApprovalRule.raml
 ApprovalRuleDraft: !include approval-rule/ApprovalRuleDraft.raml
 ApprovalRulePagedQueryResponse: !include approval-rule/ApprovalRulePagedQueryResponse.raml
 ApprovalRuleSetApproversAction: !include approval-rule/ApprovalRuleSetApproversAction.raml
+ApprovalRuleSetCustomFieldAction: !include approval-rule/ApprovalRuleSetCustomFieldAction.raml
+ApprovalRuleSetCustomTypeAction: !include approval-rule/ApprovalRuleSetCustomTypeAction.raml
 ApprovalRuleSetDescriptionAction: !include approval-rule/ApprovalRuleSetDescriptionAction.raml
 ApprovalRuleSetKeyAction: !include approval-rule/ApprovalRuleSetKeyAction.raml
 ApprovalRuleSetNameAction: !include approval-rule/ApprovalRuleSetNameAction.raml

api-specs/graphql/schema.sdl

@@ -778,6 +778,7 @@ type ApprovalRule implements Versioned {
   requesters: [RuleRequester!]!
   businessUnitRef: KeyReference!
   businessUnit: BusinessUnit!
+  custom: CustomFieldsType
   id: String!
   version: Long!
   createdAt: DateTime!
@@ -864,6 +865,8 @@ input ApprovalRuleUpdateAction {
   setRequesters: SetApprovalRuleRequesters
   setStatus: SetApprovalRuleStatus
   setApprovers: SetApprovalRuleApprovers
+  setCustomField: SetApprovalRuleCustomField
+  setCustomType: SetApprovalRuleCustomType
 }
 
 input ApproveApprovalFlow {
@@ -10532,6 +10535,18 @@ input SetApprovalRuleStatus {
   status: ApprovalRuleStatus!
 }
 
+input SetApprovalRuleCustomField {
+  name: String!
+  value: String
+}
+
+input SetApprovalRuleCustomType {
+  fields: [CustomFieldInput!]
+  type: ResourceIdentifierInput
+  typeKey: String
+  typeId: String
+}
+
 input SetAssociateRoleCustomField {
   name: String!
   value: String