https://docs.monei.com/assets/js/a186a65d.03a7f963.js

1"use strict";(self.webpackChunkmonei_docs=self.webpackChunkmonei_docs||[]).push([["13650"],{78152(e,l,a){a.r(l),a.d(l,{metadata:()=>n,default:()=>g,toc:()=>p,Badge:()=>u,Bullet:()=>c,assets:()=>i,frontMatter:()=>d,SpecifiedBy:()=>o,contentTitle:()=>r});var n=JSON.parse('{"id":"apis/graphql/types/objects/payment-rule-field","title":"PaymentRuleField","description":"A field a payment rule condition may reference. path is the value to use in a condition\'s var; the same list is enforced when a rule is created or updated.","source":"@site/docs/apis/graphql/types/objects/payment-rule-field.mdx","sourceDirName":"apis/graphql/types/objects","slug":"/apis/graphql/types/objects/payment-rule-field","permalink":"/apis/graphql/types/objects/payment-rule-field","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedAt":1790004115000,"frontMatter":{"id":"payment-rule-field","title":"PaymentRuleField"},"sidebar":"graphql","previous":{"title":"PaymentRuleFieldRegistry","permalink":"/apis/graphql/types/objects/payment-rule-field-registry"},"next":{"title":"PaymentRule","permalink":"/apis/graphql/types/objects/payment-rule"}}'),s=a(91987),t=a(39844);let d={id:"payment-rule-field",title:"PaymentRuleField"},r,i={},c=()=>(0,s.jsx)(s.Fragment,{children:(0,s.jsx)("span",{style:{fontWeight:"normal",fontSize:".5em",color:"var(--ifm-color-secondary-darkest)"},children:"\xa0\u25CF\xa0"})}),o=e=>(0,s.jsxs)(s.Fragment,{children:["Specification",(0,s.jsx)("a",{className:"link",style:{fontSize:"1.5em",paddingLeft:"4px"},target:"_blank",href:e.url,title:"Specified by "+e.url,children:"\u2398"})]}),u=e=>(0,s.jsx)(s.Fragment,{children:(0,s.jsx)("span",{className:e.class,children:e.text})}),p=[{value:"Fields",id:"fields",level:3},{value:'<code>PaymentRuleField.<b>path</b></code><Bullet></Bullet><code><b>String!</b></code> <Badge class="badge badge--secondary badge--non_null"></Badge> <Badge class="badge badge--secondary "></Badge>',id:"path",level:4},{value:'<code>PaymentRuleField.<b>valueType</b></code><Bullet></Bullet><code><b>PaymentRuleFieldValueType!</b></code> <Badge class="badge badge--secondary badge--non_null"></Badge> <Badge class="badge badge--secondary "></Badge>',id:"value-type",level:4},{value:'<code>PaymentRuleField.<b>enumValues</b></code><Bullet></Bullet><code><b>[String!]</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"enum-values",level:4},{value:"Member Of",id:"member-of",level:3}];function h(e){let l={a:"a",code:"code",h3:"h3",h4:"h4",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(l.p,{children:["A field a payment rule condition may reference. ",(0,s.jsx)(l.code,{children:"path"})," is the value to use in a condition's ",(0,s.jsx)(l.code,{children:"var"}),"; the same list is enforced when a rule is created or updated."]}),"\n",(0,s.jsx)(l.pre,{children:(0,s.jsx)(l.code,{className:"language-graphql",children:"type PaymentRuleField {\n  path: String!\n  valueType: PaymentRuleFieldValueType!\n  enumValues: [String!]\n}\n"})}),"\n",(0,s.jsx)(l.h3,{id:"fields",children:"Fields"}),"\n",(0,s.jsxs)(l.h4,{id:"path",children:[(0,s.jsx)(l.a,{href:"#path",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleField.",(0,s.jsx)("b",{children:"path"})]})}),(0,s.jsx)(c,{}),(0,s.jsx)(l.a,{href:"/apis/graphql/types/scalars/string",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"String!"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary badge--non_null",text:"non-null"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})]}),"\n",(0,s.jsxs)(l.p,{children:["Dotted path usable in a condition, e.g. ",(0,s.jsx)(l.code,{children:"paymentMethod.card.brand"}),"."]}),"\n",(0,s.jsxs)(l.h4,{id:"value-type",children:[(0,s.jsx)(l.a,{href:"#value-type",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleField.",(0,s.jsx)("b",{children:"valueType"})]})}),(0,s.jsx)(c,{}),(0,s.jsx)(l.a,{href:"/apis/graphql/types/enums/payment-rule-field-value-type",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"PaymentRuleFieldValueType!"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary badge--non_null",text:"non-null"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"enum"})]}),"\n",(0,s.jsx)(l.p,{children:"Kind of value the field holds."}),"\n",(0,s.jsxs)(l.h4,{id:"enum-values",children:[(0,s.jsx)(l.a,{href:"#enum-values",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["PaymentRuleField.",(0,s.jsx)("b",{children:"enumValues"})]})}),(0,s.jsx)(c,{}),(0,s.jsx)(l.a,{href:"/apis/graphql/types/scalars/string",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"[String!]"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"list"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})]}),"\n",(0,s.jsxs)(l.p,{children:["Allowed values when ",(0,s.jsx)(l.code,{children:"valueType"})," is ",(0,s.jsx)(l.code,{children:"ENUM"}),"; absent otherwise."]}),"\n",(0,s.jsx)(l.h3,{id:"member-of",children:"Member Of"}),"\n",(0,s.jsxs)(l.p,{children:[(0,s.jsx)(l.a,{href:"/apis/graphql/types/objects/payment-rule-field-registry",children:(0,s.jsx)(l.code,{children:"PaymentRuleFieldRegistry"})}),"  ",(0,s.jsx)(u,{class:"badge badge--secondary badge--relation",text:"object"})]})]})}function g(e={}){let{wrapper:l}={...(0,t.R)(),...e.components};return l?(0,s.jsx)(l,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},39844(e,l,a){a.d(l,{R:()=>d,x:()=>r});var n=a(71763);let s={},t=n.createContext(s);function d(e){let l=n.useContext(t);return n.useMemo(function(){return"function"==typeof e?e(l):{...l,...e}},[l,e])}function r(e){let l;return l=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),n.createElement(t.Provider,{value:l},e.children)}}}]);