From 2ab7654c23e3eff7ee4ff649faa363fabaf4d86c Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 10:17:59 -0600 Subject: [PATCH 01/22] Update Encrypted Credentials --- tests/testthat/salesforcer.tar.enc | Bin 0 -> 8720 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 tests/testthat/salesforcer.tar.enc diff --git a/tests/testthat/salesforcer.tar.enc b/tests/testthat/salesforcer.tar.enc new file mode 100644 index 0000000000000000000000000000000000000000..36ad03fbb2b1f28a7533b051e6ae590ccae92e6b GIT binary patch literal 8720 zcmV+rBJbVI8M;562k6Izlw=Zax2_?Dc`K!urhyjNd((V~S;PN3H<@132;M76x2fJN zi1qw*zx%02H6GD0e@vp>8~79Qo-1BBc0NZ!$fAXfe`1b}HUZ&Z98PbN6`BCe6LLu7 z5gdBmz0$B9p3?_(r6PN9eNoR`bUl?^1jC~NuFyK%&hYQpQew`Y4rc(pFlSQEg| zLb#9FoVE}_+Iva@0WD!Ju@;k1Wn&AS$W3zp3Ix*sksO~u3*LL-N_}{9d+msI^xS7+ zAqi0Eu$pB;TG)Hjx#0cfXl}9XWng?7VHpYy&3lnOL7gvi>Y!TfqR0w5BmoYX*7ufy)D`aOL4y0ZC^#sh?v$GmsJ>`dS>bo?))2&mKlW7n% zW}1~*FXy0b`Uyjo&wV*92?9XmS8RK^&Gc;zQIP$VU{(8_=M^QoMU*@_2IyS=VYp&y z-bDNet0@M+S3ofz_)O-PKdZ-%4D!fRDFsY1ogn^BZ%PoCI;{Rhey{QaGZLucxjIS9 zY4wl`!~}t=MHv}n?RJH3VnAg=OgXS%`MHE&2m%(7|Gtp)#UfJMV@;NGnNe*f;w_QD ze<(P^p{mWQn(xImr!g(K@4sgZ?zc-3hI{&oEXUkihM6{NKtcJyZrDOZg>HsVAjqTh z0V9-v!StJ=KLbhSakqJz@hD9tpm>xCk@J+>*urev)AuG$3e{KpIAm)s5}?#B zx}UXEz#67TFN#}gX5m+Zdy}7_8C?2=URYwTbIIFpkYhypme+KfcOlo`a+)6bJ~c2z6%jdpS~M?Puior7Me~_Abt`;sG$8^LBS-=L$VWZ;&=1`4Z3$ zug=-9$S%DAJVe#%ewbzdHZwf0g-&VCnG*^|wy}o$jS*dq+q8ET zP(exsNc%FZ?*a9l{C>1d=AgH`EN|&>>mUPyW-dXazNtNqM3LP_*5SO_)xSacZLq^U zb9*m7LCJ*Qo-XB0RHrF^)$LkPRsa~-SdX+>HxzdC>I4uZB@cwnXzK4&e-S$ypoj;< z);0pMQ$OUaQL8Z}f%fya%9E}WC?6OT_Q#EjLCbY*+=A-i<0DMG7p9Uesfdcl0u$F-(NR7D zmmRY^1wPO6?WU|f9%e?;RH5U|tc;)2X$ka8g$7^>^U9rt*pArX8z0pR4-7AZWhvXo zuZ0SCg?qaZ?L!aJa}PoXQ#j4m?sb37bo27qE^?h-JGlQY^i{+D!I%^R6ORj$a*Sqn z19GoVYicd-VK1Sesc+NrbbI}X3M2@sw_mm?uol;#$vImQT8%mauc zOey~72ibsaSV@7G)hUR1D?h71VG_)d{acA3LzfxuNj`y$QI z#H}B@avoU%pqozo(fb_H(r_A7?u=-(j*Z(DoGK^z`Ear()G##lj(l!cEAaP=EL!Pn zp1DJr6Ph~wE$7u_T{>yib9s<=XJrAD;0hFNcv%tNw`e(Wcc9|1blSQ%H_xP=2rj*s z1W5c8CHk6>O$r;-`S+MUVM|_1%G%IK!$KF3T1JnXs;j4t+Yj z)!6G4bfA>RVf0*r`{|DO9%n@Q@s8Ja1Sq~2fz0aAcDj01nEw2mqbWhj_2uhb*X1Yr z(_`-s>iGG{wqTDh+zx;pOb#k-`urE5XX(P6*a+}!4aEk51q5@{NGXM8i$(nDiN^GM zM0;7|z#4s}J;t{!A+B^?GX4SUc7vx%9*vZ~jifWFO`_ozK~Yk60CI)83y`rt)I_`i zCd{@F?|-Iu59OHk9W@!%dRj|XMD~}?r3qv4>2;Mv+GI+akr4q#0fu}50aV-%L^qmS zi7+aMQ(C4xhCo&Q&T-~ql=uH)Cp4Y3A?~z~C3vLob zv)Gz-zV@p?>?VHo4U6rkgX*SCsIn6sNsk>@%$i-8Km;@viA#k)=JxBE&fkYaPw&F5 zh43LOnOZ$(-!Mv8*&V+I;}}Lk$It|mFVgzSg2F~Zq6+vr^1JnQBVB0ZsCO*@%`cw( zbI$LY!Ap^FA)u*~WSC**R@rb9f%2)~Bppw(D|i?cJ_!PcU?sFhmjJ$az|38Ffc?Ra#>4vJ~%w1EGm^Gmuz0*1f9YoYqP*` zyr!5FA%_xlz8ngV0`+Jj9E61{^!xN|l8$EqjUPZY2At2ti=Q{bUyPYO{aa!VO96k& zfjGB@CBj&GHAyH$*#hQ$n2+~=v92xW=W4;krP*E!VY;O5c(z*I0n>22n2Daaj$&ku zZ8LBn)2$0=8QnRm5n+TfnQALq^zV{a&-uIiiFU{T7{EjwjQr$KaTBxqcOGBF+~Ln% zM-h#yLHU@(TZPnm2a;A>Zg8O zkjY&!n-=Z*RTT|IXZWONVyLwp{j+X~B-a{~_c|8yQSP3%z}aMi*6B>C+Q2C$U-W&s zgZ-m0ylWV+8k1&>?ET_~Y zhX+f1Qfp7DU-LPiAM^Vfr32oX$3!ytX~H-;F@|MSn$>P zA;!}sV@cYcaQco(fhI@pk9K)|oCmyIKq|l21eS#%j-y`=qTSTyJkN7yu{F*-n-y1% z8HvxiWMS_7q-hSSTG+gGuuSa`iiC&uD);T$IHl7fNszFV#0T6w0Le6SdrMs{mLu5r z^F5$GVR_cVwSheQz$!npW!}qaP)MS7sp(5+ zn1DsRoM20JCB>7@xt&Uunt_u6l50UWUQcIeUW>BsEVz9)Hu+iIvsa)LB7hVwgzG}% zmGgBT=-!%mTX3{4?8pRi(>&4BZZdw>dy>QbRTK()1cShOl_Q^o)AR@k)qYwRfsc)_ zD~qu%FC44km`D#{{76X82odDdZJG9I@Em!ULuccTKVda6j15)-^B<1x@5;nq7carU?* zu9^0Fq^hvf=d*wCcAu2_-LuB+;`RC!U2wk>wbO6A*AGuZopc5O=t9CGHZqi~bA(?v z3_cD|IJjn(`vn!My{`y>?1mHX>W8KoxQ1%Z-DPoS3daQW z5k*vL6xc!@5JSLrMw-sJ!bB#IKSe-0#KBeBl7A*f)W|Jbs^ZqGXNxVYA!bOG2#~|l z^6Ah#)W04Xqkf2Al3is|9T^z!B!8AYSyLTNjjgodjc<%$K%Nhp%&Pl@kh0R`-o8yb z^B*DsazrB#BLaAAg&s4kCOJ|7>(Gi#`&L}>eoMu$DlE9D85?i(iPCxffs;JK>~S$| zs{c)yi?fUZ$RSZa!v13ZOz3<9`cZWCqwrJrAIYXU#k(FpKJdo-q*3Lay5LW8opQ1V zgxmdYvC`dwZiizM0Zdbd*~i)xhIyNBTeCSvNrx08__|v#{LKu+j{MO(dSEkbx{L0%GyrAG^|6HSFg+=EZ z+It3i5BSl;^O@(n0;*`+XE@)p`+R_FFWI9QTD7HqsO0-9tf$! z7%3#D~zaR5r{ukE?)y%g+OJo%i57QgbnXtreAAsy;q&NQ$C-S+1&B z*BcB9F0^UfwKN*EzpRH)i7feV+{#n=;!V|L|1D4T4bp9(l09OOXD1phctfkLD?`&b z49cfSA2+H|9`LMHds^m>q3U4>?(-n}iE5;TA(v!4Zjp^oy41{* zS)_dm_W!%?N^O$n>M;am!UToN^p!1^|RnX#xZ$R(E?n!fG^h-e3k0N#6A?}r(2cFTD)Ff0+t zkFUSj6X;^|%@07j%+Mz+%tCD63K?JskQtBLkoBF-MjDQyin@qEZv0#-S>3+0d91p^ zzfT*cmIDnv3P+i;VGoy<>&7C44?g=HkJ;53&}uL;3{=LQ_uB-!v1RJ@W6AU2CN9muhjaF&kZT4rJeDzjA zDsv#+m=!D{FMoQhA)4{9PYcBFCi)8jxvgrbLu7t!`TtQBIOu|-LRJA~bT_(Apm&f{tW&|4n4r`*U`T{p5ouRHkr$$Krt@|m zr>=qSjkD}4IZfn#=a$~)7^b9BA1i320tU|~G^scvp-#fOHLU4lkh^yoPTs{ntXyg@ zfkVy`*OT=CucuMZ>;yJfSz9%Q6q-+N41+55Fa!QOj=hVVsS#Z?n8hrBJshA}o-NeX ziFIEeS5r*{S`B5q6u$1~9vs@S0c+7{h*IS~F564VL8Zg)*St$F3h($K)0+nn&U3q- z=P-I;7P_wKS43^&+Wi+RDGyFNKIMS0r?RdczU&->017?DRj-*`eVo#Po0M@$XWz^} zj)#>;-c>g0ZQpkTb-HP`t2HyRw=yCpG7LNwDPnNSBR3CMm{zK%Tg432=l&cv@kQkOgaB}VLlPRe~L zU3n!wBvc*@7!k<$E)g#VSOeJfhyU0LKR!;3ru4IbznX&d1XE}BE|<=g)2p)^l?B4U zSRuQOv7_g|Nv$@u`G2rUj)ef>mYjwAbZa0K+u0Yq*>i z>;i8QJ21doT_}G>THgok$8ID(3h9mdImHPz5&3iY8#&7ZJt+s1xvhw90CFKX6_cIt zvR;tyN}_lkyo9Mu%`HseX>FZUONPcZChsQRjFHCy_+@k7LB9Mb&0eKBMx?We!9@}R z{kgr;*ZIFfkB=)4L!;z`-ePoMNkojAU3?$8zkM^6cG8km?oK5Q8U)<}RfYGCM@MoQc=gSDn%F<gb0Zt)MCQL9#RZYa12V8zUp?bXU;&bBvNCzG`SQGq4l{@?jS!S}bFRk6l%M`)!FZ#J42XBwG8*)3tah*x zZ_czO+OL`z>fA7+XI0+C9!yFUn9K1k?D_#~)xzCBYXKf=5nBMj14_FsCf9lhVpNnp zKh~1bH-$t#8 z!v-QHm*%bBg=@ijGN^i2%~wi3y?&Nc3IDvvFUEE9vTG1ey;<<~3vQjiS&=b3ahx3s za_6@)0WHh?g}nN9F7h@Tc*NQac;vZ6%Hz#s!-g8(+5|==f#h4yX9HPizYR z$uGV?l=Qidm^*}6)3(tE#D|?2WI;pm&6S*w5|7W_1NF9S79JIorsCkPD}~Fj^8xeo zF~>0v`BPh-b3&q5w&)e!(=dc30L_-RunJs0+HVzpZDS8~^|?JbY{_ zsrLR9xMEQNkwn>8^U+iGJ*#YPZ`kXyB+H4deoVl}u5TMZ`Q5klw#Gh(GKCj^TFMLBxH(Q+?{ z&2m4qXc(1(PhhFZf0pv~=>EvtBgWWq)dY0r0bOY`+0NmxKO;+U>Gu;%t(ZF@$qGqX z05H?yjIhUqv6wgl`dAqP+;0$xwT@jd6ec)v@8`*Po z`SNS%$_)U13Diu@ZfwU9wB<=%L;ze<80EZfuR7}ft|g2FCz(=RjwBiuDf6lP@cL1a z2A)AUz0a;DYl&@uGF#Gk|2VO?1a>K7L$Lj#P6LnzR!c8qd{|DmDbhn#BQ@1bFIOl6-sKTgwcA+uDi7 z$dM8DW(L*3X=x3KS5@b#;o$#R;4?D<$$smF<6OqzGPbv!M)e!*qME>Pvg3wP!Ry>E z4lTB^`=Ukmn#?2KIA)7d18D!2N_`H_6tGJ|#L`Uf*E`F``%k%GcRxU#c; zw9ZC7*Ngqt%PX&Lxfb2+b0E7?oX>uBHvu@TBQ3PEzrD(9y2)G2fGK@Oncb`L=OO8j`%WtUA@xF9p<$12YjF z?1}o%5YRVHQ}CkFuY0u{xCxI{WO~LzF%ui9_T)>FP1E$~j{@cGW!}1u2HXsILIQGd zN-6#qRMtHmE3+QUSwop<`TE6=4D5lv*ed&sx!X|V$*dJfzvyezOD{gz-e?uqCEMwU z{$UrkRsiXQE4Tx=jY*645_%2Wf%1D0DJ?^wt50H_bVVV+_-%u==znMf-~6`^j|uRo zfsjE1>r-TW8vCr!QlVuGPuGN4^ytHq5knN2c|-xj0KNS?mnq8yTn1T5SfR1iyZaK<7KiJ4qzIY>-5eb+22?-tU#RpCu$1~ zc?vmUrSe9_XPhKsjqbXY@8(Tw$>%*I|*`CS5- z@r_YXIMq!^_!nATp^W`dtPL=jTj9iqY{xH{1BS5xK6Yo%UMUa^EBbI}!6W0Sm$v`S z))mvgk*nJXLF9Cn(0RS~^FN&VjxK1Rea9(#6ggZkEo{p!llk>;ePoE!=qt$L1$QjGZyg7z~kTbuZpDckiaGp8i~ z2Rtwnp48%Y0;xhB-8SKg+g`=#5b1ArN+?18D4p9F=ihde+_VIeMV}vjvdViSg)a7}zM(44;44w?2?RT2P$<#LZ|#+FlfC;{Lb}#^Lar86NJ$ z0WdBlAdSjTe=!nl(c9NgJr|md%fFrPjeMVfem&)?)e>L2v*XDbE)}5H>)|Z&(Ne@e zSait;#i^e*8kn3u{ZTM8a>Cjba9dNEH3#PvI|&tG4lvQFW*o`ANNoOD8~b+;&@rS< z%%HY=AL9s&4SK;mmK10O}mt+QpK8<&3~7Y+p-LjZQ%aZI4t%(>eGd*q>YFgIz@tDq7Yhp5=tr% zq!F+!x`L%@5OYPwM61Sf@ZLHd?#FlcGDN%%jQNu_KE4XN8mQ`Rl-`HI2+3!%_8x=^qB}42q??LWl!w&IC?sOe4tvaqhDz35-XapwCjOl z6{X%1j=KtFl^K`j96EJRXOT5-D0)Ji=Aftk(?B$}`ugb2*T<~A)IM{+m_esUD2&Kv zNYMR=J4djFQXruAtb?5kSJs|JJs}gb8`_q!ch+Y_b5Zm2#uTPufRXdOnBU`CoCJfB z@0~E=?JxyB-gs~(ckA#p@a!HTHkfJ~KcI7Ox(&vhRUTN^v2yTA{MB|5MhEe_azOv1 z`P8UtuAZ1WK1eJuc-xz2vqH-YM^FU-Rl8qeM%IpUgzu;+tjf=p(x6QTIM?V$Z?-Nw uk54$*@0;ZjQbM2A;tY{&WKy(iaN-{UYAS_@2}ChCfn`-*|ILHE^lLRoMEIfr literal 0 HcmV?d00001 From d178f3a3b1584382511fef21cb8cbaf8bff5c6b7 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 12:43:36 -0600 Subject: [PATCH 02/22] Updates for v1.0.1 --- .github/workflows/dev-01-R-CMD-check.yml | 9 +- .gitignore | 1 + DESCRIPTION | 6 +- NAMESPACE | 24 +- NEWS.md | 75 +- R/analytics-dashboard.R | 110 +- R/auth.R | 12 + R/compatibility.R | 2 +- R/utils-datatypes.R | 2 +- R/zzz.R | 2 +- _pkgdown.yml | 20 +- docs/404.html | 176 +- docs/CODE_OF_CONDUCT.html | 143 +- docs/CONTRIBUTING.html | 198 +- docs/LICENSE-text.html | 141 +- docs/LICENSE.html | 141 +- docs/SECURITY.html | 148 +- docs/SUPPORT.html | 147 +- docs/articles/getting-started.html | 206 +- docs/articles/index.html | 171 +- docs/articles/passing-control-args.html | 121 +- docs/articles/supported-queries.html | 346 +- .../figure-html/run-performance-test-1.png | Bin 33869 -> 13388 bytes .../transitioning-from-RForcecom.html | 175 +- docs/articles/working-with-attachments.html | 218 +- docs/articles/working-with-bulk-apis.html | 166 +- .../figure-html/unnamed-chunk-7-1.png | Bin 36756 -> 49612 bytes docs/articles/working-with-metadata.html | 152 +- docs/articles/working-with-reports.html | 188 +- docs/authors.html | 197 +- docs/index.html | 220 +- docs/news/index.html | 580 +- docs/pkgdown.css | 83 +- docs/pkgdown.js | 4 +- docs/pkgdown.yml | 6 +- docs/reference/VERB_n.html | 172 +- docs/reference/accepted_controls_by_api.html | 170 +- .../accepted_controls_by_operation.html | 174 +- docs/reference/bind_query_resultsets.html | 184 +- .../build_manifest_xml_from_list.html | 188 +- .../build_metadata_xml_from_list.html | 213 +- docs/reference/build_proxy.html | 158 +- docs/reference/build_soap_xml_from_list.html | 251 +- docs/reference/catch_errors.html | 164 +- docs/reference/catch_unknown_api.html | 176 +- docs/reference/check_and_encode_files.html | 187 +- .../collapse_list_with_dupe_names.html | 190 +- .../combine_parent_and_child_resultsets.html | 184 +- docs/reference/compact2.html | 188 +- docs/reference/drop_attributes.html | 190 +- .../drop_attributes_recursively.html | 198 +- docs/reference/drop_empty_recursively.html | 176 +- docs/reference/drop_nested_child_records.html | 176 +- .../extract_nested_child_records.html | 176 +- .../extract_records_from_xml_node.html | 198 +- .../extract_records_from_xml_nodeset.html | 198 +- ...t_records_from_xml_nodeset_of_records.html | 210 +- docs/reference/filter_valid_controls.html | 174 +- docs/reference/flatten_tbl_df.html | 174 +- .../reference/format_headers_for_verbose.html | 165 +- docs/reference/format_report_row.html | 212 +- docs/reference/get_os.html | 182 +- .../guess_object_name_from_soql.html | 165 +- docs/reference/index.html | 598 +- docs/reference/is_legit_token.html | 164 +- .../list_extract_parent_and_child_result.html | 176 +- ...analytics_folder_child_operations_url.html | 166 +- ...make_analytics_folder_collections_url.html | 160 +- .../make_analytics_folder_operations_url.html | 166 +- ...make_analytics_folder_share_by_id_url.html | 169 +- ...analytics_folder_share_recipients_url.html | 172 +- .../make_analytics_folder_shares_url.html | 166 +- ...analytics_notification_operations_url.html | 160 +- ...ke_analytics_notifications_limits_url.html | 160 +- ...make_analytics_notifications_list_url.html | 160 +- docs/reference/make_base_metadata_url.html | 160 +- docs/reference/make_base_rest_url.html | 160 +- docs/reference/make_base_soap_url.html | 160 +- .../make_bulk_batch_details_url.html | 172 +- .../reference/make_bulk_batch_status_url.html | 172 +- docs/reference/make_bulk_batches_url.html | 169 +- docs/reference/make_bulk_create_job_url.html | 175 +- docs/reference/make_bulk_delete_job_url.html | 169 +- .../make_bulk_end_job_generic_url.html | 169 +- .../reference/make_bulk_get_all_jobs_url.html | 179 +- .../make_bulk_get_all_query_jobs_url.html | 181 +- docs/reference/make_bulk_get_job_url.html | 180 +- docs/reference/make_bulk_job_records_url.html | 180 +- .../reference/make_bulk_query_result_url.html | 185 +- docs/reference/make_bulk_query_url.html | 169 +- docs/reference/make_chatter_users_url.html | 160 +- docs/reference/make_composite_batch_url.html | 160 +- docs/reference/make_composite_url.html | 160 +- docs/reference/make_dashboard_copy_url.html | 166 +- .../make_dashboard_describe_url.html | 166 +- ...e_dashboard_filter_operators_list_url.html | 166 +- ...dashboard_filter_options_analysis_url.html | 166 +- docs/reference/make_dashboard_status_url.html | 166 +- docs/reference/make_dashboard_url.html | 166 +- docs/reference/make_dashboards_list_url.html | 160 +- docs/reference/make_login_url.html | 172 +- .../make_parameterized_search_url.html | 177 +- docs/reference/make_query_url.html | 173 +- docs/reference/make_report_copy_url.html | 166 +- docs/reference/make_report_create_url.html | 160 +- docs/reference/make_report_describe_url.html | 166 +- docs/reference/make_report_execute_url.html | 176 +- docs/reference/make_report_fields_url.html | 166 +- ...make_report_filter_operators_list_url.html | 166 +- docs/reference/make_report_instance_url.html | 170 +- .../make_report_instances_list_url.html | 166 +- docs/reference/make_report_query_url.html | 160 +- .../make_report_type_describe_url.html | 165 +- .../reference/make_report_types_list_url.html | 160 +- docs/reference/make_report_url.html | 166 +- docs/reference/make_reports_list_url.html | 160 +- docs/reference/make_rest_describe_url.html | 175 +- docs/reference/make_rest_objects_url.html | 166 +- docs/reference/make_rest_record_url.html | 169 +- docs/reference/make_search_url.html | 165 +- docs/reference/make_soap_xml_skeleton.html | 190 +- docs/reference/make_verbose_httr_message.html | 190 +- docs/reference/map_sf_type_to_r_type.html | 191 +- docs/reference/merge_null_to_na.html | 171 +- docs/reference/message_w_errors_listed.html | 182 +- docs/reference/metadata_type_validator.html | 20878 ++++++++++------ .../parameterized_search_control.html | 256 +- .../parse_error_code_and_message.html | 163 +- docs/reference/parse_report_detail_rows.html | 256 +- docs/reference/patched_tempdir.html | 182 +- docs/reference/rDELETE.html | 158 +- docs/reference/rGET.html | 158 +- docs/reference/rPATCH.html | 158 +- docs/reference/rPOST.html | 158 +- docs/reference/rPUT.html | 158 +- docs/reference/records_list_to_tbl.html | 192 +- .../remove_empty_linked_object_cols.html | 177 +- docs/reference/return_matching_controls.html | 167 +- docs/reference/rforcecom.bulkAction.html | 288 +- docs/reference/rforcecom.bulkQuery.html | 227 +- docs/reference/rforcecom.create.html | 191 +- docs/reference/rforcecom.delete.html | 191 +- .../rforcecom.getObjectDescription.html | 190 +- .../rforcecom.getServerTimestamp.html | 172 +- docs/reference/rforcecom.login.html | 213 +- docs/reference/rforcecom.query.html | 193 +- docs/reference/rforcecom.retrieve.html | 250 +- docs/reference/rforcecom.search.html | 178 +- docs/reference/rforcecom.update.html | 197 +- docs/reference/rforcecom.upsert.html | 203 +- docs/reference/safe_bind_rows.html | 198 +- docs/reference/salesforcer-package.html | 185 +- docs/reference/salesforcer_state.html | 158 +- docs/reference/session_id_available.html | 165 +- docs/reference/set_null_elements_to_na.html | 176 +- .../set_null_elements_to_na_recursively.html | 176 +- docs/reference/sf_abort_job_bulk.html | 214 +- docs/reference/sf_access_token.html | 174 +- .../sf_analytics_notification_create.html | 171 +- .../sf_analytics_notification_delete.html | 171 +- .../sf_analytics_notification_describe.html | 171 +- .../sf_analytics_notification_update.html | 179 +- .../sf_analytics_notifications_limits.html | 200 +- .../sf_analytics_notifications_list.html | 210 +- docs/reference/sf_auth.html | 317 +- docs/reference/sf_auth_check.html | 178 +- docs/reference/sf_auth_refresh.html | 176 +- docs/reference/sf_batch_details_bulk.html | 239 +- docs/reference/sf_batch_status_bulk.html | 241 +- docs/reference/sf_build_cols_spec.html | 174 +- docs/reference/sf_close_job_bulk.html | 229 +- docs/reference/sf_control.html | 432 +- docs/reference/sf_convert_lead.html | 307 +- docs/reference/sf_copy_report.html | 281 +- docs/reference/sf_create.html | 290 +- docs/reference/sf_create_attachment.html | 313 +- .../sf_create_attachment_bulk_v1.html | 168 +- docs/reference/sf_create_attachment_rest.html | 166 +- docs/reference/sf_create_attachment_soap.html | 166 +- docs/reference/sf_create_batches_bulk.html | 268 +- docs/reference/sf_create_bulk_v1.html | 168 +- docs/reference/sf_create_bulk_v2.html | 168 +- docs/reference/sf_create_job_bulk.html | 336 +- docs/reference/sf_create_job_bulk_v1.html | 212 +- docs/reference/sf_create_job_bulk_v2.html | 214 +- docs/reference/sf_create_metadata.html | 340 +- docs/reference/sf_create_report.html | 309 +- docs/reference/sf_create_rest.html | 168 +- docs/reference/sf_create_soap.html | 168 +- .../sf_dashboard_components_describe.html | 179 +- docs/reference/sf_dashboard_copy.html | 179 +- docs/reference/sf_dashboard_delete.html | 171 +- docs/reference/sf_dashboard_describe.html | 204 +- .../sf_dashboard_filter_operators_list.html | 156 +- .../sf_dashboard_filter_options_analysis.html | 195 +- docs/reference/sf_dashboard_refresh.html | 179 +- docs/reference/sf_dashboard_results.html | 199 +- .../sf_dashboard_set_sticky_filter.html | 187 +- docs/reference/sf_dashboard_status.html | 195 +- docs/reference/sf_dashboard_update.html | 179 +- docs/reference/sf_dashboards_list.html | 196 +- docs/reference/sf_delete.html | 280 +- docs/reference/sf_delete_attachment.html | 273 +- docs/reference/sf_delete_bulk_v1.html | 168 +- docs/reference/sf_delete_bulk_v2.html | 168 +- docs/reference/sf_delete_job_bulk.html | 198 +- docs/reference/sf_delete_metadata.html | 242 +- docs/reference/sf_delete_report.html | 248 +- docs/reference/sf_delete_report_instance.html | 240 +- docs/reference/sf_delete_rest.html | 168 +- docs/reference/sf_delete_soap.html | 168 +- docs/reference/sf_describe_metadata.html | 194 +- docs/reference/sf_describe_object_fields.html | 190 +- docs/reference/sf_describe_objects.html | 242 +- docs/reference/sf_describe_report.html | 273 +- docs/reference/sf_describe_report_type.html | 263 +- docs/reference/sf_download_attachment.html | 276 +- docs/reference/sf_empty_recycle_bin.html | 256 +- docs/reference/sf_end_job_bulk.html | 208 +- docs/reference/sf_execute_report.html | 420 +- docs/reference/sf_find_duplicates.html | 252 +- docs/reference/sf_find_duplicates_by_id.html | 228 +- docs/reference/sf_format_date.html | 172 +- docs/reference/sf_format_datetime.html | 173 +- docs/reference/sf_format_time.html | 198 + docs/reference/sf_get_all_jobs_bulk.html | 238 +- .../reference/sf_get_all_query_jobs_bulk.html | 244 +- docs/reference/sf_get_dashboard_data.html | 195 +- docs/reference/sf_get_deleted.html | 211 +- docs/reference/sf_get_job_bulk.html | 226 +- docs/reference/sf_get_job_records_bulk.html | 251 +- .../sf_get_report_instance_results.html | 339 +- docs/reference/sf_get_updated.html | 211 +- docs/reference/sf_guess_cols.html | 172 +- docs/reference/sf_input_data_validation.html | 172 +- docs/reference/sf_job_batches_bulk.html | 221 +- docs/reference/sf_list_api_limits.html | 182 +- docs/reference/sf_list_metadata.html | 213 +- docs/reference/sf_list_objects.html | 170 +- docs/reference/sf_list_report_fields.html | 275 +- .../sf_list_report_filter_operators.html | 244 +- docs/reference/sf_list_report_instances.html | 244 +- docs/reference/sf_list_report_types.html | 242 +- docs/reference/sf_list_reports.html | 265 +- docs/reference/sf_list_resources.html | 170 +- docs/reference/sf_list_rest_api_versions.html | 170 +- docs/reference/sf_merge.html | 291 +- docs/reference/sf_query.html | 326 +- docs/reference/sf_query_bulk_v1.html | 308 +- docs/reference/sf_query_bulk_v2.html | 308 +- docs/reference/sf_query_report.html | 258 +- docs/reference/sf_query_result_bulk.html | 284 +- docs/reference/sf_query_result_bulk_v1.html | 274 +- docs/reference/sf_query_result_bulk_v2.html | 272 +- docs/reference/sf_read_metadata.html | 206 +- docs/reference/sf_rename_metadata.html | 218 +- docs/reference/sf_reorder_cols.html | 172 +- docs/reference/sf_report_folder_children.html | 180 +- docs/reference/sf_report_folder_create.html | 171 +- docs/reference/sf_report_folder_delete.html | 171 +- docs/reference/sf_report_folder_describe.html | 171 +- .../sf_report_folder_share_delete.html | 179 +- .../sf_report_folder_share_describe.html | 179 +- .../sf_report_folder_share_recipients.html | 203 +- .../sf_report_folder_share_update.html | 187 +- .../sf_report_folder_shares_add.html | 181 +- .../sf_report_folder_shares_list.html | 171 +- .../sf_report_folder_shares_update.html | 181 +- docs/reference/sf_report_folder_update.html | 179 +- docs/reference/sf_report_folders_list.html | 156 +- docs/reference/sf_reset_password.html | 213 +- docs/reference/sf_rest_list.html | 191 +- docs/reference/sf_retrieve.html | 269 +- docs/reference/sf_retrieve_metadata.html | 247 +- .../sf_retrieve_metadata_check_status.html | 237 +- docs/reference/sf_retrieve_rest.html | 170 +- docs/reference/sf_retrieve_soap.html | 170 +- docs/reference/sf_run_bulk_operation.html | 387 +- docs/reference/sf_run_bulk_query.html | 354 +- docs/reference/sf_run_report.html | 474 +- docs/reference/sf_search.html | 289 +- docs/reference/sf_server_timestamp.html | 170 +- docs/reference/sf_session_id.html | 174 +- docs/reference/sf_set_password.html | 199 +- docs/reference/sf_submit_query_bulk.html | 226 +- docs/reference/sf_undelete.html | 257 +- docs/reference/sf_update.html | 282 +- docs/reference/sf_update_attachment.html | 299 +- .../sf_update_attachment_bulk_v1.html | 168 +- docs/reference/sf_update_attachment_rest.html | 166 +- docs/reference/sf_update_attachment_soap.html | 166 +- docs/reference/sf_update_bulk_v1.html | 168 +- docs/reference/sf_update_bulk_v2.html | 168 +- docs/reference/sf_update_metadata.html | 289 +- docs/reference/sf_update_report.html | 291 +- docs/reference/sf_update_rest.html | 168 +- docs/reference/sf_update_soap.html | 168 +- docs/reference/sf_upload_complete_bulk.html | 211 +- docs/reference/sf_upsert.html | 301 +- docs/reference/sf_upsert_bulk_v1.html | 170 +- docs/reference/sf_upsert_bulk_v2.html | 170 +- docs/reference/sf_upsert_metadata.html | 295 +- docs/reference/sf_upsert_rest.html | 170 +- docs/reference/sf_upsert_soap.html | 170 +- docs/reference/sf_user_info.html | 193 +- docs/reference/sf_write_csv.html | 170 +- docs/reference/simplify_report_metadata.html | 184 +- docs/reference/stop_w_errors_listed.html | 182 +- docs/reference/token_available.html | 165 +- docs/reference/unbox_list_elements.html | 180 +- .../unbox_list_elements_recursively.html | 180 +- docs/reference/unnest_col.html | 182 +- docs/reference/valid_metadata_list.html | 154 +- .../validate_get_all_jobs_params.html | 175 +- docs/reference/warn_w_errors_listed.html | 182 +- docs/reference/xmlToList2.html | 174 +- docs/reference/xml_drop_and_unlist.html | 177 +- .../xml_drop_and_unlist_recursively.html | 176 +- .../xml_extract_parent_and_child_result.html | 175 +- docs/reference/xml_nodeset_to_df.html | 174 +- docs/sitemap.xml | 84 +- ...dashboard_copy.Rd => sf_copy_dashboard.Rd} | 6 +- ...board_delete.Rd => sf_delete_dashboard.Rd} | 6 +- ...d_describe.Rd => sf_describe_dashboard.Rd} | 6 +- ...Rd => sf_describe_dashboard_components.Rd} | 6 +- ... => sf_filter_dashboard_operators_list.Rd} | 6 +- ...> sf_filter_dashboard_options_analysis.Rd} | 6 +- ...results.Rd => sf_get_dashboard_results.Rd} | 6 +- ...d_status.Rd => sf_get_dashboard_status.Rd} | 6 +- ...shboards_list.Rd => sf_list_dashboards.Rd} | 6 +- ...ard_refresh.Rd => sf_refresh_dashboard.Rd} | 6 +- ...r.Rd => sf_set_dashboard_sticky_filter.Rd} | 6 +- ...board_update.Rd => sf_update_dashboard.Rd} | 6 +- vignettes/getting-started.Rmd | 25 +- vignettes/passing-control-args.Rmd | 11 +- vignettes/supported-queries.Rmd | 9 +- vignettes/transitioning-from-RForcecom.Rmd | 64 +- vignettes/working-with-attachments.Rmd | 10 +- vignettes/working-with-bulk-apis.Rmd | 10 +- vignettes/working-with-metadata.Rmd | 10 +- vignettes/working-with-reports.Rmd | 10 +- 341 files changed, 30367 insertions(+), 52620 deletions(-) create mode 100644 docs/reference/sf_format_time.html rename man/{sf_dashboard_copy.Rd => sf_copy_dashboard.Rd} (85%) rename man/{sf_dashboard_delete.Rd => sf_delete_dashboard.Rd} (84%) rename man/{sf_dashboard_describe.Rd => sf_describe_dashboard.Rd} (92%) rename man/{sf_dashboard_components_describe.Rd => sf_describe_dashboard_components.Rd} (80%) rename man/{sf_dashboard_filter_operators_list.Rd => sf_filter_dashboard_operators_list.Rd} (74%) rename man/{sf_dashboard_filter_options_analysis.Rd => sf_filter_dashboard_options_analysis.Rd} (87%) rename man/{sf_dashboard_results.Rd => sf_get_dashboard_results.Rd} (94%) rename man/{sf_dashboard_status.Rd => sf_get_dashboard_status.Rd} (93%) rename man/{sf_dashboards_list.Rd => sf_list_dashboards.Rd} (92%) rename man/{sf_dashboard_refresh.Rd => sf_refresh_dashboard.Rd} (87%) rename man/{sf_dashboard_set_sticky_filter.Rd => sf_set_dashboard_sticky_filter.Rd} (93%) rename man/{sf_dashboard_update.Rd => sf_update_dashboard.Rd} (89%) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index e6157cb2..a1fe932f 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -17,12 +17,17 @@ jobs: R_REMOTES_NO_ERRORS_FROM_WARNINGS: true GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_PASSWORD: ${{ secrets.SALESFORCER_PASSWORD }} - SALESFORCER_SECURITY_TOKEN: ${{ secrets.SALESFORCER_SECURITY_TOKEN }} steps: - uses: actions/checkout@v2 + - name: Retrieve the OAuth Token secret and decode it to a file + env: + SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} + run: | + echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds + mv salesforcer_token.rds tests/testthat + - name: Reveal env vars run: | echo GITHUB_WORKFLOW = $GITHUB_WORKFLOW diff --git a/.gitignore b/.gitignore index 5616166d..f7066bc6 100644 --- a/.gitignore +++ b/.gitignore @@ -29,6 +29,7 @@ vignettes/*.R salesforcer_test_settings.rds salesforcer_token.rds salesforcer.tar +salesforcer_token.base64 # knitr and R markdown default cache directories /*_cache/ diff --git a/DESCRIPTION b/DESCRIPTION index 14948f7f..da4adb6b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: salesforcer Title: An Implementation of 'Salesforce' APIs Using Tidy Principles -Version: 1.0.0 -Date: 2021-07-04 +Version: 1.0.1 +Date: 2022-02-27 Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, Bulk 1.0, Bulk 2.0, Metadata, Reports and Dashboards) . @@ -70,4 +70,4 @@ ByteCompile: true Encoding: UTF-8 Language: en-US Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.1 +RoxygenNote: 7.1.2 diff --git a/NAMESPACE b/NAMESPACE index 1c22e0ef..8bfcf5c0 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -148,6 +148,7 @@ export(sf_bulk_operation) export(sf_close_job_bulk) export(sf_control) export(sf_convert_lead) +export(sf_copy_dashboard) export(sf_copy_report) export(sf_create) export(sf_create_attachment) @@ -157,24 +158,15 @@ export(sf_create_job_bulk_v1) export(sf_create_job_bulk_v2) export(sf_create_metadata) export(sf_create_report) -export(sf_dashboard_components_describe) -export(sf_dashboard_copy) -export(sf_dashboard_delete) -export(sf_dashboard_describe) -export(sf_dashboard_filter_operators_list) -export(sf_dashboard_filter_options_analysis) -export(sf_dashboard_refresh) -export(sf_dashboard_results) -export(sf_dashboard_set_sticky_filter) -export(sf_dashboard_status) -export(sf_dashboard_update) -export(sf_dashboards_list) export(sf_delete) export(sf_delete_attachment) +export(sf_delete_dashboard) export(sf_delete_job_bulk) export(sf_delete_metadata) export(sf_delete_report) export(sf_delete_report_instance) +export(sf_describe_dashboard) +export(sf_describe_dashboard_components) export(sf_describe_metadata) export(sf_describe_object_fields) export(sf_describe_objects) @@ -184,6 +176,8 @@ export(sf_download_attachment) export(sf_empty_recycle_bin) export(sf_end_job_bulk) export(sf_execute_report) +export(sf_filter_dashboard_operators_list) +export(sf_filter_dashboard_options_analysis) export(sf_find_duplicates) export(sf_find_duplicates_by_id) export(sf_format_date) @@ -192,6 +186,8 @@ export(sf_format_time) export(sf_get_all_jobs_bulk) export(sf_get_all_query_jobs_bulk) export(sf_get_dashboard_data) +export(sf_get_dashboard_results) +export(sf_get_dashboard_status) export(sf_get_deleted) export(sf_get_job_bulk) export(sf_get_job_records_bulk) @@ -201,6 +197,7 @@ export(sf_guess_cols) export(sf_input_data_validation) export(sf_job_batches_bulk) export(sf_list_api_limits) +export(sf_list_dashboards) export(sf_list_metadata) export(sf_list_objects) export(sf_list_report_fields) @@ -220,6 +217,7 @@ export(sf_query_result_bulk) export(sf_query_result_bulk_v1) export(sf_query_result_bulk_v2) export(sf_read_metadata) +export(sf_refresh_dashboard) export(sf_rename_metadata) export(sf_reorder_cols) export(sf_report_folder_children) @@ -246,11 +244,13 @@ export(sf_run_report) export(sf_search) export(sf_server_timestamp) export(sf_session_id) +export(sf_set_dashboard_sticky_filter) export(sf_set_password) export(sf_submit_query_bulk) export(sf_undelete) export(sf_update) export(sf_update_attachment) +export(sf_update_dashboard) export(sf_update_metadata) export(sf_update_report) export(sf_upload_complete_bulk) diff --git a/NEWS.md b/NEWS.md index c5659896..e4f6c340 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,23 @@ -## salesforcer 1.0.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v1.0.0) +# salesforcer 1.0.1 -### Dependencies +## Dependencies + + * Increase the package's default Salesforce API version to 54.0 (Spring '22). + * Added a deprecation warning that using basic authentication (password and + security token) will no longer work since Salesforce announced that all + customers will be migrated to MFA beginning February 1st, 2022 + ([link](https://admin.salesforce.com/blog/2021/everything-admins-need-to-know-about-the-mfa-requirement)). + Many thanks to @klaw2 for highlighting in #113. + +## Bug fixes + + * Changed the naming convention for dashboard-related functions to contain the + action verb + `sf_{action}_dashboard` (e.g., `sf_copy_dashboard`) + +# salesforcer 1.0.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v1.0.0) + +## Dependencies * Increase the package's default Salesforce API version to 52.0 (Summer '21). @@ -29,7 +46,7 @@ functionality implemented and a focus on backwards compatibility due to the volume of users. -### Features +## Features * Improve documentation to retrieve the access token or session ID after authentication (#97) @@ -37,7 +54,7 @@ * Improve parsing of Bulk API query recordsets from CSV where all values in the column will be used to guess the type instead of the first 1000. -### Bug fixes +## Bug fixes * Generalize the date and datetime parsing mechanism, such that, reports with date and datetime fields are not returned as NA (#93) @@ -49,9 +66,9 @@ --- -## salesforcer 0.2.2 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.2.2) +# salesforcer 0.2.2 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.2.2) -### Dependencies +## Dependencies * This release relaxes the dependency on {dplyr} and brings back use of `rbindlist()` from {data.table} because of limitations of `dplyr::bind_rows()`. @@ -66,18 +83,18 @@ Warning: replacing previous import 'vctrs::data_frame' by 'tibble::data_frame' when loading 'dplyr' ``` -### Features +## Features * None -### Bug fixes +## Bug fixes * None -## salesforcer 0.2.1 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.2.1) +# salesforcer 0.2.1 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.2.1) -### Dependencies +## Dependencies * **CAUTION: This release requires {dplyr 1.0.0} because {dplyr 1.0.1} introduced a bug in `bind_rows()` with how it binds lists where the list elements have differing @@ -89,7 +106,7 @@ remotes::install_version("dplyr", "1.0.0") ``` -### Features +## Features * Add support for the `defaultLimit` argument in `sf_search()` to be able to restrict the number of records from each individual object when searching @@ -100,7 +117,7 @@ `sf_download_attachment()` function returns the file path of the downloaded content instead of a logical indicating success. -### Bug fixes +## Bug fixes * Fix bug introduced in {salesforcer 0.2.0} which could not stack records with errors longer than length 1. The new solution is to always return the `errors` @@ -110,15 +127,15 @@ --- -## salesforcer 0.2.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.2.0) +# salesforcer 0.2.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.2.0) -### Dependencies +## Dependencies * **CAUTION: This release only has automated test coverage on R 4.0.0 or greater. Users should still be able to install and run using R (>= 3.6.0). However, it is recommended to upgrade to R 4.0.0 or greater.** -### Features +## Features * Add experimental support for the Reports and Dashboards REST API. @@ -174,7 +191,7 @@ should only affect `sf_read_metadata()`. -### Bug Fixes +## Bug Fixes * Fix bug that prevented enabling PKChunking in Bulk 1.0 queries. Users can now specify using `TRUE/FALSE` or details like `chunkSize` that imply `TRUE`. @@ -193,9 +210,9 @@ --- -## salesforcer 0.1.4 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.4) +# salesforcer 0.1.4 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.4) -### Features +## Features * Rebuilt package against R 4.0 (no issues observed with 3.6.3, 4.0.0, 4.0.1) (#53) @@ -220,7 +237,7 @@ * Add Attachment and Metadata vignettes along with updated Bulk vignette. -### Bug Fixes +## Bug Fixes * Fix issue where REST query was not correctly passing and honoring the batch size control argument to paginate results @@ -248,9 +265,9 @@ --- -## salesforcer 0.1.3 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.3) +# salesforcer 0.1.3 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.3) -### Features +## Features * Upgrade to version 46.0 (Summer '19) from version 45.0 (Spring '19) @@ -293,7 +310,7 @@ * Add new function `sf_merge()` which combines up to 3 records of the same type into 1 record (#22) -### Bug Fixes +## Bug Fixes * Fix bug where Username/Password authenticated sessions where not working with api_type = "Bulk 1.0" @@ -319,9 +336,9 @@ --- -## salesforcer 0.1.2 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.2) +# salesforcer 0.1.2 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.2) -### Features +## Features * Add support for Bulk 1.0 operations of "create", "update", "upsert", "delete" and "hardDelete" @@ -335,9 +352,9 @@ --- -## salesforcer 0.1.1 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.1) +# salesforcer 0.1.1 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.1) -### Features +## Features * Add `sf_search()` with REST and SOAP API support for SOSL and free text search @@ -368,7 +385,7 @@ * Update the default file name for a cached token to `.httr-oauth-salesforcer` so that it does not clash with other package token names. -### Bug Fixes +## Bug Fixes * `sf_user_info()` returning `argument is of length zero` because token is not automatically refreshed before calling GET. @@ -379,9 +396,9 @@ automatically refreshed before calling GET. --- -## salesforcer 0.1.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.0) +# salesforcer 0.1.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v0.1.0) -### Features +## Features * OAuth 2.0 and Basic authentication methods (`sf_auth()`) diff --git a/R/analytics-dashboard.R b/R/analytics-dashboard.R index 59d82a0c..efa4e5c6 100644 --- a/R/analytics-dashboard.R +++ b/R/analytics-dashboard.R @@ -16,7 +16,7 @@ #' \item \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_dashboard_get_list.htm#topic-title}{Salesforce Example} #' } #' @export -sf_dashboards_list <- function(as_tbl=TRUE, verbose=FALSE){ +sf_list_dashboards <- function(as_tbl=TRUE, verbose=FALSE){ this_url <- make_dashboards_list_url() resultset <- sf_rest_list(url=this_url, as_tbl=as_tbl, verbose=verbose) return(resultset) @@ -40,7 +40,7 @@ sf_dashboards_list <- function(as_tbl=TRUE, verbose=FALSE){ #' \item \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_dashboard_example_get_dashboard_metadata.htm#analytics_api_dashboard_example_get_dashboard_metadata}{Salesforce Example} #' } #' @export -sf_dashboard_describe <- function(dashboard_id, as_tbl=TRUE, verbose=FALSE){ +sf_describe_dashboard <- function(dashboard_id, as_tbl=TRUE, verbose=FALSE){ this_url <- make_dashboard_describe_url(dashboard_id) resultset <- sf_rest_list(url=this_url, as_tbl=as_tbl, verbose=verbose) return(resultset) @@ -56,7 +56,7 @@ sf_dashboard_describe <- function(dashboard_id, as_tbl=TRUE, verbose=FALSE){ #' dashboard component. #' @return \code{list} #' @export -sf_dashboard_components_describe <- function(dashboard_id, +sf_describe_dashboard_components <- function(dashboard_id, component_ids=c(character(0))){ .NotYetImplemented() # # make_dashboard_url() @@ -79,9 +79,9 @@ sf_dashboard_components_describe <- function(dashboard_id, #' @template dashboard_filters #' @return \code{list} #' @export -sf_dashboard_status <- function(dashboard_id, - running_user = NULL, - dashboard_filters = c(character(0))){ +sf_get_dashboard_status <- function(dashboard_id, + running_user = NULL, + dashboard_filters = c(character(0))){ .NotYetImplemented() # # make_dashboard_status_url() # /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE/status @@ -91,47 +91,6 @@ sf_dashboard_status <- function(dashboard_id, # \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_dashboard_status_resource.htm#topic-title}{Example - Filtering results} } -#' List dashboard filter operators -#' -#' @description -#' `r lifecycle::badge("experimental")` -#' -#' @return \code{list} -#' @export -sf_dashboard_filter_operators_list <- function(){ - .NotYetImplemented() - # make_report_filter_operators_list_url - # /services/data/v34.0/analytics/filteroperators?forDashboards=true - # GET - # \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_filteroperators_reference_resource.htm}{Salesforce Documentation} - # \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_filteroperators_reference_list.htm}{Salesforce Example} -} - -#' Get an analysis of the filter options for a dashboard -#' -#' @description -#' `r lifecycle::badge("experimental")` -#' -#' @template dashboard_id -#' @param filter_columns \code{list}; a list of fields from the source report -#' which you check filter values against. Each object in the array has these -#' properties:... -#' @param options \code{list}; a list of objects describing a dashboard filter. -#' Each object has these properties:... -#' @return \code{list} -#' @export -sf_dashboard_filter_options_analysis <- function(dashboard_id, - filter_columns = list(), - options = list()){ - .NotYetImplemented() - # make_dashboard_filter_options_analysis_url - # /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE/filteroptionsanalysis - # GET - # https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_dashboard_filteroptionsanalysis.htm - - -} - #' Get the results of an existing dashboard #' #' @description @@ -146,9 +105,9 @@ sf_dashboard_filter_options_analysis <- function(dashboard_id, #' @template dashboard_filters #' @return \code{tbl_df} #' @export -sf_dashboard_results <- function(dashboard_id, - running_user = NULL, - dashboard_filters = c(character(0))){ +sf_get_dashboard_results <- function(dashboard_id, + running_user = NULL, + dashboard_filters = c(character(0))){ .NotYetImplemented() # # make_dashboard_url() # /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE @@ -173,6 +132,47 @@ sf_get_dashboard_data <- function(dashboard_id, .NotYetImplemented() } + +#' List dashboard filter operators +#' +#' @description +#' `r lifecycle::badge("experimental")` +#' +#' @return \code{list} +#' @export +sf_filter_dashboard_operators_list <- function(){ + .NotYetImplemented() + # make_report_filter_operators_list_url + # /services/data/v34.0/analytics/filteroperators?forDashboards=true + # GET + # \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_filteroperators_reference_resource.htm}{Salesforce Documentation} + # \href{https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_filteroperators_reference_list.htm}{Salesforce Example} +} + +#' Get an analysis of the filter options for a dashboard +#' +#' @description +#' `r lifecycle::badge("experimental")` +#' +#' @template dashboard_id +#' @param filter_columns \code{list}; a list of fields from the source report +#' which you check filter values against. Each object in the array has these +#' properties:... +#' @param options \code{list}; a list of objects describing a dashboard filter. +#' Each object has these properties:... +#' @return \code{list} +#' @export +sf_filter_dashboard_options_analysis <- function(dashboard_id, + filter_columns = list(), + options = list()){ + .NotYetImplemented() + # make_dashboard_filter_options_analysis_url + # /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE/filteroptionsanalysis + # GET + # https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/analytics_api_dashboard_filteroptionsanalysis.htm +} + + #' Refresh an existing dashboard #' #' @description @@ -182,7 +182,7 @@ sf_get_dashboard_data <- function(dashboard_id, #' @template dashboard_filters #' @return \code{list} #' @export -sf_dashboard_refresh <- function(dashboard_id, +sf_refresh_dashboard <- function(dashboard_id, dashboard_filters=c(character(0))){ .NotYetImplemented() # # make_dashboard_url() @@ -203,7 +203,7 @@ sf_dashboard_refresh <- function(dashboard_id, #' @template report_folder_id #' @return \code{list} #' @export -sf_dashboard_copy <- function(dashboard_id, report_folder_id){ +sf_copy_dashboard <- function(dashboard_id, report_folder_id){ .NotYetImplemented() # # make_dashboard_copy_url # /services/data/v34.0/analytics/dashboards/?cloneId=01ZD00000007S89MAE @@ -224,7 +224,7 @@ sf_dashboard_copy <- function(dashboard_id, report_folder_id){ #' @template body #' @return \code{list} #' @export -sf_dashboard_update <- function(dashboard_id, body){ +sf_update_dashboard <- function(dashboard_id, body){ .NotYetImplemented() # # make_dashboard_url # /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE @@ -257,7 +257,7 @@ sf_dashboard_update <- function(dashboard_id, body){ #' @template dashboard_filters #' @return \code{list} #' @export -sf_dashboard_set_sticky_filter <- function(dashboard_id, +sf_set_dashboard_sticky_filter <- function(dashboard_id, dashboard_filters = c(character(0))){ .NotYetImplemented() # # make_dashboard_url(sticky_filter_save = TRUE) @@ -282,7 +282,7 @@ sf_dashboard_set_sticky_filter <- function(dashboard_id, #' @template dashboard_id #' @return \code{logical} #' @export -sf_dashboard_delete <- function(dashboard_id){ +sf_delete_dashboard <- function(dashboard_id){ .NotYetImplemented() # # make_dashboard_url # /services/data/v34.0/analytics/dashboards/01ZD00000007S89MAE diff --git a/R/auth.R b/R/auth.R index 419abd04..c76e05c2 100644 --- a/R/auth.R +++ b/R/auth.R @@ -117,6 +117,18 @@ sf_auth <- function(username = NULL, if(!is.null(username) & !is.null(password) & !is.null(security_token)){ + deprecate_warn("1.0.1", + "salesforcer::sf_auth(security_token = )", + "sf_auth(token = )", + details = paste0("Beginning February 1st, 2022, Salesforce will be requiring customers ", + "to enable multi-factor authentication, which means ", + "that basic authentication using password and ", + "security token will no longer work. sf_auth() will return ", + "the error message: ", + "'INVALID_LOGIN: Invalid username, password, security token; or user locked out.'." + ) + ) + # basic authentication (username-password) --------------------------------- body <- xml_new_document() diff --git a/R/compatibility.R b/R/compatibility.R index 2e466e02..8ed2875b 100644 --- a/R/compatibility.R +++ b/R/compatibility.R @@ -37,7 +37,7 @@ #' @export rforcecom.login <- function(username, password, loginURL="https://login.salesforce.com/", apiVersion="35.0"){ - deprecate_soft("0.1.0", "salesforcer::rforcecom.login()", "sf_auth()") + deprecate_soft("0.1.0", "salesforcer::rforcecom.login()", "sf_auth()") if(!is.null(loginURL)){ options(salesforcer.login_url = loginURL) diff --git a/R/utils-datatypes.R b/R/utils-datatypes.R index da20bf29..e14a0671 100644 --- a/R/utils-datatypes.R +++ b/R/utils-datatypes.R @@ -42,7 +42,7 @@ sf_format_date <- function(x){ #' @keywords internal #' @rdname sf_format_time #' @export -sf_format_time <- function (x) { +sf_format_time <- function(x) { UseMethod("sf_format_time", x) } diff --git a/R/zzz.R b/R/zzz.R index 2535ccc2..19648fba 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -2,7 +2,7 @@ op <- options() op.salesforcer <- list( - salesforcer.api_version = "52.0", + salesforcer.api_version = "54.0", salesforcer.login_url = "https://login.salesforce.com", salesforcer.proxy_url = "", salesforcer.proxy_port = NULL, diff --git a/_pkgdown.yml b/_pkgdown.yml index 8b45dfc3..b99c9fc6 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -5,7 +5,8 @@ template: bootswatch: spacelab ganalytics: UA-98603021-2 docsearch: - api_key: c7d5ea1103660127418415a82a24fc3d + app_id: BBX5BTLUTL + api_key: f3a7c81cd6794f9050f32bfee2620882 index_name: salesforcer home: @@ -95,6 +96,22 @@ reference: - '`sf_describe_report_type`' - '`sf_list_report_fields`' - '`sf_list_report_filter_operators`' + - title: Dashboard Functions + desc: Functions to create, retrieve, update, delete and query dashboards and their data. + contents: + - '`sf_list_dashboards`' + - '`sf_describe_dashboard`' + - '`sf_describe_dashboard_components`' + - '`sf_get_dashboard_status`' + - '`sf_get_dashboard_results`' + - '`sf_get_dashboard_data`' + - '`sf_filter_dashboard_operators_list`' + - '`sf_filter_dashboard_options_analysis`' + - '`sf_refresh_dashboard`' + - '`sf_copy_dashboard`' + - '`sf_update_dashboard`' + - '`sf_set_dashboard_sticky_filter`' + - '`sf_delete_dashboard`' - title: Metadata Functions desc: Functions to create, retrieve, update, and delete metadata. contents: @@ -142,3 +159,4 @@ reference: - '`rforcecom.search`' - '`rforcecom.query`' - '`rforcecom.bulkQuery`' + - title: internal diff --git a/docs/404.html b/docs/404.html index cc97c43f..036f5dd2 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,90 +1,42 @@ - - - - + + + + - Page not found (404) • salesforcer - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - + + + - - - -
-
- +
+ + + + + - - -
+

Page not found (404)

@@ -186,34 +138,33 @@

Page not found (404)

+
-
-
-

Developed by Steven M. Mortimer.

+
+

+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

-
+
- - - - - - + - - diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 4e44ada9..37cb2268 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -1,90 +1,18 @@ - - - - - - - -Contributor Code of Conduct • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Contributor Code of Conduct • salesforcer - - - - - - - - + + -
-
-

Contributor Code of Conduct

@@ -188,40 +106,35 @@

Contributor Code of Conduct

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

-

This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

+

This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index 694ee1fc..164665d2 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -1,90 +1,18 @@ - - - - - - - -Contributing to {salesforcer} • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Contributing to {salesforcer} • salesforcer - - - - - - - - + + -
-
-

Contributing to {salesforcer}

@@ -184,42 +102,31 @@

Contributing to {salesforcer}

First off, thank you for considering giving back to the community and contributing to {salesforcer}. This outlines how to propose changes.

-
-

-Fixing typos

-

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment on the second line of the .Rd file.

-
-
-

-Implementing a feature or bugfix

-

If you want to make a bigger change, it is a good idea to first file an issue to alert others of your proposal and solicit input. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

-
-

-Pull request process

-
    -
  • Fork the package and clone onto your computer. If you haven’t done this before, we recommend using:
    • -
-
usethis::create_from_github("StevenMMortimer/salesforcer", fork = TRUE)
-
    -

  • Install all development dependences with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.

    • -

  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

    • -

  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

    • -

  • For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

    • -
-
-
-

-Code style

-
    -

  • New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.

    • -

  • We use roxygen2, with Markdown syntax, for documentation.

    • -

  • We use testthat for unit tests. Contributions with test cases included are easier to accept.

    • -
+
+

Fixing typos

+

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment on the second line of the .Rd file.

+
+

Implementing a feature or bugfix

+

If you want to make a bigger change, it is a good idea to first file an issue to alert others of your proposal and solicit input. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

+
+

Pull request process

+
  • Fork the package and clone onto your computer. If you haven’t done this before, we recommend using:
    • +
usethis::create_from_github("StevenMMortimer/salesforcer", fork = TRUE)
+

  • Install all development dependences with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.

    • +

  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

    • +

  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

    • +

  • For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

    • +
+
+

Code style

+

  • New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.

    • +

  • We use roxygen2, with Markdown syntax, for documentation.

    • +

  • We use testthat for unit tests. Contributions with test cases included are easier to accept.

    • +
-
-

-Code of Conduct

+
+

Code of Conduct

Please note that the {salesforcer} project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.

@@ -227,34 +134,29 @@

+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 8646a4f2..b0970062 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,90 +1,18 @@ - - - - - - - -License • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -License • salesforcer - - - - - - - - + + -
-
-

License

@@ -188,34 +106,29 @@

License

+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 1e2d1d68..23cac49b 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -1,90 +1,18 @@ - - - - - - - -NA • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NA • salesforcer - - - - - - - - + + -
-
-

NA

@@ -192,34 +110,29 @@

NA

+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/SECURITY.html b/docs/SECURITY.html index 0bb14a38..fc779537 100644 --- a/docs/SECURITY.html +++ b/docs/SECURITY.html @@ -1,90 +1,18 @@ - - - - - - - -NA • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -NA • salesforcer - - - - - - - - + + -
-
-

NA

-
-

-Security contact information

-

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

+
+

Security contact information

+

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/SUPPORT.html b/docs/SUPPORT.html index 3c50a8da..af8ae5d3 100644 --- a/docs/SUPPORT.html +++ b/docs/SUPPORT.html @@ -1,90 +1,18 @@ - - - - - - - -Getting help with {salesforcer} • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Getting help with {salesforcer} • salesforcer - - - - - - - - + + -
-
-

Getting help with {salesforcer}

@@ -184,45 +102,38 @@

Getting help with {salesforcer}

First off, thank you for choosing to use {salesforcer}. Before filing an issue in the GitHub repository, I would strongly recommend two things:

-
    -

  1. First, if you have a general question, consider searching and posting it on Stack Overflow (SO) using the tags “r” and “salesforce”. Here is a link to the existing questions on SO with those tags: https://stackoverflow.com/questions/tagged/salesforce+r. The more people that use the platform, the better the source of information becomes. Your question will be answered just as quickly there as filing an issue on Github, if not faster.

    2. +

    1. First, if you have a general question, consider searching and posting it on Stack Overflow (SO) using the tags “r” and “salesforce”. Here is a link to the existing questions on SO with those tags: https://stackoverflow.com/questions/tagged/salesforce+r. The more people that use the platform, the better the source of information becomes. Your question will be answered just as quickly there as filing an issue on Github, if not faster.

    2. Second, if you have discovered a bug or a wickedly difficult problem, then please try to create the issue with code or example code showing exactly what you are trying to execute. This means including the full SOQL, error messages, sceenshots, etc. Sometimes, the issue may only be able to be debugged by the person filing the issue because every Salesforce Org is unique. Please explain any customizations or hypotheses you may have that could even remotely be related to the issue.

      3. -
    -

    With those two things in mind, if you need to file an issue, please do so HERE.

    +

With those two things in mind, if you need to file an issue, please do so HERE.

Again, thank you for taking the time to contribute back to {salesforcer}. Your efforts will undoubtedly help other users as well!

+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html index cc533bed..6402b70a 100644 --- a/docs/articles/getting-started.html +++ b/docs/articles/getting-started.html @@ -34,6 +34,8 @@ + +
+

Getting Started

-

Steven M. Mortimer

+

Steven M. Mortimer

-

2020-08-16

+

2020-08-16

- Source: vignettes/getting-started.Rmd + Source: vignettes/getting-started.Rmd
-
-

-Authentication

-

First, load the {salesforcer} package and login. There are two ways to authenticate:

+
+

Authentication +

+

First, load the {salesforcer} package and log in. There are two ways to authenticate:

  1. OAuth 2.0
    2. -
  2. Basic Username-Password
    3. +
  3. Basic Username-Password
-

It is recommended to use OAuth 2.0 so that passwords do not have to be shared/embedded within scripts. User credentials will be stored in locally cached file entitled .httr-oauth-salesforcer in the current working directory.

-
-library(dplyr, warn.conflicts = FALSE)
-library(salesforcer)
+
NOTE: Beginning February 1st, 2022, Salesforce will be requiring customers to enable multi-factor authentication, which means that basic authentication using password and security token will no longer work. The function sf_auth() will return the error message:

+
INVALID_LOGIN: Invalid username, password, security token; or user locked out.

+
Also, it is a best practice to use OAuth 2.0 so that passwords do not have to be shared/embedded within scripts. User credentials will be stored in locally cached file entitled .httr-oauth-salesforcer in the current working directory.

+
+library(dplyr, warn.conflicts = FALSE)
+library(salesforcer)
 sf_auth()

 
Setting up your own Connected App for OAuth

 
Just a note, that it’s not necessary to setup your own Connected App in Salesforce to use OAuth 2.0 authentication. The only difference is that the authentication will be run through the client created and associated with the {salesforcer} package. By using the package client, you will NOT be giving access to Salesforce to anyone, the package is just the medium for you to connect to your own data. If you wanted more control you would specify those options like so:

-
-options(salesforcer.consumer_key = "012345678901-99thisisatest99connected33app22key")
-options(salesforcer.consumer_secret = "Th1s1sMyConsumerS3cr3t")
+
+options(salesforcer.consumer_key = "012345678901-99thisisatest99connected33app22key")
+options(salesforcer.consumer_secret = "Th1s1sMyConsumerS3cr3t")
 
 sf_auth()

 
Using a proxy connection

 
If you are required to connect to Salesforce via proxy you are able to specify all of those parameters as options, as well. For each call via httr these proxy settings will be passed along with the Salesforce authentication.

-
-options(salesforcer.proxy_url = "64.251.21.73") # IP or a named domain
-options(salesforcer.proxy_port = 8080)
-options(salesforcer.proxy_username = "user")
-options(salesforcer.proxy_password = "pass")
-options(salesforcer.proxy_auth = "ntlm")
+
+options(salesforcer.proxy_url = "64.251.21.73") # IP or a named domain
+options(salesforcer.proxy_port = 8080)
+options(salesforcer.proxy_username = "user")
+options(salesforcer.proxy_password = "pass")
+options(salesforcer.proxy_auth = "ntlm")
 
 sf_auth()

 
After logging in with sf_auth(), you can check your connectivity by looking at the information returned about the current user. It should be information about you!

-
+
 # pull down information of person logged in
 # it's a simple easy call to get started 
 # and confirm a connection to the APIs
 user_info <- sf_user_info()
-sprintf("Organization Id: %s", user_info$organizationId)
+sprintf("Organization Id: %s", user_info$organizationId)
 #> [1] "Organization Id: 00D6A0000003dN3UAI"
-sprintf("User Id: %s", user_info$userId)
+sprintf("User Id: %s", user_info$userId)
 #> [1] "User Id: 0056A000000MPRjQAO"

 

-

-

-Creating records

+

+
Creating records
+

 
Salesforce has objects and those objects contain records. One default object is the “Contact” object. This example shows how to create two records in the Contact object.

-
+
 n <- 2
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact-Create-", 1:n))
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact-Create-", 1:n))
 created_records <- sf_create(new_contacts, "Contact")
 created_records
-#> # A tibble: 2 x 2
+#> # A tibble: 2 × 2
 #>   id                 success
-#>   <chr>              <lgl>  
-#> 1 0033s000017uLwmAAE TRUE   
-#> 2 0033s000017uLwnAAE TRUE

+#>   <chr>              <lgl>  
+#> 1 0033s00001BXDqzAAH TRUE   
+#> 2 0033s00001BXDr0AAH TRUE

 

-

-

-Retrieving records

+

+
Retrieving records
+

 
Retrieve pulls down a specific set of records and fields. It’s very similar to running a query, but doesn’t use SOQL. Here is an example where we retrieve the data we just created.

-
+
 retrieved_records <- sf_retrieve(ids=created_records$id, 
-                                 fields=c("FirstName", "LastName"), 
+                                 fields=c("FirstName", "LastName"), 
                                  object_name="Contact")
 retrieved_records
-#> # A tibble: 2 x 4
+#> # A tibble: 2 × 4
 #>   sObject Id                 FirstName LastName        
-#>   <chr>   <chr>              <chr>     <chr>           
-#> 1 Contact 0033s000017uLwmAAE Test      Contact-Create-1
-#> 2 Contact 0033s000017uLwnAAE Test      Contact-Create-2

+#>   <chr>   <chr>              <chr>     <chr>           
+#> 1 Contact 0033s00001BXDqzAAH Test      Contact-Create-1
+#> 2 Contact 0033s00001BXDr0AAH Test      Contact-Create-2

 

-

-

-Querying records

+

+
Querying records
+

 
Salesforce has proprietary form of SQL called SOQL (Salesforce Object Query Language). SOQL is a powerful tool that allows you to return the fields of records in almost any object in Salesforce including Accounts, Contacts, Tasks, Opportunities, even Attachments! Below is an example where we grab the data we just created including Account object information for which the Contact record is associated with.

-
-my_soql <- sprintf("SELECT Id, 
+
+my_soql <- sprintf("SELECT Id, 
                            Account.Name, 
                            FirstName, 
                            LastName 
                     FROM Contact 
                     WHERE Id in ('%s')", 
-                   paste0(created_records$id , collapse="','"))
+                   paste0(created_records$id , collapse="','"))
 
 queried_records <- sf_query(my_soql)
 queried_records
-#> # A tibble: 2 x 3
+#> # A tibble: 2 × 3
 #>   Id                 FirstName LastName        
-#>   <chr>              <chr>     <chr>           
-#> 1 0033s000017uLwmAAE Test      Contact-Create-1
-#> 2 0033s000017uLwnAAE Test      Contact-Create-2

-
NOTE: In the example above, you’ll notice that the "Account.Name" column does not appear in the results. This is because the SOAP and REST APIs only return an empty Account object for the record if there is no relationship to an account ( see #78). There is no reliable way to extract and rebuild the empty columns based on the query string. If there were Account information, an additional column titled "Account.Name" would appear in the results. Note, that the Bulk 1.0 and Bulk 2.0 APIs will return "Account.Name" as a column of all NA values for this query because they return results differently.

+#>   <chr>              <chr>     <chr>           
+#> 1 0033s00001BXDqzAAH Test      Contact-Create-1
+#> 2 0033s00001BXDr0AAH Test      Contact-Create-2

+
NOTE: In the example above, you’ll notice that the "Account.Name" column does not appear in the results. This is because the SOAP and REST APIs only return an empty Account object for the record if there is no relationship to an account ( see #78). There is no reliable way to extract and rebuild the empty columns based on the query string. If there were Account information, an additional column titled "Account.Name" would appear in the results. Note, that the Bulk 1.0 and Bulk 2.0 APIs will return "Account.Name" as a column of all NA values for this query because they return results differently.

 

-

-

-Updating records

+

+
Updating records
+

 
After creating records you can update them using sf_update(). Updating a record requires you to pass the Salesforce Id of the record. Salesforce creates a unique 18-character identifier on each record and uses that to know which record to attach the update information you provide. Simply include a field or column in your update dataset called “Id” and the information will be matched. Here is an example where we update each of the records we created earlier with a new first name called “TestTest”.

-
+
 # Update some of those records
-queried_records <- queried_records %>%
-  mutate(FirstName = "TestTest")
+queried_records <- queried_records %>%
+  mutate(FirstName = "TestTest")
 
 updated_records <- sf_update(queried_records, object_name="Contact")
 updated_records
-#> # A tibble: 2 x 2
+#> # A tibble: 2 × 2
 #>   id                 success
-#>   <chr>              <lgl>  
-#> 1 0033s000017uLwmAAE TRUE   
-#> 2 0033s000017uLwnAAE TRUE

+#>   <chr>              <lgl>  
+#> 1 0033s00001BXDqzAAH TRUE   
+#> 2 0033s00001BXDr0AAH TRUE

 

-

-

-Deleting records

+

+
Deleting records
+

 
You can also delete records in Salesforce. The method implements a “soft” delete meaning that the deleted records go to the Recycle Bin which can be emptied or queried against later in the event that the record needed.

-
+
 deleted_records <- sf_delete(updated_records$id)
 deleted_records
-#> # A tibble: 2 x 2
+#> # A tibble: 2 × 2
 #>   id                 success
-#>   <chr>              <lgl>  
-#> 1 0033s000017uLwmAAE TRUE   
-#> 2 0033s000017uLwnAAE TRUE

+#>   <chr>              <lgl>  
+#> 1 0033s00001BXDqzAAH TRUE   
+#> 2 0033s00001BXDr0AAH TRUE

 

-

-

-Upserting records

-
Finally, Salesforce has a unique method called “upsert” that allows you to create and/or update records at the same time. More specifically, if the record is not found based an an “External Id” field, then Salesforce will create the record instead of updating one. Below is an example where we create 2 records, then upsert 3, where 2 are matched and updated and one is created. NOTE: You will need to create a custom field on the target object and ensure it is labeled as an “External Id” field. Read more at: https://blog.jeffdouglas.com/2010/05/07/using-exernal-id-fields-in-salesforce/.

-
+

+
Upserting records
+

+
Finally, Salesforce has a unique method called “upsert” that allows you to create and/or update records at the same time. More specifically, if the record is not found based an an “External Id” field, then Salesforce will create the record instead of updating one. Below is an example where we create 2 records, then upsert 3, where 2 are matched and updated and one is created. NOTE: You will need to create a custom field on the target object and ensure it is labeled as an “External Id” field. Read more at: https://blog.jeffdouglas.com/2010/05/07/using-exernal-id-fields-in-salesforce/.

+
 n <- 2
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact-Create-", 1:n), 
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact-Create-", 1:n), 
                        My_External_Id__c=letters[1:n])
 created_records <- sf_create(new_contacts, "Contact")
 
-upserted_contacts <- tibble(FirstName = rep("Test", n),
-                            LastName = paste0("Contact-Upsert-", 1:n), 
+upserted_contacts <- tibble(FirstName = rep("Test", n),
+                            LastName = paste0("Contact-Upsert-", 1:n), 
                             My_External_Id__c=letters[1:n])
-new_record <- tibble(FirstName = "Test",
-                     LastName = paste0("Contact-Upsert-", n+1), 
+new_record <- tibble(FirstName = "Test",
+                     LastName = paste0("Contact-Upsert-", n+1), 
                      My_External_Id__c=letters[n+1])
-upserted_contacts <- bind_rows(upserted_contacts, new_record)
+upserted_contacts <- bind_rows(upserted_contacts, new_record)
 
 upserted_records <- sf_upsert(input_data=upserted_contacts, 
                               object_name="Contact", 
                               external_id_fieldname="My_External_Id__c")
 upserted_records
-#> # A tibble: 3 x 3
+#> # A tibble: 3 × 3
 #>   id                 success created
-#>   <chr>              <lgl>   <lgl>  
-#> 1 0033s000017uM3VAAU TRUE    FALSE  
-#> 2 0033s000017uM3WAAU TRUE    FALSE  
-#> 3 0033s000017uM3aAAE TRUE    TRUE

+#>   <chr>              <lgl>   <lgl>  
+#> 1 0033s00001BXDr4AAH TRUE    FALSE  
+#> 2 0033s00001BXDr5AAH TRUE    FALSE  
+#> 3 0033s00001BXDr9AAH TRUE    TRUE

 

-

-

-Check out the Tests

-
The {salesforcer} package has quite a bit of unit test coverage to track any changes made between newly released versions of the Salesforce API (typically 4 each year). These tests are an excellent source of examples because they cover most all cases of utilizing the package functions. You can access them here: https://github.com/StevenMMortimer/salesforcer/tree/main/tests/testthat/

+

+
Check out the Tests
+

+
The {salesforcer} package has quite a bit of unit test coverage to track any changes made between newly released versions of the Salesforce API (typically 4 each year). These tests are an excellent source of examples because they cover most all cases of utilizing the package functions. You can access them here: https://github.com/StevenMMortimer/salesforcer/tree/main/tests/testthat/

 

   

 
@@ -313,11 +317,13 @@ 

 
 
       

-  
Developed by Steven M. Mortimer.

+  

+
Developed by Steven M. Mortimer.

 

 
 

-  
Site built with pkgdown 1.6.1.

+  

+
Site built with pkgdown 2.0.1.

 

 
       

@@ -326,9 +332,9 @@ 

   
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Articles • salesforcer
-
-
-
-
-
-
-
-  
+
+    
 
-  
     

-      

-      

   

     

       
Articles

@@ -185,48 +103,43 @@ 
Articles

       
All vignettes

       

 
-      

-        
Getting Started

-        

-        
Passing Control Args

-        

-        
Supported Queries

-        

-        
Transitioning from RForcecom

-        

-        
Working with Attachments

-        

-        
Working with Bulk APIs

-        

-        
Working with Metadata

-        

-        
Working with Reports

-        

-      

-    

+      
Getting Started

+        

+        
Passing Control Args

+        

+        
Supported Queries

+        

+        
Transitioning from RForcecom

+        

+        
Working with Attachments

+        

+        
Working with Bulk APIs

+        

+        
Working with Metadata

+        

+        
Working with Reports

+        

+      

   

 

 
 
-      

-      

-  
Developed by Steven M. Mortimer.

+      

+  
Developed by Steven M. Mortimer.

 

 
 

-  
Site built with pkgdown 1.6.1.

+  
Site built with pkgdown 2.0.1.

 

 
-      

-   

+      

 
   
-
-
-
-
-
-  
-
-
+
 
diff --git a/docs/articles/passing-control-args.html b/docs/articles/passing-control-args.html
index 5437dc4f..0f2124da 100644
--- a/docs/articles/passing-control-args.html
+++ b/docs/articles/passing-control-args.html
@@ -34,6 +34,8 @@
 
 
 
+    
+
     

       

+      

   

     

       
Passing Control Args

-                        
Steven M. Mortimer

+                        
Steven M. Mortimer

             
-            
2020-07-08

+            
2020-07-08

       
-      Source: vignettes/passing-control-args.Rmd
+      Source: vignettes/passing-control-args.Rmd
       
 
     

@@ -142,33 +144,32 @@ 
2020-07-08

     
     
 
If you’re inserting records from R you may want to turn off the assignment rules or even bypass duplicate rules and alerts to save records. Beginning in Version 0.1.3 of the {salesforcer} package many functions have a control argument that will allow you to fine tune the behavior of calls to the Salesforce APIs. This vignette will introduce the different options you can control and how to pass them into the {salesforcer} functions you’re already familiar with.

-

-

-The new control argument

+

+
The new control argument
+

 
This new feature can be seen in the sf_create (and many other functions) as control=list(...). The dots mean that you can pass any number of controls directly into the function.

 
First, authenticate and load any required packages for your analysis.

 
 
In the example below, we demonstrate how to create a record, but use the control arguments to prevent its creation from showing up in the Chatter feeds by setting the DisableFeedTrackingHeader.

 
-new_contact <- c(FirstName = "Jenny", 
+new_contact <- c(FirstName = "Jenny", 
                  LastName = "Williams", 
                  Email = "jennyw@gmail.com")
 record1 <- sf_create(new_contact,
                      object_name = "Contact",
-                     DisableFeedTrackingHeader = list(disableFeedTracking = TRUE))
+                     DisableFeedTrackingHeader = list(disableFeedTracking = TRUE))
 record1
-#> # A tibble: 1 x 2
+#> # A tibble: 1 × 2
 #>   success errors    
-#>   <lgl>   <list>    
-#> 1 FALSE   <list [1]>

+#>   <lgl>   <list>    
+#> 1 FALSE   <list [1]>

 
You will notice that the argument DisableFeedTrackingHeader can be included right into the function without any documentation existing for it in the sf_create function. This is because the dots (...) allow you to pass over a dozen different control parameters and that documentation would be tedious to create and maintain over multiple functions in the package. However, you will notice in the documentation entry for the control argument there is a link to a function called sf_control which you can use to directly to pass into control or simply to review its documentation of all the possible control parameters and their defaults. This is where you can review the various control options in more detail before trying to set them.

-
You may have also noticed that the argument DisableFeedTrackingHeader was formatted as a list with an element inside called disableFeedTracking set to TRUE. This may seem redundant but there are two reasons for this. First, this is exactly how the Salesforce APIs documents these options, which are typically referred to as “headers” because they are passed as a named header of the HTTP request and then the header fields and values are provided for that header. Second, some headers have multiple fields and values so a list is the only way to provide multiple named fields and values under a single header entity.

+
You may have also noticed that the argument DisableFeedTrackingHeader was formatted as a list with an element inside called disableFeedTracking set to TRUE. This may seem redundant but there are two reasons for this. First, this is exactly how the Salesforce APIs documents these options, which are typically referred to as “headers” because they are passed as a named header of the HTTP request and then the header fields and values are provided for that header. Second, some headers have multiple fields and values so a list is the only way to provide multiple named fields and values under a single header entity.

 

-

-

-An example using the DuplicateRuleHeader
+

+
An example using the DuplicateRuleHeader
 

 
The DuplicateRuleHeader that controls whether the duplicate rules are followed when inserting records from the API, has three fields:

 
    
@@ -181,27 +182,27 @@ 
    
 # override the duplicate rules ...
 record2 <- sf_create(new_contact,
                      object_name = "Contact",
-                     DuplicateRuleHeader = list(allowSave = TRUE, 
+                     DuplicateRuleHeader = list(allowSave = TRUE, 
                                                 includeRecordDetails = FALSE, 
                                                 runAsCurrentUser = TRUE))
 record2
-#> # A tibble: 1 x 2
+#> # A tibble: 1 × 2
 #>   id                 success
-#>   <chr>              <lgl>  
-#> 1 0033s000017uM3fAAE TRUE
+#>   <chr>              <lgl>  
+#> 1 0033s00001BXDrJAAX TRUE
 
 # ... or succumb to the duplicate rules
 record3 <- sf_create(new_contact,
                      object_name = "Contact",
-                     DuplicateRuleHeader = list(allowSave = FALSE, 
+                     DuplicateRuleHeader = list(allowSave = FALSE, 
                                                 includeRecordDetails = FALSE, 
                                                 runAsCurrentUser = TRUE))
 record3
-#> # A tibble: 1 x 2
+#> # A tibble: 1 × 2
 #>   success errors    
-#>   <lgl>   <list>    
-#> 1 FALSE   <list [1]>
-

Per the description above, note that setting allowSave=TRUE will not override rules where the “Action on Create” for a rule is set to “Block”. If the duplicate rule’s action is “Allow” with an alert, then setting allowSave=TRUE means the record will be created with no warning message. If allowSave=FALSE, then the record will be prevented from being created. For additional information on the DuplicateRuleHeader, please see the Salesforce documentation at: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_header_duplicateruleheader.htm

+#> <lgl> <list> +#> 1 FALSE <list [1]>
+

Per the description above, note that setting allowSave=TRUE will not override rules where the “Action on Create” for a rule is set to “Block”. If the duplicate rule’s action is “Allow” with an alert, then setting allowSave=TRUE means the record will be created with no warning message. If allowSave=FALSE, then the record will be prevented from being created. For additional information on the DuplicateRuleHeader, please see the Salesforce documentation at: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_header_duplicateruleheader.htm

Finally, you may notice during your use that only certain control arguments are permitted based on the API. For example, the DuplicateRuleHeader is not implemented in the REST API like it is in the SOAP API. In the example below you should take note of two things:

  1. When using the REST API and setting the DuplicateRuleHeader, then you will notice a warning that the header was ignored. You will receive warnings when trying to set any control parameters for an API or operation that does not recognize that particular control.

    2. @@ -210,68 +211,70 @@ 

     record4 <- sf_create(new_contact,
                      object_name = "Contact",
-                     DuplicateRuleHeader = list(allowSave = FALSE, 
+                     DuplicateRuleHeader = list(allowSave = FALSE, 
                                                 includeRecordDetails = FALSE, 
                                                 runAsCurrentUser = TRUE),
                      api_type = "REST")
 #> Warning: Ignoring the following controls which are not used in the REST API:
 #> DuplicateRuleHeader
+#> Warning: `type_convert()` only converts columns of type 'character'.
+#> - `df` has no columns of type 'character'
 record4
-#> # A tibble: 1 x 2
+#> # A tibble: 1 × 2
 #>   success errors    
-#>   <lgl>   <list>    
-#> 1 FALSE   <list [1]>
    +#> <lgl> <list> +#> 1 FALSE <list [1]>

-
-

-Creating the control argument with sf_control

+
+

Creating the control argument with sf_control +

If this type of control structure is new to you, take a look at the documentation for the glm and glm.control functions. The way these two functions behave is exactly how functions like sf_create and sf_control work with each other. As demonstrated above you can pass any number of arbitrary controls into the function and they are all gathered up into the control by control = list(...). However, you can specify the control directly like this:

 sf_query("SELECT Id, Name FROM Account LIMIT 1000",
          object_name = "Account",
-         control = sf_control(QueryOptions = list(batchSize = 200)))
-#> # A tibble: 15 x 2
+         control = sf_control(QueryOptions = list(batchSize = 200)))
+#> # A tibble: 15 × 2
 #>   Id                 Name                                
-#>   <chr>              <chr>                               
-#> 1 0013s00000zFgA6AAK KEEP Test Account With Child Records
-#> 2 0013s00000zFdugAAC KEEP Test Account With Child Records
-#> 3 0013s000014jF2vAAE Test Account For Performance Test   
-#> 4 0016A0000035mJEQAY GenePoint                           
-#> 5 0016A0000035mJCQAY United Oil & Gas, UK                
-#> # … with 10 more rows
+#> <chr> <chr> +#> 1 0013s00000zFgA6AAK KEEP Test Account With Child Records +#> 2 0013s00000zFdugAAC KEEP Test Account With Child Records +#> 3 0013s000014jF2vAAE Test Account For Performance Test +#> 4 0016A0000035mJEQAY GenePoint +#> 5 0016A0000035mJCQAY United Oil & Gas, UK +#> # … with 10 more rows
-
-

-Backwards compatibility for all_or_none and other named arguments

+
+

Backwards compatibility for all_or_none and other named arguments +

You may already be taking advantage of the all_or_none or line_ending arguments which are control arguments that were explicity included in functions. These argument essentially hard coded values to pass the AllOrNoneHeader and LineEndingHeader control parameters. Starting with the 0.1.3 release it is no longer necessary and preferable not to have an argument like all_or_none listed explicity as an argument since it can be provided in the control argument. Note: the all_or_none argument and other explicit control arguments will still be available in {salesforcer} 0.1.3 but will provide a deprecated warning. They will be removed in the next CRAN release of the package so it will be important to update your code now if you are explicitly passing these arguments and see a deprecation warning.

- -
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/extract_records_from_xml_node.html b/docs/reference/extract_records_from_xml_node.html index 77c5a007..2f6da447 100644 --- a/docs/reference/extract_records_from_xml_node.html +++ b/docs/reference/extract_records_from_xml_node.html @@ -1,92 +1,19 @@ - - - - - - - -Pulls out a tibble of record info from an XML node — extract_records_from_xml_node • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Pulls out a tibble of record info from an XML node — extract_records_from_xml_node • salesforcer - - - - - - - - + + -
-
-

Pulls out a tibble of record info from an XML node

- Source: R/utils-query.R + Source: R/utils-query.R
@@ -190,66 +107,57 @@

Pulls out a tibble of record info from an XML node

record and formats that node into a single row tbl_df.

- 
extract_records_from_xml_node(
-  node,
-  object_name_append = FALSE,
-  object_name_as_col = FALSE
-)
- -

Arguments

- - - - - - - - - - - - - - -
node

xml_node; the node to have records extracted into one row tbl_df.

object_name_append

logical; whether to include the object type -(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

object_name_as_col

logical; whether to include the object type -(e.g. Account or Contact) as a new column.

- -

Value

+
+ 
extract_records_from_xml_node(
+  node,
+  object_name_append = FALSE,
+  object_name_as_col = FALSE
+)
+
+
+

Arguments

+
node
+

xml_node; the node to have records extracted into one row tbl_df.

+
object_name_append
+

logical; whether to include the object type +(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

+
object_name_as_col
+

logical; whether to include the object type +(e.g. Account or Contact) as a new column.

+
+
+

Value

tbl_df parsed from the supplied node

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/extract_records_from_xml_nodeset.html b/docs/reference/extract_records_from_xml_nodeset.html index 07d9625e..ac1ccf68 100644 --- a/docs/reference/extract_records_from_xml_nodeset.html +++ b/docs/reference/extract_records_from_xml_nodeset.html @@ -1,92 +1,19 @@ - - - - - - - -Pulls out a tibble of record info from an XML node — extract_records_from_xml_nodeset • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Pulls out a tibble of record info from an XML node — extract_records_from_xml_nodeset • salesforcer - - - - - - - - + + -
-
-

Pulls out a tibble of record info from an XML node

- Source: R/utils-query.R + Source: R/utils-query.R
@@ -190,66 +107,57 @@

Pulls out a tibble of record info from an XML node

in the document to format into a single tidy tbl_df.

- 
extract_records_from_xml_nodeset(
-  nodeset,
-  object_name_append = FALSE,
-  object_name_as_col = FALSE
-)
- -

Arguments

- - - - - - - - - - - - - - -
nodeset

xml_nodeset; nodeset to have records extracted into a tbl_df

object_name_append

logical; whether to include the object type -(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

object_name_as_col

logical; whether to include the object type -(e.g. Account or Contact) as a new column.

- -

Value

+
+ 
extract_records_from_xml_nodeset(
+  nodeset,
+  object_name_append = FALSE,
+  object_name_as_col = FALSE
+)
+
+
+

Arguments

+
nodeset
+

xml_nodeset; nodeset to have records extracted into a tbl_df

+
object_name_append
+

logical; whether to include the object type +(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

+
object_name_as_col
+

logical; whether to include the object type +(e.g. Account or Contact) as a new column.

+
+
+

Value

tbl_df parsed from the supplied xml_nodeset

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/extract_records_from_xml_nodeset_of_records.html b/docs/reference/extract_records_from_xml_nodeset_of_records.html index 24f516ae..7f4dc4c3 100644 --- a/docs/reference/extract_records_from_xml_nodeset_of_records.html +++ b/docs/reference/extract_records_from_xml_nodeset_of_records.html @@ -1,92 +1,19 @@ - - - - - - - -Pulls out a tibble of record info from a nodeset of "records" elements — extract_records_from_xml_nodeset_of_records • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Pulls out a tibble of record info from a nodeset of "records" elements — extract_records_from_xml_nodeset_of_records • salesforcer - - - - - - - - + + -
-
-

Pulls out a tibble of record info from a nodeset of "records" elements

- Source: R/utils-query.R + Source: R/utils-query.R
@@ -190,75 +107,64 @@

Pulls out a tibble of record info from a nodeset of "records" elements

a single row of a tbl_df.

- 
extract_records_from_xml_nodeset_of_records(
-  x,
-  object_name = NULL,
-  object_name_append = FALSE,
-  object_name_as_col = FALSE
-)
+
+ 
extract_records_from_xml_nodeset_of_records(
+  x,
+  object_name = NULL,
+  object_name_append = FALSE,
+  object_name_as_col = FALSE
+)
+
-

Arguments

- - - - - - - - - - - - - - - - - - -
x

xml_nodeset; nodeset to have records extracted into a -tbl_df.

object_name

character; a list of character strings to prefix +

+

Arguments

+
x
+

xml_nodeset; nodeset to have records extracted into a +tbl_df.

+
object_name
+

character; a list of character strings to prefix each variable name in the event that we would like to tag the fields with the name of the object that they came from and/or store the object type as a -separate column in the resultset.

object_name_append

logical; whether to include the object type -(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

object_name_as_col

logical; whether to include the object type -(e.g. Account or Contact) as a new column.

- -

Value

- +separate column in the resultset.

+
object_name_append
+

logical; whether to include the object type +(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

+
object_name_as_col
+

logical; whether to include the object type +(e.g. Account or Contact) as a new column.

+
+
+

Value

tbl_df parsed from the supplied xml_nodeset

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/filter_valid_controls.html b/docs/reference/filter_valid_controls.html index dfbd7403..faffd705 100644 --- a/docs/reference/filter_valid_controls.html +++ b/docs/reference/filter_valid_controls.html @@ -1,91 +1,18 @@ - - - - - - - -Filter Out Control Arguments by API or Operation — filter_valid_controls • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Filter Out Control Arguments by API or Operation — filter_valid_controls • salesforcer - - - - - - - - + + -
-
-

Filter Out Control Arguments by API or Operation

- Source: R/utils-control.R + Source: R/utils-control.R
@@ -188,41 +105,58 @@

Filter Out Control Arguments by API or Operation

Filter Out Control Arguments by API or Operation

- 
filter_valid_controls(supplied, api_type = NULL, operation = NULL)
- - -

Note

+
+ 
filter_valid_controls(supplied, api_type = NULL, operation = NULL)
+
+
+

Arguments

+
supplied
+

list; a list of input data regarding the control arguments +along with the with API and operation information to make a complete assessment +of which control arguments are applicable.

+
api_type
+

character; one of "REST", "SOAP", +"Bulk 1.0", or "Bulk 2.0" indicating which API to use when +making the request.

+
operation
+

character; a string defining the type of operation being +performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", +"query", "queryall").

+
+
+

Value

+

character; a vector of strings returning only the control arguments +that are accepted by the specified API and operation.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/flatten_tbl_df.html b/docs/reference/flatten_tbl_df.html index f848cd18..680b003c 100644 --- a/docs/reference/flatten_tbl_df.html +++ b/docs/reference/flatten_tbl_df.html @@ -1,93 +1,20 @@ - - - - - - - -Flatten list and convert to tibble — flatten_tbl_df • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Flatten list and convert to tibble — flatten_tbl_df • salesforcer - - - - - - - - - - - - - - - - - - + + -
-
-

Flatten list and convert to tibble

- Source: R/utils-query.R + Source: R/utils-query.R
@@ -192,52 +109,47 @@

Flatten list and convert to tibble

each record represents a row in the data frame.

- 
flatten_tbl_df(x)
- -

Arguments

- - - - - - -
x

list; a list to be extracted into a tbl_df.

- -

Value

+
+ 
flatten_tbl_df(x)
+
+
+

Arguments

+
x
+

list; a list to be extracted into a tbl_df.

+
+
+

Value

tbl_df parsed from the flattened list.

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/format_headers_for_verbose.html b/docs/reference/format_headers_for_verbose.html index 1c0722da..4ce72d9b 100644 --- a/docs/reference/format_headers_for_verbose.html +++ b/docs/reference/format_headers_for_verbose.html @@ -1,91 +1,18 @@ - - - - - - - -Format Headers for Printing — format_headers_for_verbose • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Format Headers for Printing — format_headers_for_verbose • salesforcer - - - - - - - - + + -
-
-

Format Headers for Printing

- Source: R/utils.R + Source: R/utils.R
@@ -188,41 +105,49 @@

Format Headers for Printing

Format Headers for Printing

- 
format_headers_for_verbose(request_headers)
- - -

Note

+
+ 
format_headers_for_verbose(request_headers)
+
+
+

Arguments

+
request_headers
+

list; a list of values from the API request or +response that represent the headers of the call

+
+
+

Value

+

character; a string constructed from the input that is easier +to read when we print it out

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/format_report_row.html b/docs/reference/format_report_row.html index e5013fad..f0e2ec58 100644 --- a/docs/reference/format_report_row.html +++ b/docs/reference/format_report_row.html @@ -1,93 +1,20 @@ - - - - - - - -Format a single "rows" element from a report fact map — format_report_row • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Format a single "rows" element from a report fact map — format_report_row • salesforcer - - - - - - - - - - - - - - - - - - + + -
-
-

Format a single "rows" element from a report fact map

- Source: R/utils-report.R + Source: R/utils-report.R
@@ -192,88 +109,77 @@

Format a single "rows" element from a report fact map

row tbl_df that will usually be bound to the other rows in the report

- 
format_report_row(
-  x,
-  labels = TRUE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated()
-)
+
+ 
format_report_row(
+  x,
+  labels = TRUE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated()
+)
+
-

Arguments

- - - - - - - - - - - - - - - - - - -
x

list; a single element from the rows element of a fact +

+

Arguments

+
x
+

list; a single element from the rows element of a fact map. When the data is in a tabular format, this element usually has the same length as the number of columns with each element having a label and value -element.

labels

logical; an indicator of whether the returned data should +element.

+
labels
+

logical; an indicator of whether the returned data should be the label (i.e. formatted value) or the actual value. By default, the labels are returned because these are what appear in the Salesforce dashboard and more closely align with the column names. For example, "Account.Name" label may be "Account B" and the value 0016A0000035mJEQAY. The former -(label) more accurately reflects the "Account.Name".

guess_types

logical; indicating whether or not to use col_guess() +(label) more accurately reflects the "Account.Name".

+
guess_types
+

logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

bind_using_character_cols

logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

+
bind_using_character_cols
+

logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

- -

Value

- +character.

+
+
+

Value

tbl_df; a single row data frame with the data for the row that the supplied list represented in the report's fact map.

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+ -
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/get_os.html b/docs/reference/get_os.html index 81254f2e..0a969be5 100644 --- a/docs/reference/get_os.html +++ b/docs/reference/get_os.html @@ -1,92 +1,19 @@ - - - - - - - -Determine the host operating system — get_os • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Determine the host operating system — get_os • salesforcer - - - - - - - - + + -
-
-

Determine the host operating system

- Source: R/utils.R + Source: R/utils.R
@@ -190,52 +107,53 @@

Determine the host operating system

is Windows, Mac, or Linux

- 
get_os()
- - -

Value

- -

A character string

-

Note

+
+ 
get_os()
+
+
+

Value

+

character; a string indicating the current operating system.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

-

See also

- -

https://conjugateprior.org/2015/06/identifying-the-os-from-r/

+
+ -

Examples

- 
if (FALSE) {
-get_os()
-}
-
+
+

Examples

+ 
if (FALSE) {
+get_os()
+}
+
+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/guess_object_name_from_soql.html b/docs/reference/guess_object_name_from_soql.html index 1ccd70aa..b9919575 100644 --- a/docs/reference/guess_object_name_from_soql.html +++ b/docs/reference/guess_object_name_from_soql.html @@ -1,91 +1,18 @@ - - - - - - - -Try to Guess the Object if User Does Not Specify for Bulk Queries — guess_object_name_from_soql • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Try to Guess the Object if User Does Not Specify for Bulk Queries — guess_object_name_from_soql • salesforcer - - - - - - - - + + -
-
-

Try to Guess the Object if User Does Not Specify for Bulk Queries

- Source: R/utils.R + Source: R/utils.R
@@ -188,41 +105,49 @@

Try to Guess the Object if User Does Not Specify for Bulk Queries

Try to Guess the Object if User Does Not Specify for Bulk Queries

- 
guess_object_name_from_soql(soql)
- - -

Note

+
+ 
guess_object_name_from_soql(soql)
+
+
+

Arguments

+
soql
+

character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

+
+
+

Value

+

character; a string parsed from the input that represents the +object name that the query appears to target.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/index.html b/docs/reference/index.html index 1e017d4b..22e09460 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,90 +1,18 @@ - - - - - - - -Function reference • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Function reference • salesforcer - - - - - - - - + + -
-
-

Reference

- - - - - - - - - - -
-

Authentication

-

Function to authenticate to your Salesforce Org.

+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - - + - - -
+

Authentication

+

Function to authenticate to your Salesforce Org.

+

sf_auth()

Log in to Salesforce

-

Query/Search Functions

-

Functions to query and search records.

+
+

Query/Search Functions

+

Functions to query and search records.

+

sf_query()

Perform SOQL Query

+

sf_search()

Perform SOSL Search

-

CRUD Functions

-

Functions to perform create, retrieve, update, and delete (CRUD) operations on records.

+
+

CRUD Functions

+

Functions to perform create, retrieve, update, and delete (CRUD) operations on records.

+

sf_create()

Create Records

+

sf_retrieve()

Retrieve Records By Id

+

sf_update()

Update Records

+

sf_upsert()

Upsert Records

+

sf_delete()

Delete Records

+

sf_undelete()

Undelete Records

+

sf_get_deleted()

Get Deleted Records from a Timeframe

+

sf_get_updated()

Get Updated Records from a Timeframe

-

Attachment Functions

-

Convenience functions to work with attachments.

+
+

Attachment Functions

+

Convenience functions to work with attachments.

+

sf_create_attachment()

Create Attachments

+

sf_download_attachment()

Download an Attachment

+

sf_update_attachment()

Update Attachments

+

sf_delete_attachment()

Delete Attachments

-

Bulk API Functions

-

Convenience functions to perform async CRUD and query operations.

+
+

Bulk API Functions

+

Convenience functions to perform async CRUD and query operations.

+

sf_run_bulk_query() sf_query_bulk()

Run bulk query

+

sf_run_bulk_operation() sf_bulk_operation()

Run Bulk Operation

-

Report Functions

-

Functions to create, retrieve, update, delete and query reports and their data.

+
+

Report Functions

+

Functions to create, retrieve, update, delete and query reports and their data.

+

sf_run_report()

Get a report's data in tabular format

+

sf_list_reports()

List reports

+

sf_describe_report()

Describe a report

+

sf_create_report()

Create a report

+

sf_copy_report()

Copy a report

+

sf_update_report()

Update a report

+

sf_execute_report()

Execute a report

+

sf_delete_report()

Delete a report

+

sf_list_report_instances()

List report instances

+

sf_get_report_instance_results()

Get report instance results

+

sf_delete_report_instance()

Delete a report instance

+

sf_list_report_types()

List report types

+

sf_describe_report_type()

Describe a report type

+

sf_list_report_fields()

Get a list of report fields

+

sf_list_report_filter_operators()

List report filter operators

-

Metadata Functions

-

Functions to create, retrieve, update, and delete metadata.

+
+

Dashboard Functions

+

Functions to create, retrieve, update, delete and query dashboards and their data.

+
+

sf_get_dashboard_data()

+

Get dashboard data in a tabular format

+

Metadata Functions

+

Functions to create, retrieve, update, and delete metadata.

+

sf_create_metadata()

Create Object or Field Metadata in Salesforce

+

sf_update_metadata()

Update Object or Field Metadata in Salesforce

+

sf_upsert_metadata()

Upsert Object or Field Metadata in Salesforce

+

sf_delete_metadata()

Delete Object or Field Metadata in Salesforce

+

sf_rename_metadata()

Rename Metadata Elements in Salesforce

+

sf_read_metadata()

Read Object or Field Metadata from Salesforce

+

sf_list_metadata()

List All Objects of a Certain Metadata Type in Salesforce

+

sf_retrieve_metadata()

Make A Request to Retrieve the Metadata

+

sf_describe_metadata()

Describe the Metadata in an Organization

+

sf_describe_objects()

SObject Basic Information

+

sf_describe_object_fields()

Describe Object Fields

-

Salesforce Org Utility Functions

-

Functions to perform basic org-wide routines.

+
+

Salesforce Org Utility Functions

+

Functions to perform basic org-wide routines.

+

sf_merge()

Merge Records

+

sf_convert_lead()

Convert Leads

+

sf_find_duplicates()

Find Duplicate Records

+

sf_find_duplicates_by_id()

Find Duplicate Records By Id

+

sf_empty_recycle_bin()

Empty Recycle Bin

+

sf_get_all_jobs_bulk()

Get All Bulk API Jobs

+

sf_get_all_query_jobs_bulk()

Get All Bulk API Query Jobs

+

sf_list_rest_api_versions()

List REST API Versions

+

sf_list_resources()

List the Resources for an API

+

sf_list_api_limits()

List the Limits for an API

+

sf_list_objects()

List Organization Objects and their Metadata

+

sf_user_info()

Return Current User Info

+

sf_server_timestamp()

Salesforce Server Timestamp

+

sf_set_password()

Set User Password

+

sf_reset_password()

Reset User Password

+

sf_control()

Auxiliary for Controlling Calls to Salesforce APIs

-

Backward Compatibility with RForcecom

-

Functions that mimic {RForcecom} to ease code transitions between {salesforcer} and {RForcecom}.

+
+

Backward Compatibility with RForcecom

+

Functions that mimic {RForcecom} to ease code transitions between {salesforcer} and {RForcecom}.

+

rforcecom.login()

The salesforcer backwards compatible version of -RForcecom::rforcecom.login

+RForcecom::rforcecom.login

rforcecom.getServerTimestamp()

The salesforcer backwards compatible version of -RForcecom::rforcecom.getServerTimestamp

+RForcecom::rforcecom.getServerTimestamp

rforcecom.getObjectDescription()

The salesforcer backwards compatible version of -RForcecom::rforcecom.getObjectDescription

+RForcecom::rforcecom.getObjectDescription

rforcecom.create()

The salesforcer backwards compatible version of -RForcecom::rforcecom.create

+RForcecom::rforcecom.create

rforcecom.retrieve()

The salesforcer backwards compatible version of -RForcecom::rforcecom.retrieve

+RForcecom::rforcecom.retrieve

rforcecom.update()

The salesforcer backwards compatible version of -RForcecom::rforcecom.update

+RForcecom::rforcecom.update

rforcecom.delete()

The salesforcer backwards compatible version of -RForcecom::rforcecom.delete

+RForcecom::rforcecom.delete

rforcecom.upsert()

The salesforcer backwards compatible version of -RForcecom::rforcecom.upsert

+RForcecom::rforcecom.upsert

rforcecom.search()

The salesforcer backwards compatible version of -RForcecom::rforcecom.search

+RForcecom::rforcecom.search

rforcecom.query()

The salesforcer backwards compatible version of -RForcecom::rforcecom.query

+RForcecom::rforcecom.query

rforcecom.bulkQuery()

The salesforcer backwards compatible version of -RForcecom::rforcecom.bulkQuery

- +RForcecom::rforcecom.bulkQuery

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/is_legit_token.html b/docs/reference/is_legit_token.html index 4f8fdceb..305014c3 100644 --- a/docs/reference/is_legit_token.html +++ b/docs/reference/is_legit_token.html @@ -1,91 +1,18 @@ - - - - - - - -Check that token appears to be legitimate — is_legit_token • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Check that token appears to be legitimate — is_legit_token • salesforcer - - - - - - - - + + -
-
-

Check that token appears to be legitimate

- Source: R/auth.R + Source: R/auth.R
@@ -188,38 +105,49 @@

Check that token appears to be legitimate

Check that token appears to be legitimate

- 
is_legit_token(x, verbose = FALSE)
- +
+ 
is_legit_token(x, verbose = FALSE)
+
+
+

Arguments

+
x
+

an object that is supposed to be an object of class Token2.0 +(an S3 class provided by httr). If so, the result will return TRUE.

+
verbose
+

logical; an indicator of whether to print additional +detail for each API call, which is useful for debugging. More specifically, when +set to TRUE the URL, header, and body will be printed for each request, +along with additional diagnostic information where available.

+
+
+

Value

+

logical

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/list_extract_parent_and_child_result.html b/docs/reference/list_extract_parent_and_child_result.html index 852c4fbd..de003f37 100644 --- a/docs/reference/list_extract_parent_and_child_result.html +++ b/docs/reference/list_extract_parent_and_child_result.html @@ -1,95 +1,22 @@ - - - - - - - -Extract tibble of a parent-child record from one JSON element — list_extract_parent_and_child_result • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Extract tibble of a parent-child record from one JSON element — list_extract_parent_and_child_result • salesforcer - - - - - - - - - - - - - - - - - - + + -
-
-

Extract tibble of a parent-child record from one JSON element

- Source: R/utils-query.R + Source: R/utils-query.R
@@ -196,55 +113,50 @@

Extract tibble of a parent-child record from one JSON element

that parent record.

- 
list_extract_parent_and_child_result(x)
- -

Arguments

- - - - - - -
x

list; list of records parsed from JSON representing one -individual parent query record.

- -

Value

+
+ 
list_extract_parent_and_child_result(x)
+
+
+

Arguments

+
x
+

list; list of records parsed from JSON representing one +individual parent query record.

+
+
+

Value

tbl_df; a data frame with each row representing a parent-child record (i.e. at least one row per parent or more if cross joined with more than one child record).

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_folder_child_operations_url.html b/docs/reference/make_analytics_folder_child_operations_url.html index 56bc2ad6..65b8a84a 100644 --- a/docs/reference/make_analytics_folder_child_operations_url.html +++ b/docs/reference/make_analytics_folder_child_operations_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Folder child operations URL generator — make_analytics_folder_child_operations_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Folder child operations URL generator — make_analytics_folder_child_operations_url • salesforcer - - - - - - - - + + -
-
-

Analytics Folder child operations URL generator

- Source: R/endpoints-analytics-report-folder.R + Source: R/endpoints-analytics-report-folder.R
@@ -188,41 +105,50 @@

Analytics Folder child operations URL generator

Analytics Folder child operations URL generator

- 
make_analytics_folder_child_operations_url(report_folder_id)
- - -

Note

+
+ 
make_analytics_folder_child_operations_url(report_folder_id)
+
+
+

Arguments

+
report_folder_id
+

character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics folder calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_folder_collections_url.html b/docs/reference/make_analytics_folder_collections_url.html index 6dd8b1ad..870f878b 100644 --- a/docs/reference/make_analytics_folder_collections_url.html +++ b/docs/reference/make_analytics_folder_collections_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Folder collections URL generator — make_analytics_folder_collections_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Folder collections URL generator — make_analytics_folder_collections_url • salesforcer - - - - - - - - + + -
-
-

Analytics Folder collections URL generator

- Source: R/endpoints-analytics-report-folder.R + Source: R/endpoints-analytics-report-folder.R
@@ -188,41 +105,44 @@

Analytics Folder collections URL generator

Analytics Folder collections URL generator

- 
make_analytics_folder_collections_url()
- - -

Note

+
+ 
make_analytics_folder_collections_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics folder calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_folder_operations_url.html b/docs/reference/make_analytics_folder_operations_url.html index fb4ea5b2..ae0012ba 100644 --- a/docs/reference/make_analytics_folder_operations_url.html +++ b/docs/reference/make_analytics_folder_operations_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Folder operations URL generator — make_analytics_folder_operations_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Folder operations URL generator — make_analytics_folder_operations_url • salesforcer - - - - - - - - + + -
-
-

Analytics Folder operations URL generator

- Source: R/endpoints-analytics-report-folder.R + Source: R/endpoints-analytics-report-folder.R
@@ -188,41 +105,50 @@

Analytics Folder operations URL generator

Analytics Folder operations URL generator

- 
make_analytics_folder_operations_url(report_folder_id)
- - -

Note

+
+ 
make_analytics_folder_operations_url(report_folder_id)
+
+
+

Arguments

+
report_folder_id
+

character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics folder calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_folder_share_by_id_url.html b/docs/reference/make_analytics_folder_share_by_id_url.html index 8b84b14d..7611eaaf 100644 --- a/docs/reference/make_analytics_folder_share_by_id_url.html +++ b/docs/reference/make_analytics_folder_share_by_id_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Folder share by Id URL generator — make_analytics_folder_share_by_id_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Folder share by Id URL generator — make_analytics_folder_share_by_id_url • salesforcer - - - - - - - - + + -
-
-

Analytics Folder share by Id URL generator

- Source: R/endpoints-analytics-report-folder.R + Source: R/endpoints-analytics-report-folder.R
@@ -188,41 +105,53 @@

Analytics Folder share by Id URL generator

Analytics Folder share by Id URL generator

- 
make_analytics_folder_share_by_id_url(report_folder_id, share_id)
- - -

Note

+
+ 
make_analytics_folder_share_by_id_url(report_folder_id, share_id)
+
+
+

Arguments

+
report_folder_id
+

character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

+
share_id
+

character; the Salesforce Id assigned to a created +analytics folder share (it will start with "004").

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics folder calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_folder_share_recipients_url.html b/docs/reference/make_analytics_folder_share_recipients_url.html index fe1bcc36..771dc3ff 100644 --- a/docs/reference/make_analytics_folder_share_recipients_url.html +++ b/docs/reference/make_analytics_folder_share_recipients_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Folder share recipients URL generator — make_analytics_folder_share_recipients_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Folder share recipients URL generator — make_analytics_folder_share_recipients_url • salesforcer - - - - - - - - + + -
-
-

Analytics Folder share recipients URL generator

- Source: R/endpoints-analytics-report-folder.R + Source: R/endpoints-analytics-report-folder.R
@@ -188,41 +105,56 @@

Analytics Folder share recipients URL generator

Analytics Folder share recipients URL generator

- 
make_analytics_folder_share_recipients_url(report_folder_id, share_type)
- - -

Note

+
+ 
make_analytics_folder_share_recipients_url(
+  report_folder_id,
+  share_type = "User"
+)
+
+
+

Arguments

+
report_folder_id
+

character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

+
share_type
+

character; the type of data for the recipients, +such as user, group, or role. The default is "User".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics folder calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_folder_shares_url.html b/docs/reference/make_analytics_folder_shares_url.html index 524fd118..e1ab17ce 100644 --- a/docs/reference/make_analytics_folder_shares_url.html +++ b/docs/reference/make_analytics_folder_shares_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Folder shares URL generator — make_analytics_folder_shares_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Folder shares URL generator — make_analytics_folder_shares_url • salesforcer - - - - - - - - + + -
-
-

Analytics Folder shares URL generator

- Source: R/endpoints-analytics-report-folder.R + Source: R/endpoints-analytics-report-folder.R
@@ -188,41 +105,50 @@

Analytics Folder shares URL generator

Analytics Folder shares URL generator

- 
make_analytics_folder_shares_url(report_folder_id)
- - -

Note

+
+ 
make_analytics_folder_shares_url(report_folder_id)
+
+
+

Arguments

+
report_folder_id
+

character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics folder calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_notification_operations_url.html b/docs/reference/make_analytics_notification_operations_url.html index 80f49939..3e2b9cef 100644 --- a/docs/reference/make_analytics_notification_operations_url.html +++ b/docs/reference/make_analytics_notification_operations_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Notification operations URL generator — make_analytics_notification_operations_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Notification operations URL generator — make_analytics_notification_operations_url • salesforcer - - - - - - - - + + -
-
-

Analytics Notification operations URL generator

- Source: R/endpoints-analytics-notification.R + Source: R/endpoints-analytics-notification.R
@@ -188,41 +105,44 @@

Analytics Notification operations URL generator

Analytics Notification operations URL generator

- 
make_analytics_notification_operations_url(notification_id)
- - -

Note

+
+ 
make_analytics_notification_operations_url(notification_id)
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics notification calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_notifications_limits_url.html b/docs/reference/make_analytics_notifications_limits_url.html index ca179660..9cf20ba9 100644 --- a/docs/reference/make_analytics_notifications_limits_url.html +++ b/docs/reference/make_analytics_notifications_limits_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Notification limits URL generator — make_analytics_notifications_limits_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Notification limits URL generator — make_analytics_notifications_limits_url • salesforcer - - - - - - - - + + -
-
-

Analytics Notification limits URL generator

- Source: R/endpoints-analytics-notification.R + Source: R/endpoints-analytics-notification.R
@@ -188,41 +105,44 @@

Analytics Notification limits URL generator

Analytics Notification limits URL generator

- 
make_analytics_notifications_limits_url()
- - -

Note

+
+ 
make_analytics_notifications_limits_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics notification calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_analytics_notifications_list_url.html b/docs/reference/make_analytics_notifications_list_url.html index 0c2e8280..a78a7a57 100644 --- a/docs/reference/make_analytics_notifications_list_url.html +++ b/docs/reference/make_analytics_notifications_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Analytics Notification list URL generator — make_analytics_notifications_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Analytics Notification list URL generator — make_analytics_notifications_list_url • salesforcer - - - - - - - - + + -
-
-

Analytics Notification list URL generator

- Source: R/endpoints-analytics-notification.R + Source: R/endpoints-analytics-notification.R
@@ -188,41 +105,44 @@

Analytics Notification list URL generator

Analytics Notification list URL generator

- 
make_analytics_notifications_list_url()
- - -

Note

+
+ 
make_analytics_notifications_list_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Analytics notification calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_base_metadata_url.html b/docs/reference/make_base_metadata_url.html index 2826eff0..7c2daeee 100644 --- a/docs/reference/make_base_metadata_url.html +++ b/docs/reference/make_base_metadata_url.html @@ -1,91 +1,18 @@ - - - - - - - -Base Metadata API URL Generator — make_base_metadata_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Base Metadata API URL Generator — make_base_metadata_url • salesforcer - - - - - - - - + + -
-
-

Base Metadata API URL Generator

- Source: R/endpoints-soap.R + Source: R/endpoints-soap.R
@@ -188,41 +105,44 @@

Base Metadata API URL Generator

Base Metadata API URL Generator

- 
make_base_metadata_url()
- - -

Note

+
+ 
make_base_metadata_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Metadata API calls to. This URL is specific to your instance and the API +version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_base_rest_url.html b/docs/reference/make_base_rest_url.html index 42af3e3d..76269c62 100644 --- a/docs/reference/make_base_rest_url.html +++ b/docs/reference/make_base_rest_url.html @@ -1,91 +1,18 @@ - - - - - - - -Base REST API URL Generator — make_base_rest_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Base REST API URL Generator — make_base_rest_url • salesforcer - - - - - - - - + + -
-
-

Base REST API URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,44 @@

Base REST API URL Generator

Base REST API URL Generator

- 
make_base_rest_url()
- - -

Note

+
+ 
make_base_rest_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send REST API calls to. This URL is specific to your instance and the API +version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_base_soap_url.html b/docs/reference/make_base_soap_url.html index a8fb5c5a..084884fb 100644 --- a/docs/reference/make_base_soap_url.html +++ b/docs/reference/make_base_soap_url.html @@ -1,91 +1,18 @@ - - - - - - - -Base SOAP API URL Generator — make_base_soap_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Base SOAP API URL Generator — make_base_soap_url • salesforcer - - - - - - - - + + -
-
-

Base SOAP API URL Generator

- Source: R/endpoints-soap.R + Source: R/endpoints-soap.R
@@ -188,41 +105,44 @@

Base SOAP API URL Generator

Base SOAP API URL Generator

- 
make_base_soap_url()
- - -

Note

+
+ 
make_base_soap_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send SOAP API calls to. This URL is specific to your instance and the API +version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_batch_details_url.html b/docs/reference/make_bulk_batch_details_url.html index 510e0077..3e3ab9b3 100644 --- a/docs/reference/make_bulk_batch_details_url.html +++ b/docs/reference/make_bulk_batch_details_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Batch Details URL Generator — make_bulk_batch_details_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Batch Details URL Generator — make_bulk_batch_details_url • salesforcer - - - - - - - - + + -
-
-

Bulk Batch Details URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,41 +105,56 @@

Bulk Batch Details URL Generator

Bulk Batch Details URL Generator

- 
make_bulk_batch_details_url(job_id, batch_id, api_type = c("Bulk 1.0"))
- - -

Note

+
+ 
make_bulk_batch_details_url(job_id, batch_id, api_type = c("Bulk 1.0"))
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
batch_id
+

character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_batch_status_url.html b/docs/reference/make_bulk_batch_status_url.html index b44686a6..453d2d2b 100644 --- a/docs/reference/make_bulk_batch_status_url.html +++ b/docs/reference/make_bulk_batch_status_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Batch Status URL Generator — make_bulk_batch_status_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Batch Status URL Generator — make_bulk_batch_status_url • salesforcer - - - - - - - - + + -
-
-

Bulk Batch Status URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,41 +105,56 @@

Bulk Batch Status URL Generator

Bulk Batch Status URL Generator

- 
make_bulk_batch_status_url(job_id, batch_id, api_type = c("Bulk 1.0"))
- - -

Note

+
+ 
make_bulk_batch_status_url(job_id, batch_id, api_type = c("Bulk 1.0"))
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
batch_id
+

character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_batches_url.html b/docs/reference/make_bulk_batches_url.html index aeb5ff23..9e88f8b2 100644 --- a/docs/reference/make_bulk_batches_url.html +++ b/docs/reference/make_bulk_batches_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Batches URL Generator — make_bulk_batches_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Batches URL Generator — make_bulk_batches_url • salesforcer - - - - - - - - + + -
-
-

Bulk Batches URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,41 +105,53 @@

Bulk Batches URL Generator

Bulk Batches URL Generator

- 
make_bulk_batches_url(job_id, api_type = c("Bulk 1.0", "Bulk 2.0"))
- - -

Note

+
+ 
make_bulk_batches_url(job_id, api_type = c("Bulk 1.0", "Bulk 2.0"))
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_create_job_url.html b/docs/reference/make_bulk_create_job_url.html index 27799a12..eceaa5b0 100644 --- a/docs/reference/make_bulk_create_job_url.html +++ b/docs/reference/make_bulk_create_job_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Create Job URL Generator — make_bulk_create_job_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Create Job URL Generator — make_bulk_create_job_url • salesforcer - - - - - - - - + + -
-
-

Bulk Create Job URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,44 +105,56 @@

Bulk Create Job URL Generator

Bulk Create Job URL Generator

- 
make_bulk_create_job_url(
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  query_operation = FALSE
-)
- - -

Note

+
+ 
make_bulk_create_job_url(
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  query_operation = FALSE
+)
+
+
+

Arguments

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
query_operation
+

logical; an indicator of whether the call is +for a query or another operation, such as, CRUD operations.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_delete_job_url.html b/docs/reference/make_bulk_delete_job_url.html index 15d25120..cfb34e8f 100644 --- a/docs/reference/make_bulk_delete_job_url.html +++ b/docs/reference/make_bulk_delete_job_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Delete Job Generic URL Generator — make_bulk_delete_job_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Delete Job Generic URL Generator — make_bulk_delete_job_url • salesforcer - - - - - - - - + + -
-
-

Bulk Delete Job Generic URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,41 +105,53 @@

Bulk Delete Job Generic URL Generator

Bulk Delete Job Generic URL Generator

- 
make_bulk_delete_job_url(job_id, api_type = c("Bulk 2.0"))
- - -

Note

+
+ 
make_bulk_delete_job_url(job_id, api_type = c("Bulk 2.0"))
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_end_job_generic_url.html b/docs/reference/make_bulk_end_job_generic_url.html index 1ab7d32a..fc67081a 100644 --- a/docs/reference/make_bulk_end_job_generic_url.html +++ b/docs/reference/make_bulk_end_job_generic_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk End Job Generic URL Generator — make_bulk_end_job_generic_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk End Job Generic URL Generator — make_bulk_end_job_generic_url • salesforcer - - - - - - - - + + -
-
-

Bulk End Job Generic URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,41 +105,53 @@

Bulk End Job Generic URL Generator

Bulk End Job Generic URL Generator

- 
make_bulk_end_job_generic_url(job_id, api_type = c("Bulk 1.0", "Bulk 2.0"))
- - -

Note

+
+ 
make_bulk_end_job_generic_url(job_id, api_type = c("Bulk 1.0", "Bulk 2.0"))
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_get_all_jobs_url.html b/docs/reference/make_bulk_get_all_jobs_url.html index 392e00d4..b7c642e0 100644 --- a/docs/reference/make_bulk_get_all_jobs_url.html +++ b/docs/reference/make_bulk_get_all_jobs_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Get All Jobs Generic URL Generator — make_bulk_get_all_jobs_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Get All Jobs Generic URL Generator — make_bulk_get_all_jobs_url • salesforcer - - - - - - - - + + -
-
-

Bulk Get All Jobs Generic URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,45 +105,59 @@

Bulk Get All Jobs Generic URL Generator

Bulk Get All Jobs Generic URL Generator

- 
make_bulk_get_all_jobs_url(
-  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL),
-  next_records_url = NULL,
-  api_type = c("Bulk 2.0")
-)
- - -

Note

+
+ 
make_bulk_get_all_jobs_url(
+  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL),
+  next_records_url = NULL,
+  api_type = c("Bulk 2.0")
+)
+
+
+

Arguments

+
parameterized_search_list
+

list; a list of search options to locate +Bulk API jobs.

+
next_records_url
+

character; a string returned by a Salesforce +query from where to find subsequent records returned by a paginated query.

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) to send a request +to in order to retrieve queried jobs.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_get_all_query_jobs_url.html b/docs/reference/make_bulk_get_all_query_jobs_url.html index 5d694588..9977739b 100644 --- a/docs/reference/make_bulk_get_all_query_jobs_url.html +++ b/docs/reference/make_bulk_get_all_query_jobs_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Get All Query Jobs Generic URL Generator — make_bulk_get_all_query_jobs_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Get All Query Jobs Generic URL Generator — make_bulk_get_all_query_jobs_url • salesforcer - - - - - - - - + + -
-
-

Bulk Get All Query Jobs Generic URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,46 +105,60 @@

Bulk Get All Query Jobs Generic URL Generator

Bulk Get All Query Jobs Generic URL Generator

- 
make_bulk_get_all_query_jobs_url(
-  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL,
-    concurrencyMode = NULL),
-  next_records_url = NULL,
-  api_type = c("Bulk 2.0")
-)
- - -

Note

+
+ 
make_bulk_get_all_query_jobs_url(
+  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL,
+    concurrencyMode = NULL),
+  next_records_url = NULL,
+  api_type = c("Bulk 2.0")
+)
+
+
+

Arguments

+
parameterized_search_list
+

list; a list of search options to locate +Bulk API query jobs.

+
next_records_url
+

character; a string returned by a Salesforce +query from where to find subsequent records returned by a paginated query.

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) to send a request +to in order to retrieve queried jobs.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_get_job_url.html b/docs/reference/make_bulk_get_job_url.html index a86d02f1..7aa7d324 100644 --- a/docs/reference/make_bulk_get_job_url.html +++ b/docs/reference/make_bulk_get_job_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Get Job Generic URL Generator — make_bulk_get_job_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Get Job Generic URL Generator — make_bulk_get_job_url • salesforcer - - - - - - - - + + -
-
-

Bulk Get Job Generic URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,45 +105,60 @@

Bulk Get Job Generic URL Generator

Bulk Get Job Generic URL Generator

- 
make_bulk_get_job_url(
-  job_id,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  query_operation = NULL
-)
- - -

Note

+
+ 
make_bulk_get_job_url(
+  job_id,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  query_operation = NULL
+)
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
query_operation
+

logical; an indicator of whether the call is +for a query or another operation, such as, CRUD operations.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_job_records_url.html b/docs/reference/make_bulk_job_records_url.html index b952dc58..e9ab644d 100644 --- a/docs/reference/make_bulk_job_records_url.html +++ b/docs/reference/make_bulk_job_records_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Job Records URL Generator — make_bulk_job_records_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Job Records URL Generator — make_bulk_job_records_url • salesforcer - - - - - - - - + + -
-
-

Bulk Job Records URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,45 +105,60 @@

Bulk Job Records URL Generator

Bulk Job Records URL Generator

- 
make_bulk_job_records_url(
-  job_id,
-  record_type = c("successfulResults", "failedResults", "unprocessedRecords"),
-  api_type = c("Bulk 2.0")
-)
- - -

Note

+
+ 
make_bulk_job_records_url(
+  job_id,
+  record_type = c("successfulResults", "failedResults", "unprocessedRecords"),
+  api_type = c("Bulk 2.0")
+)
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
record_type
+

character; one of 'successfulResults', 'failedResults', +or 'unprocessedRecords' indicating the type of records to retrieve.

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_query_result_url.html b/docs/reference/make_bulk_query_result_url.html index b83de3ea..3756cf4b 100644 --- a/docs/reference/make_bulk_query_result_url.html +++ b/docs/reference/make_bulk_query_result_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Query Result URL Generator — make_bulk_query_result_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Query Result URL Generator — make_bulk_query_result_url • salesforcer - - - - - - - - + + -
-
-

Bulk Query Result URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,46 +105,64 @@

Bulk Query Result URL Generator

Bulk Query Result URL Generator

- 
make_bulk_query_result_url(
-  job_id,
-  batch_id = NULL,
-  result_id = NULL,
-  api_type = c("Bulk 1.0", "Bulk 2.0")
-)
- - -

Note

+
+ 
make_bulk_query_result_url(
+  job_id,
+  batch_id = NULL,
+  result_id = NULL,
+  api_type = c("Bulk 1.0", "Bulk 2.0")
+)
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
batch_id
+

character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

+
result_id
+

character; the Salesforce Id assigned to a generated +result for a bulk query batch.

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_bulk_query_url.html b/docs/reference/make_bulk_query_url.html index 9c987465..b35e9c0d 100644 --- a/docs/reference/make_bulk_query_url.html +++ b/docs/reference/make_bulk_query_url.html @@ -1,91 +1,18 @@ - - - - - - - -Bulk Query URL Generator — make_bulk_query_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Bulk Query URL Generator — make_bulk_query_url • salesforcer - - - - - - - - + + -
-
-

Bulk Query URL Generator

- Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
@@ -188,41 +105,53 @@

Bulk Query URL Generator

Bulk Query URL Generator

- 
make_bulk_query_url(job_id = NULL, api_type = c("Bulk 1.0", "Bulk 2.0"))
- - -

Note

+
+ 
make_bulk_query_url(job_id = NULL, api_type = c("Bulk 1.0", "Bulk 2.0"))
+
+
+

Arguments

+
job_id
+

character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

+
api_type
+

character; a string indicating which Bulk API to execute +the call against.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send subsequent Bulk API calls to. This URL is specific to your instance and +the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_chatter_users_url.html b/docs/reference/make_chatter_users_url.html index 53a590fd..5c201df4 100644 --- a/docs/reference/make_chatter_users_url.html +++ b/docs/reference/make_chatter_users_url.html @@ -1,91 +1,18 @@ - - - - - - - -Chatter Users URL Generator — make_chatter_users_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Chatter Users URL Generator — make_chatter_users_url • salesforcer - - - - - - - - + + -
-
-

Chatter Users URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,44 @@

Chatter Users URL Generator

Chatter Users URL Generator

- 
make_chatter_users_url()
- - -

Note

+
+ 
make_chatter_users_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send REST API calls regarding chatter users. This URL is specific to your +instance and the API version because it relies on the base rest URL.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_composite_batch_url.html b/docs/reference/make_composite_batch_url.html index cafb2c6f..93c95b55 100644 --- a/docs/reference/make_composite_batch_url.html +++ b/docs/reference/make_composite_batch_url.html @@ -1,91 +1,18 @@ - - - - - - - -Composite Batch URL Generator — make_composite_batch_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Composite Batch URL Generator — make_composite_batch_url • salesforcer - - - - - - - - + + -
-
-

Composite Batch URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,44 @@

Composite Batch URL Generator

Composite Batch URL Generator

- 
make_composite_batch_url()
- - -

Note

+
+ 
make_composite_batch_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send composite batch REST API calls to. This URL is specific to your instance +and the API version being used because it relies on the base REST URL.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_composite_url.html b/docs/reference/make_composite_url.html index 0921e58a..1b680358 100644 --- a/docs/reference/make_composite_url.html +++ b/docs/reference/make_composite_url.html @@ -1,91 +1,18 @@ - - - - - - - -Composite URL Generator — make_composite_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Composite URL Generator — make_composite_url • salesforcer - - - - - - - - + + -
-
-

Composite URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,44 @@

Composite URL Generator

Composite URL Generator

- 
make_composite_url()
- - -

Note

+
+ 
make_composite_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send composite REST API calls to. This URL is specific to your +instance and the API version because it relies on the base rest URL.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboard_copy_url.html b/docs/reference/make_dashboard_copy_url.html index 4a6e36e9..00c0ed96 100644 --- a/docs/reference/make_dashboard_copy_url.html +++ b/docs/reference/make_dashboard_copy_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard Copy URL generator — make_dashboard_copy_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard Copy URL generator — make_dashboard_copy_url • salesforcer - - - - - - - - + + -
-
-

Dashboard Copy URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,50 @@

Dashboard Copy URL generator

Dashboard Copy URL generator

- 
make_dashboard_copy_url(dashboard_id)
- - -

Note

+
+ 
make_dashboard_copy_url(dashboard_id)
+
+
+

Arguments

+
dashboard_id
+

character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboard_describe_url.html b/docs/reference/make_dashboard_describe_url.html index 7640a669..4745cbe1 100644 --- a/docs/reference/make_dashboard_describe_url.html +++ b/docs/reference/make_dashboard_describe_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard describe URL generator — make_dashboard_describe_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard describe URL generator — make_dashboard_describe_url • salesforcer - - - - - - - - + + -
-
-

Dashboard describe URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,50 @@

Dashboard describe URL generator

Dashboard describe URL generator

- 
make_dashboard_describe_url(dashboard_id)
- - -

Note

+
+ 
make_dashboard_describe_url(dashboard_id)
+
+
+

Arguments

+
dashboard_id
+

character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboard_filter_operators_list_url.html b/docs/reference/make_dashboard_filter_operators_list_url.html index 4343b9cc..70c2d261 100644 --- a/docs/reference/make_dashboard_filter_operators_list_url.html +++ b/docs/reference/make_dashboard_filter_operators_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard filter operators list URL generator — make_dashboard_filter_operators_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard filter operators list URL generator — make_dashboard_filter_operators_list_url • salesforcer - - - - - - - - + + -
-
-

Dashboard filter operators list URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,50 @@

Dashboard filter operators list URL generator

Dashboard filter operators list URL generator

- 
make_dashboard_filter_operators_list_url(for_dashboards = FALSE)
- - -

Note

+
+ 
make_dashboard_filter_operators_list_url(for_dashboards = FALSE)
+
+
+

Arguments

+
for_dashboards
+

logical; an indicator of whether the filter is +in reference to dashboards or not.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboard_filter_options_analysis_url.html b/docs/reference/make_dashboard_filter_options_analysis_url.html index 6200bb93..61519e22 100644 --- a/docs/reference/make_dashboard_filter_options_analysis_url.html +++ b/docs/reference/make_dashboard_filter_options_analysis_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard filter options analysis URL generator — make_dashboard_filter_options_analysis_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard filter options analysis URL generator — make_dashboard_filter_options_analysis_url • salesforcer - - - - - - - - + + -
-
-

Dashboard filter options analysis URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,50 @@

Dashboard filter options analysis URL generator

Dashboard filter options analysis URL generator

- 
make_dashboard_filter_options_analysis_url(dashboard_id)
- - -

Note

+
+ 
make_dashboard_filter_options_analysis_url(dashboard_id)
+
+
+

Arguments

+
dashboard_id
+

character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboard_status_url.html b/docs/reference/make_dashboard_status_url.html index 94ca4bbc..239cab2e 100644 --- a/docs/reference/make_dashboard_status_url.html +++ b/docs/reference/make_dashboard_status_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard status URL generator — make_dashboard_status_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard status URL generator — make_dashboard_status_url • salesforcer - - - - - - - - + + -
-
-

Dashboard status URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,50 @@

Dashboard status URL generator

Dashboard status URL generator

- 
make_dashboard_status_url(dashboard_id)
- - -

Note

+
+ 
make_dashboard_status_url(dashboard_id)
+
+
+

Arguments

+
dashboard_id
+

character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboard_url.html b/docs/reference/make_dashboard_url.html index c638ae89..e8af014d 100644 --- a/docs/reference/make_dashboard_url.html +++ b/docs/reference/make_dashboard_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard URL generator — make_dashboard_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard URL generator — make_dashboard_url • salesforcer - - - - - - - - + + -
-
-

Dashboard URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,50 @@

Dashboard URL generator

Dashboard URL generator

- 
make_dashboard_url(dashboard_id)
- - -

Note

+
+ 
make_dashboard_url(dashboard_id)
+
+
+

Arguments

+
dashboard_id
+

character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_dashboards_list_url.html b/docs/reference/make_dashboards_list_url.html index 471b0be0..b43ac837 100644 --- a/docs/reference/make_dashboards_list_url.html +++ b/docs/reference/make_dashboards_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Dashboard list URL generator — make_dashboards_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Dashboard list URL generator — make_dashboards_list_url • salesforcer - - - - - - - - + + -
-
-

Dashboard list URL generator

- Source: R/endpoints-analytics-dashboard.R + Source: R/endpoints-analytics-dashboard.R
@@ -188,41 +105,44 @@

Dashboard list URL generator

Dashboard list URL generator

- 
make_dashboards_list_url()
- - -

Note

+
+ 
make_dashboards_list_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_login_url.html b/docs/reference/make_login_url.html index e58c1b30..dff36d2d 100644 --- a/docs/reference/make_login_url.html +++ b/docs/reference/make_login_url.html @@ -1,91 +1,18 @@ - - - - - - - -Login URL Generator — make_login_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Login URL Generator — make_login_url • salesforcer - - - - - - - - + + -
-
-

Login URL Generator

- Source: R/endpoints-soap.R + Source: R/endpoints-soap.R
@@ -188,41 +105,54 @@

Login URL Generator

Login URL Generator

- 
make_login_url(login_url)
- - -

Note

+
+ 
make_login_url(login_url)
+
-

This function is meant to be used internally. Only use when debugging.

+
+

Arguments

+
login_url
+

character; the package default login URL is +https://login.salesforce.com, but other URLs can be used. For example, if you +are logging into a sandbox environment, then the login URL should be set to +https://test.salesforce.com.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +login to. This string is specific to your environment (production, sandbox, +etc.) and the API version being used.

+
+
+

Note

+

This function is meant to be used internally. Only use when debugging. +You should set the login URL globally as one of the package options: +options(salesforcer.login_url="https://test.salesforce.com").

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_parameterized_search_url.html b/docs/reference/make_parameterized_search_url.html index 525453ae..c5275963 100644 --- a/docs/reference/make_parameterized_search_url.html +++ b/docs/reference/make_parameterized_search_url.html @@ -1,92 +1,18 @@ - - - - - - - -Parameterized Search URL Generator — make_parameterized_search_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Parameterized Search URL Generator — make_parameterized_search_url • salesforcer - - - - - - - - + + -
-
-

Parameterized Search URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R

Parameterized Search URL Generator

-

Parameterized Search URL Generator

- 
make_parameterized_search_url(search_string = NULL, params = NULL)
-
-make_parameterized_search_url(search_string = NULL, params = NULL)
- - -

Note

+
+ 
make_parameterized_search_url(search_string = NULL, params = NULL)
+
+
+

Arguments

+
search_string
+

character; a valid string for conducting a simple +RESTful search using parameters instead of a SOSL clause.

+
params
+

list; a list of other values to populate in the URL +query string to further restrict the search

+
+
+

Value

+

character; a complete URL (as a string) that has applied the +proper escaping and formatting for the search specified by the function inputs.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

-

This function is meant to be used internally. Only use when debugging.

+
+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_query_url.html b/docs/reference/make_query_url.html index 78689024..f5d7134e 100644 --- a/docs/reference/make_query_url.html +++ b/docs/reference/make_query_url.html @@ -1,91 +1,18 @@ - - - - - - - -Query URL Generator — make_query_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Query URL Generator — make_query_url • salesforcer - - - - - - - - + + -
-
-

Query URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,57 @@

Query URL Generator

Query URL Generator

- 
make_query_url(soql, queryall, next_records_url)
- - -

Note

+
+ 
make_query_url(soql, queryall, next_records_url)
+
+
+

Arguments

+
soql
+

character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

+
queryall
+

logical; indicating if the query recordset should include records +that have been deleted because of a merge or delete. Setting this argument to +TRUE will also return information about archived Task and Event records. +It is available in API versions 29.0 and later.

+
next_records_url
+

character; a string returned by a Salesforce +query from where to find subsequent records returned by a paginated query.

+
+
+

Value

+

character; a complete URL (as a string) to send a request +to in order to retrieve queried records.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_copy_url.html b/docs/reference/make_report_copy_url.html index ec7f222d..8305e3bd 100644 --- a/docs/reference/make_report_copy_url.html +++ b/docs/reference/make_report_copy_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Copy URL generator — make_report_copy_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Copy URL generator — make_report_copy_url • salesforcer - - - - - - - - + + -
-
-

Report Copy URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,50 @@

Report Copy URL generator

Report Copy URL generator

- 
make_report_copy_url(report_id)
- - -

Note

+
+ 
make_report_copy_url(report_id)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_create_url.html b/docs/reference/make_report_create_url.html index 0cbece46..7ccf6a49 100644 --- a/docs/reference/make_report_create_url.html +++ b/docs/reference/make_report_create_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Create URL generator — make_report_create_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Create URL generator — make_report_create_url • salesforcer - - - - - - - - + + -
-
-

Report Create URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,44 @@

Report Create URL generator

Report Create URL generator

- 
make_report_create_url()
- - -

Note

+
+ 
make_report_create_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_describe_url.html b/docs/reference/make_report_describe_url.html index 14827798..f380f151 100644 --- a/docs/reference/make_report_describe_url.html +++ b/docs/reference/make_report_describe_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Describe URL generator — make_report_describe_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Describe URL generator — make_report_describe_url • salesforcer - - - - - - - - + + -
-
-

Report Describe URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,50 @@

Report Describe URL generator

Report Describe URL generator

- 
make_report_describe_url(report_id)
- - -

Note

+
+ 
make_report_describe_url(report_id)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_execute_url.html b/docs/reference/make_report_execute_url.html index d146d311..6b5a15b8 100644 --- a/docs/reference/make_report_execute_url.html +++ b/docs/reference/make_report_execute_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Execute URL generator — make_report_execute_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Execute URL generator — make_report_execute_url • salesforcer - - - - - - - - + + -
-
-

Report Execute URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,60 @@

Report Execute URL generator

Report Execute URL generator

- 
make_report_execute_url(report_id, async = TRUE, include_details = FALSE)
- - -

Note

+
+ 
make_report_execute_url(report_id, async = TRUE, include_details = FALSE)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
async
+

logical; an indicator, by default set to TRUE, which +executes the report asynchronously. If executed asynchronously, this function +will return a list of attributes of the created report instance. The results +can be pulled down by providing the report id and instance id to +the function sf_get_report_instance_results. Refer to the details +of the documentation on why executing a report asynchronously is preferred.

+
include_details
+

logical; an indicator applying to a synchronous +indicating whether the run should return summary data with details.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_fields_url.html b/docs/reference/make_report_fields_url.html index fe116fd9..15c54425 100644 --- a/docs/reference/make_report_fields_url.html +++ b/docs/reference/make_report_fields_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Fields URL generator — make_report_fields_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Fields URL generator — make_report_fields_url • salesforcer - - - - - - - - + + -
-
-

Report Fields URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,50 @@

Report Fields URL generator

Report Fields URL generator

- 
make_report_fields_url(report_id)
- - -

Note

+
+ 
make_report_fields_url(report_id)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_filter_operators_list_url.html b/docs/reference/make_report_filter_operators_list_url.html index 6bfe1046..08be97e0 100644 --- a/docs/reference/make_report_filter_operators_list_url.html +++ b/docs/reference/make_report_filter_operators_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Filter Operator List URL generator — make_report_filter_operators_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Filter Operator List URL generator — make_report_filter_operators_list_url • salesforcer - - - - - - - - + + -
-
-

Report Filter Operator List URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,50 @@

Report Filter Operator List URL generator

Report Filter Operator List URL generator

- 
make_report_filter_operators_list_url(for_dashboards = FALSE)
- - -

Note

+
+ 
make_report_filter_operators_list_url(for_dashboards = FALSE)
+
+
+

Arguments

+
for_dashboards
+

logical; an indicator of whether the filter is +in reference to dashboards or not.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_instance_url.html b/docs/reference/make_report_instance_url.html index 7b614073..23645133 100644 --- a/docs/reference/make_report_instance_url.html +++ b/docs/reference/make_report_instance_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Instance URL generator — make_report_instance_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Instance URL generator — make_report_instance_url • salesforcer - - - - - - - - + + -
-
-

Report Instance URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,54 @@

Report Instance URL generator

Report Instance URL generator

- 
make_report_instance_url(report_id, report_instance_id)
- - -

Note

+
+ 
make_report_instance_url(report_id, report_instance_id)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
report_instance_id
+

character; the Salesforce Id assigned to a +created analytics report instance (an asynchronous run). It will start with +"0LG".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_instances_list_url.html b/docs/reference/make_report_instances_list_url.html index 08c1eb32..0231a61d 100644 --- a/docs/reference/make_report_instances_list_url.html +++ b/docs/reference/make_report_instances_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Instances List URL generator — make_report_instances_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Instances List URL generator — make_report_instances_list_url • salesforcer - - - - - - - - + + -
-
-

Report Instances List URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,50 @@

Report Instances List URL generator

Report Instances List URL generator

- 
make_report_instances_list_url(report_id)
- - -

Note

+
+ 
make_report_instances_list_url(report_id)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_query_url.html b/docs/reference/make_report_query_url.html index a4bbebb5..12f66661 100644 --- a/docs/reference/make_report_query_url.html +++ b/docs/reference/make_report_query_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Query URL generator — make_report_query_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Query URL generator — make_report_query_url • salesforcer - - - - - - - - + + -
-
-

Report Query URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,44 @@

Report Query URL generator

Report Query URL generator

- 
make_report_query_url()
- - -

Note

+
+ 
make_report_query_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_type_describe_url.html b/docs/reference/make_report_type_describe_url.html index e22f4615..10fc3005 100644 --- a/docs/reference/make_report_type_describe_url.html +++ b/docs/reference/make_report_type_describe_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Type Describe URL generator — make_report_type_describe_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Type Describe URL generator — make_report_type_describe_url • salesforcer - - - - - - - - + + -
-
-

Report Type Describe URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,49 @@

Report Type Describe URL generator

Report Type Describe URL generator

- 
make_report_type_describe_url(type)
- - -

Note

+
+ 
make_report_type_describe_url(type)
+
+
+

Arguments

+
type
+

character; The API name of a report type.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_types_list_url.html b/docs/reference/make_report_types_list_url.html index 6866b94d..a1fe4b76 100644 --- a/docs/reference/make_report_types_list_url.html +++ b/docs/reference/make_report_types_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report Type List URL generator — make_report_types_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report Type List URL generator — make_report_types_list_url • salesforcer - - - - - - - - + + -
-
-

Report Type List URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,44 @@

Report Type List URL generator

Report Type List URL generator

- 
make_report_types_list_url()
- - -

Note

+
+ 
make_report_types_list_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_report_url.html b/docs/reference/make_report_url.html index 407c4a7d..baad4b76 100644 --- a/docs/reference/make_report_url.html +++ b/docs/reference/make_report_url.html @@ -1,91 +1,18 @@ - - - - - - - -Report URL generator — make_report_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Report URL generator — make_report_url • salesforcer - - - - - - - - + + -
-
-

Report URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,50 @@

Report URL generator

Report URL generator

- 
make_report_url(report_id)
- - -

Note

+
+ 
make_report_url(report_id)
+
+
+

Arguments

+
report_id
+

character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_reports_list_url.html b/docs/reference/make_reports_list_url.html index 8f668d55..28584488 100644 --- a/docs/reference/make_reports_list_url.html +++ b/docs/reference/make_reports_list_url.html @@ -1,91 +1,18 @@ - - - - - - - -Reports List URL generator — make_reports_list_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Reports List URL generator — make_reports_list_url • salesforcer - - - - - - - - + + -
-
-

Reports List URL generator

- Source: R/endpoints-analytics-report.R + Source: R/endpoints-analytics-report.R
@@ -188,41 +105,44 @@

Reports List URL generator

Reports List URL generator

- 
make_reports_list_url()
- - -

Note

+
+ 
make_reports_list_url()
+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send Reports and Dashboards API calls to. This URL is specific to your instance +and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_rest_describe_url.html b/docs/reference/make_rest_describe_url.html index 3701f046..8959357a 100644 --- a/docs/reference/make_rest_describe_url.html +++ b/docs/reference/make_rest_describe_url.html @@ -1,91 +1,18 @@ - - - - - - - -REST API Describe URL Generator — make_rest_describe_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -REST API Describe URL Generator — make_rest_describe_url • salesforcer - - - - - - - - + + -
-
-

REST API Describe URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,50 +105,50 @@

REST API Describe URL Generator

REST API Describe URL Generator

- 
make_rest_describe_url(object_name)
- -

Arguments

- - - - - - -
object_name

character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

- -

Note

+
+ 
make_rest_describe_url(object_name)
+
+
+

Arguments

+
object_name
+

character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send REST API calls to regarding a specific object. This URL is also specific +to your instance and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_rest_objects_url.html b/docs/reference/make_rest_objects_url.html index 68cc845e..e035cacb 100644 --- a/docs/reference/make_rest_objects_url.html +++ b/docs/reference/make_rest_objects_url.html @@ -1,91 +1,18 @@ - - - - - - - -REST Objects URL Generator — make_rest_objects_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -REST Objects URL Generator — make_rest_objects_url • salesforcer - - - - - - - - + + -
-
-

REST Objects URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,50 @@

REST Objects URL Generator

REST Objects URL Generator

- 
make_rest_objects_url(object)
- - -

Note

+
+ 
make_rest_objects_url(object_name)
+
+
+

Arguments

+
object_name
+

character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send REST API calls to regarding a specific object. This URL is also specific +to your instance and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_rest_record_url.html b/docs/reference/make_rest_record_url.html index cc0d1dc2..8b89e8aa 100644 --- a/docs/reference/make_rest_record_url.html +++ b/docs/reference/make_rest_record_url.html @@ -1,91 +1,18 @@ - - - - - - - -REST Individual Record URL Generator — make_rest_record_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -REST Individual Record URL Generator — make_rest_record_url • salesforcer - - - - - - - - + + -
-
-

REST Individual Record URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,53 @@

REST Individual Record URL Generator

REST Individual Record URL Generator

- 
make_rest_record_url(object, sf_id)
- - -

Note

+
+ 
make_rest_record_url(object_name, sf_id)
+
+
+

Arguments

+
object_name
+

character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

+
sf_id
+

character; a Salesforce generated Id that uniquely +identifies a record.

+
+
+

Value

+

character; a complete URL (as a string) that will be used to +send REST API calls to regarding a specific record in an object. This URL is +also specific to your instance and the API version being used.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_search_url.html b/docs/reference/make_search_url.html index 6123d032..9a9295d0 100644 --- a/docs/reference/make_search_url.html +++ b/docs/reference/make_search_url.html @@ -1,91 +1,18 @@ - - - - - - - -Search URL Generator — make_search_url • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Search URL Generator — make_search_url • salesforcer - - - - - - - - + + -
-
-

Search URL Generator

- Source: R/endpoints-rest.R + Source: R/endpoints-rest.R
@@ -188,41 +105,49 @@

Search URL Generator

Search URL Generator

- 
make_search_url(search_string)
- - -

Note

+
+ 
make_search_url(search_string)
+
+
+

Arguments

+
search_string
+

character; a valid string for conducting a SOSL +search.

+
+
+

Value

+

character; a complete URL (as a string) that has applied the +proper escaping and formatting for the search specified by the string.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_soap_xml_skeleton.html b/docs/reference/make_soap_xml_skeleton.html index beea323d..44fb80f0 100644 --- a/docs/reference/make_soap_xml_skeleton.html +++ b/docs/reference/make_soap_xml_skeleton.html @@ -1,91 +1,18 @@ - - - - - - - -Make SOAP XML Request Skeleton — make_soap_xml_skeleton • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Make SOAP XML Request Skeleton — make_soap_xml_skeleton • salesforcer - - - - - - - - + + -
-
-

Make SOAP XML Request Skeleton

- Source: R/utils-xml.R + Source: R/utils-xml.R
@@ -188,25 +105,27 @@

Make SOAP XML Request Skeleton

Create XML in preparation for sending to the SOAP API

- 
make_soap_xml_skeleton(soap_headers = list(), metadata_ns = FALSE)
- -

Arguments

- - - - - - -
soap_headers

list; any number of SOAP headers

- -

Value

- -

a XML document

-

Note

+
+ 
make_soap_xml_skeleton(soap_headers = list(), metadata_ns = FALSE)
+
+
+

Arguments

+
soap_headers
+

list; any number of SOAP headers

+
metadata_ns
+

logical; an indicator of whether to use the namespaces +required by the Metadata API or the default ones.

+
+
+

Value

+

xmlNode; an XML object containing just the header portion of the +request

+
+
+

Note

This function is meant to be used internally. Only use when debugging. -Any of the following SOAP headers are allowed:

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/make_verbose_httr_message.html b/docs/reference/make_verbose_httr_message.html index 4effb402..f99eb593 100644 --- a/docs/reference/make_verbose_httr_message.html +++ b/docs/reference/make_verbose_httr_message.html @@ -1,91 +1,18 @@ - - - - - - - -Format Verbose Call — make_verbose_httr_message • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Format Verbose Call — make_verbose_httr_message • salesforcer - - - - - - - - + + -
-
-

Format Verbose Call

- Source: R/utils.R + Source: R/utils.R
@@ -188,48 +105,67 @@

Format Verbose Call

Format Verbose Call

- 
make_verbose_httr_message(
-  method,
-  url,
-  headers = NULL,
-  body = NULL,
-  auto_unbox = TRUE,
-  ...
-)
- - -

Note

+
+ 
make_verbose_httr_message(
+  method,
+  url,
+  headers = NULL,
+  body = NULL,
+  auto_unbox = TRUE,
+  ...
+)
+
+
+

Arguments

+
method
+

character; the type of HTTP method invoked (e.g., POST, +PUT, DELETE, etc.).

+
url
+

character; the URL that the request was sent to

+
headers
+

character; the set of header options set on the request

+
body
+

character; the body of the request.

+
auto_unbox
+

logical, an indicator of whether to parse vectors of +of length 1 into a single character string, rather than a list.

+
...
+

additional arguments passed on to toJSON.

+
+
+

Value

+

NULL invisibly, because this function is intended for the +side-effect of printing out the details of an HTTP call.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/map_sf_type_to_r_type.html b/docs/reference/map_sf_type_to_r_type.html index ecf31be7..31c4e43f 100644 --- a/docs/reference/map_sf_type_to_r_type.html +++ b/docs/reference/map_sf_type_to_r_type.html @@ -1,92 +1,19 @@ - - - - - - - -Map Salesforce data types to R data types — map_sf_type_to_r_type • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Map Salesforce data types to R data types — map_sf_type_to_r_type • salesforcer - - - - - - - - + + -
-
-

Map Salesforce data types to R data types

- Source: R/utils-query.R + Source: R/utils-query.R
@@ -190,61 +107,55 @@

Map Salesforce data types to R data types

a specific data type in R.

- 
map_sf_type_to_r_type(x)
- -

Arguments

- - - - - - -
x

character; the Salesforce data type.

- -

Value

+
+ 
map_sf_type_to_r_type(x)
+
+
+

Arguments

+
x
+

character; the Salesforce data type.

+
+
+

Value

character the R data type.

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

-

See also

- -
- -
+
+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/merge_null_to_na.html b/docs/reference/merge_null_to_na.html index 916ea86f..8e780e11 100644 --- a/docs/reference/merge_null_to_na.html +++ b/docs/reference/merge_null_to_na.html @@ -1,91 +1,20 @@ - - - - - - - -Return NA if NULL — merge_null_to_na • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Return NA if NULL — merge_null_to_na • salesforcer - - - - - - - - + + -
-
-

Return NA if NULL

- Source: R/utils.R + Source: R/utils.R
-

Return NA if NULL

+

A helper function to convert NULL values in API responses to a value of NA +which is allowed in data frames. Oftentimes, a NULL value creates issues when +binding and building data frames from parsed output, so we need to switch to NA.

- 
merge_null_to_na(x)
- - -

Note

+
+ 
merge_null_to_na(x)
+
+
+

Arguments

+
x
+

a value, typically a single element or a list to switch to NA if +its value appears to be NULL.

+
+
+

Value

+

the original value of parameter x or NA if the value +meets the criteria to be considered NULL.

+
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+
-
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/message_w_errors_listed.html b/docs/reference/message_w_errors_listed.html index a0d21d03..1e49e3f2 100644 --- a/docs/reference/message_w_errors_listed.html +++ b/docs/reference/message_w_errors_listed.html @@ -1,91 +1,18 @@ - - - - - - - -List a vector of issues and in a message — message_w_errors_listed • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List a vector of issues and in a message — message_w_errors_listed • salesforcer - - - - - - - - + + -
-
-

List a vector of issues and in a message

- Source: R/utils-input-validation.R + Source: R/utils-input-validation.R
@@ -188,59 +105,52 @@

List a vector of issues and in a message

List a vector of issues and in a message

- 
message_w_errors_listed(main_text = "Consider the following:", errors = NULL)
+
+ 
message_w_errors_listed(main_text = "Consider the following:", errors = NULL)
+
-

Arguments

- - - - - - - - - - -
main_text

character; The text used to introduce the list of +

+

Arguments

+
main_text
+

character; The text used to introduce the list of errors, typically ending with a colon. For example: "Consider fixing the -following issue(s):".

errors

errors; a vector of issues that will be formatted into -a bulleted list for the user to review with each issue listed on a new line.

- -

Value

- +following issue(s):".

+
errors
+

errors; a vector of issues that will be formatted into +a bulleted list for the user to review with each issue listed on a new line.

+
+
+

Value

NULL invisibly

-

Note

- +
+
+

Note

This function is meant to be used internally. Only use when debugging.

+
+ -
-
-

Developed by Steven M. Mortimer.

+
+

Developed by Steven M. Mortimer.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - - - - - - - + diff --git a/docs/reference/metadata_type_validator.html b/docs/reference/metadata_type_validator.html index 28d5c40d..ccf03784 100644 --- a/docs/reference/metadata_type_validator.html +++ b/docs/reference/metadata_type_validator.html @@ -1,92 +1,19 @@ - - - - - - - -Metadata Data Type Validator — metadata_type_validator • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Metadata Data Type Validator — metadata_type_validator • salesforcer - - - - - - - - + + -
-
-

Metadata Data Type Validator

- Source: R/utils-metadata.R + Source: R/utils-metadata.R
@@ -190,481 +107,708 @@

Metadata Data Type Validator

Below is a list of objects and their required components to be created with this function:

- 
metadata_type_validator(obj_type, obj_data)
+
+ 
metadata_type_validator(obj_type, obj_data)
+
+ +
+

Arguments

+
obj_type
+

a string from one of the object types described above

+
obj_data
+

a list of lists or a data.frame with the required inputs to create the +the obj_type specified.

+
+
+

Value

+

a list that can be used as input to one of the CRUD Metadata API +operations: sf_create_metadata, sf_update_metadata, sf_update_metadata

+
+
+

Details

+

AccessMapping

+
accessLevel
+

a character

+ +
object
+

a character

-

Arguments

- - - - - - - - - - -
obj_type

a string from one of the object types described above

obj_data

a list of lists or a data.frame with the required inputs to create the -the obj_type specified.

+
objectField
+

a character

-

Value

+
userField
+

a character

-

a list that can be used as input to one of the CRUD Metadata API -operations: sf_create_metadata, sf_update_metadata, sf_update_metadata

-

Details

-

AccessMapping

-
-
accessLevel

a character

-
object

a character

-
objectField

a character

-
userField

a character

- -
- -

AccountSettings

-
-
fullName

a character (inherited from Metadata)

-
enableAccountOwnerReport

a character either 'true' or 'false'

-
enableAccountTeams

a character either 'true' or 'false'

-
showViewHierarchyLink

a character either 'true' or 'false'

- -
- -

AccountSharingRuleSettings

-
-
caseAccessLevel

a character

-
contactAccessLevel

a character

-
opportunityAccessLevel

a character

- -
- -

ActionLinkGroupTemplate

-
-
fullName

a character (inherited from Metadata)

-
actionLinkTemplates

a ActionLinkTemplate

-
category

a PlatformActionGroupCategory - which is a character taking one of the following values: -

    -

  • Primary

    • +

AccountSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableAccountOwnerReport
+

a character either 'true' or 'false'

+ +
enableAccountTeams
+

a character either 'true' or 'false'

+ +
showViewHierarchyLink
+

a character either 'true' or 'false'

+ + +

AccountSharingRuleSettings

+
caseAccessLevel
+

a character

+ +
contactAccessLevel
+

a character

+ +
opportunityAccessLevel
+

a character

+ + +

ActionLinkGroupTemplate

+
fullName
+

a character (inherited from Metadata)

+ +
actionLinkTemplates
+

a ActionLinkTemplate

+ +
category
+

a PlatformActionGroupCategory - which is a character taking one of the following values:

  • Primary

  • Overflow

    • -

-
executionsAllowed

a ActionLinkExecutionsAllowed - which is a character taking one of the following values: -

    -

  • Once

    • +
+ +
executionsAllowed
+

a ActionLinkExecutionsAllowed - which is a character taking one of the following values:

  • Once

  • OncePerUser

  • Unlimited

    • -

-
hoursUntilExpiration

an integer

-
isPublished

a character either 'true' or 'false'

-
name

a character

- -
- -

ActionLinkTemplate

-
-
actionUrl

a character

-
headers

a character

-
isConfirmationRequired

a character either 'true' or 'false'

-
isGroupDefault

a character either 'true' or 'false'

-
label

a character

-
labelKey

a character

-
linkType

a ActionLinkType - which is a character taking one of the following values: -

    -

  • API

    • +
+ +
hoursUntilExpiration
+

an integer

+ +
isPublished
+

a character either 'true' or 'false'

+ +
name
+

a character

+ + +

ActionLinkTemplate

+
actionUrl
+

a character

+ +
headers
+

a character

+ +
isConfirmationRequired
+

a character either 'true' or 'false'

+ +
isGroupDefault
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
labelKey
+

a character

+ +
linkType
+

a ActionLinkType - which is a character taking one of the following values:

  • API

  • APIAsync

  • Download

  • UI

    • -

-
method

a ActionLinkHttpMethod - which is a character taking one of the following values: -

    -

  • HttpDelete

    • +
+ +
method
+

a ActionLinkHttpMethod - which is a character taking one of the following values:

  • HttpDelete

  • HttpHead

  • HttpGet

  • HttpPatch

  • HttpPost

  • HttpPut

    • -

-
position

an integer

-
requestBody

a character

-
userAlias

a character

-
userVisibility

a ActionLinkUserVisibility - which is a character taking one of the following values: -

    -

  • Creator

    • +
+ +
position
+

an integer

+ +
requestBody
+

a character

+ +
userAlias
+

a character

+ +
userVisibility
+

a ActionLinkUserVisibility - which is a character taking one of the following values:

  • Creator

  • Everyone

  • EveryoneButCreator

  • Manager

  • CustomUser

  • CustomExcludedUser

    • -

+ -
-

ActionOverride

-
-
actionName

a character

-
comment

a character

-
content

a character

-
formFactor

a FormFactor - which is a character taking one of the following values: -

    -

  • Small

    • +

ActionOverride

+
actionName
+

a character

+ +
comment
+

a character

+ +
content
+

a character

+ +
formFactor
+

a FormFactor - which is a character taking one of the following values:

  • Small

  • Medium

  • Large

    • -

-
skipRecordTypeSelect

a character either 'true' or 'false'

-
type

a ActionOverrideType - which is a character taking one of the following values: -

    -

  • Default

    • +
+ +
skipRecordTypeSelect
+

a character either 'true' or 'false'

+ +
type
+

a ActionOverrideType - which is a character taking one of the following values:

  • Default

  • Standard

  • Scontrol

  • Visualforce

  • Flexipage

  • LightningComponent

    • -

- -
- -

ActivitiesSettings

-
-
fullName

a character (inherited from Metadata)

-
allowUsersToRelateMultipleContactsToTasksAndEvents

a character either 'true' or 'false'

-
autoRelateEventAttendees

a character either 'true' or 'false'

-
enableActivityReminders

a character either 'true' or 'false'

-
enableClickCreateEvents

a character either 'true' or 'false'

-
enableDragAndDropScheduling

a character either 'true' or 'false'

-
enableEmailTracking

a character either 'true' or 'false'

-
enableGroupTasks

a character either 'true' or 'false'

-
enableListViewScheduling

a character either 'true' or 'false'

-
enableLogNote

a character either 'true' or 'false'

-
enableMultidayEvents

a character either 'true' or 'false'

-
enableRecurringEvents

a character either 'true' or 'false'

-
enableRecurringTasks

a character either 'true' or 'false'

-
enableSidebarCalendarShortcut

a character either 'true' or 'false'

-
enableSimpleTaskCreateUI

a character either 'true' or 'false'

-
enableUNSTaskDelegatedToNotifications

a character either 'true' or 'false'

-
meetingRequestsLogo

a character

-
showCustomLogoMeetingRequests

a character either 'true' or 'false'

-
showEventDetailsMultiUserCalendar

a character either 'true' or 'false'

-
showHomePageHoverLinksForEvents

a character either 'true' or 'false'

-
showMyTasksHoverLinks

a character either 'true' or 'false'

- -
- -

AddressSettings

-
-
fullName

a character (inherited from Metadata)

-
countriesAndStates

a CountriesAndStates

- -
- -

AdjustmentsSettings

-
-
enableAdjustments

a character either 'true' or 'false'

-
enableOwnerAdjustments

a character either 'true' or 'false'

- -
- -

AgentConfigAssignments

-
-
profiles

a AgentConfigProfileAssignments

-
users

a AgentConfigUserAssignments

- -
- -

AgentConfigButtons

-
-
button

a character

- -
- -

AgentConfigProfileAssignments

-
-
profile

a character

- -
- -

AgentConfigSkills

-
-
skill

a character

- -
- -

AgentConfigUserAssignments

-
-
user

a character

- -
- -

AnalyticsCloudComponentLayoutItem

-
-
assetType

a character

-
devName

a character

-
error

a character

-
filter

a character

-
height

an integer

-
hideOnError

a character either 'true' or 'false'

-
showHeader

a character either 'true' or 'false'

-
showSharing

a character either 'true' or 'false'

-
showTitle

a character either 'true' or 'false'

-
width

a character

- -
- -

AnalyticSnapshot

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
groupColumn

a character

-
mappings

a AnalyticSnapshotMapping

-
name

a character

-
runningUser

a character

-
sourceReport

a character

-
targetObject

a character

- -
- -

AnalyticSnapshotMapping

-
-
aggregateType

a ReportSummaryType - which is a character taking one of the following values: -

    -

  • Sum

    • +
+ + +

ActivitiesSettings

+
fullName
+

a character (inherited from Metadata)

+ +
allowUsersToRelateMultipleContactsToTasksAndEvents
+

a character either 'true' or 'false'

+ +
autoRelateEventAttendees
+

a character either 'true' or 'false'

+ +
enableActivityReminders
+

a character either 'true' or 'false'

+ +
enableClickCreateEvents
+

a character either 'true' or 'false'

+ +
enableDragAndDropScheduling
+

a character either 'true' or 'false'

+ +
enableEmailTracking
+

a character either 'true' or 'false'

+ +
enableGroupTasks
+

a character either 'true' or 'false'

+ +
enableListViewScheduling
+

a character either 'true' or 'false'

+ +
enableLogNote
+

a character either 'true' or 'false'

+ +
enableMultidayEvents
+

a character either 'true' or 'false'

+ +
enableRecurringEvents
+

a character either 'true' or 'false'

+ +
enableRecurringTasks
+

a character either 'true' or 'false'

+ +
enableSidebarCalendarShortcut
+

a character either 'true' or 'false'

+ +
enableSimpleTaskCreateUI
+

a character either 'true' or 'false'

+ +
enableUNSTaskDelegatedToNotifications
+

a character either 'true' or 'false'

+ +
meetingRequestsLogo
+

a character

+ +
showCustomLogoMeetingRequests
+

a character either 'true' or 'false'

+ +
showEventDetailsMultiUserCalendar
+

a character either 'true' or 'false'

+ +
showHomePageHoverLinksForEvents
+

a character either 'true' or 'false'

+ +
showMyTasksHoverLinks
+

a character either 'true' or 'false'

+ + +

AddressSettings

+
fullName
+

a character (inherited from Metadata)

+ +
countriesAndStates
+

a CountriesAndStates

+ + +

AdjustmentsSettings

+
enableAdjustments
+

a character either 'true' or 'false'

+ +
enableOwnerAdjustments
+

a character either 'true' or 'false'

+ + +

AgentConfigAssignments

+
profiles
+

a AgentConfigProfileAssignments

+ +
users
+

a AgentConfigUserAssignments

+ + +

AgentConfigButtons

+
button
+

a character

+ + +

AgentConfigProfileAssignments

+
profile
+

a character

+ + +

AgentConfigSkills

+
skill
+

a character

+ + +

AgentConfigUserAssignments

+
user
+

a character

+ + +

AnalyticsCloudComponentLayoutItem

+
assetType
+

a character

+ +
devName
+

a character

+ +
error
+

a character

+ +
filter
+

a character

+ +
height
+

an integer

+ +
hideOnError
+

a character either 'true' or 'false'

+ +
showHeader
+

a character either 'true' or 'false'

+ +
showSharing
+

a character either 'true' or 'false'

+ +
showTitle
+

a character either 'true' or 'false'

+ +
width
+

a character

+ + +

AnalyticSnapshot

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
groupColumn
+

a character

+ +
mappings
+

a AnalyticSnapshotMapping

+ +
name
+

a character

+ +
runningUser
+

a character

+ +
sourceReport
+

a character

+ +
targetObject
+

a character

+ + +

AnalyticSnapshotMapping

+
aggregateType
+

a ReportSummaryType - which is a character taking one of the following values:

  • Sum

  • Average

  • Maximum

  • Minimum

  • None

    • -

-
sourceField

a character

-
sourceType

a ReportJobSourceTypes - which is a character taking one of the following values: -

    -

  • tabular

    • +
+ +
sourceField
+

a character

+ +
sourceType
+

a ReportJobSourceTypes - which is a character taking one of the following values:

  • tabular

  • summary

  • snapshot

    • -

-
targetField

a character

- -
- -

ApexClass

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
apiVersion

a numeric

-
packageVersions

a PackageVersion

-
status

a ApexCodeUnitStatus - which is a character taking one of the following values: -

    -

  • Inactive

    • +
+ +
targetField
+

a character

+ + +

ApexClass

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
apiVersion
+

a numeric

+ +
packageVersions
+

a PackageVersion

+ +
status
+

a ApexCodeUnitStatus - which is a character taking one of the following values:

  • Inactive

  • Active

  • Deleted

    • -

- -
- -

ApexComponent

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
apiVersion

a numeric

-
description

a character

-
label

a character

-
packageVersions

a PackageVersion

- -
- -

ApexPage

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
apiVersion

a numeric

-
availableInTouch

a character either 'true' or 'false'

-
confirmationTokenRequired

a character either 'true' or 'false'

-
description

a character

-
label

a character

-
packageVersions

a PackageVersion

- -
- -

ApexTestSuite

-
-
fullName

a character (inherited from Metadata)

-
testClassName

a character

- -
- -

ApexTrigger

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
apiVersion

a numeric

-
packageVersions

a PackageVersion

-
status

a ApexCodeUnitStatus - which is a character taking one of the following values: -

    -

  • Inactive

    • +
+ + +

ApexComponent

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
apiVersion
+

a numeric

+ +
description
+

a character

+ +
label
+

a character

+ +
packageVersions
+

a PackageVersion

+ + +

ApexPage

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
apiVersion
+

a numeric

+ +
availableInTouch
+

a character either 'true' or 'false'

+ +
confirmationTokenRequired
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
label
+

a character

+ +
packageVersions
+

a PackageVersion

+ + +

ApexTestSuite

+
fullName
+

a character (inherited from Metadata)

+ +
testClassName
+

a character

+ + +

ApexTrigger

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
apiVersion
+

a numeric

+ +
packageVersions
+

a PackageVersion

+ +
status
+

a ApexCodeUnitStatus - which is a character taking one of the following values:

  • Inactive

  • Active

  • Deleted

    • -

- -
- -

AppActionOverride

-
-
actionName

a character (inherited from ActionOverride)

-
comment

a character (inherited from ActionOverride)

-
content

a character (inherited from ActionOverride)

-
formFactor

a FormFactor (inherited from ActionOverride)

-
skipRecordTypeSelect

a character either 'true' or 'false' (inherited from ActionOverride)

-
type

a ActionOverrideType (inherited from ActionOverride)

-
pageOrSobjectType

a character

- -
- -

AppBrand

-
-
footerColor

a character

-
headerColor

a character

-
logo

a character

-
logoVersion

an integer

-
shouldOverrideOrgTheme

a character either 'true' or 'false'

- -
- -

AppComponentList

-
-
alignment

a character

-
components

a character

- -
- -

AppMenu

-
-
fullName

a character (inherited from Metadata)

-
appMenuItems

a AppMenuItem

- -
- -

AppMenuItem

-
-
name

a character

-
type

a character

- -
- -

AppPreferences

-
-
enableCustomizeMyTabs

a character either 'true' or 'false'

-
enableKeyboardShortcuts

a character either 'true' or 'false'

-
enableListViewHover

a character either 'true' or 'false'

-
enableListViewReskin

a character either 'true' or 'false'

-
enableMultiMonitorComponents

a character either 'true' or 'false'

-
enablePinTabs

a character either 'true' or 'false'

-
enableTabHover

a character either 'true' or 'false'

-
enableTabLimits

a character either 'true' or 'false'

-
saveUserSessions

a character either 'true' or 'false'

- -
- -

AppProfileActionOverride

-
-
actionName

a character (inherited from ProfileActionOverride)

-
content

a character (inherited from ProfileActionOverride)

-
formFactor

a FormFactor (inherited from ProfileActionOverride)

-
pageOrSobjectType

a character (inherited from ProfileActionOverride)

-
recordType

a character (inherited from ProfileActionOverride)

-
type

a ActionOverrideType (inherited from ProfileActionOverride)

-
profile

a character

- -
- -

ApprovalAction

-
-
action

a WorkflowActionReference

- -
- -

ApprovalEntryCriteria

-
-
booleanFilter

a character

-
criteriaItems

a FilterItem

-
formula

a character

- -
- -

ApprovalPageField

-
-
field

a character

- -
- -

ApprovalProcess

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
allowRecall

a character either 'true' or 'false'

-
allowedSubmitters

a ApprovalSubmitter

-
approvalPageFields

a ApprovalPageField

-
approvalStep

a ApprovalStep

-
description

a character

-
emailTemplate

a character

-
enableMobileDeviceAccess

a character either 'true' or 'false'

-
entryCriteria

a ApprovalEntryCriteria

-
finalApprovalActions

a ApprovalAction

-
finalApprovalRecordLock

a character either 'true' or 'false'

-
finalRejectionActions

a ApprovalAction

-
finalRejectionRecordLock

a character either 'true' or 'false'

-
initialSubmissionActions

a ApprovalAction

-
label

a character

-
nextAutomatedApprover

a NextAutomatedApprover

-
postTemplate

a character

-
recallActions

a ApprovalAction

-
recordEditability

a RecordEditabilityType - which is a character taking one of the following values: -

    -

  • AdminOnly

    • +
+ + +

AppActionOverride

+
actionName
+

a character (inherited from ActionOverride)

+ +
comment
+

a character (inherited from ActionOverride)

+ +
content
+

a character (inherited from ActionOverride)

+ +
formFactor
+

a FormFactor (inherited from ActionOverride)

+ +
skipRecordTypeSelect
+

a character either 'true' or 'false' (inherited from ActionOverride)

+ +
type
+

a ActionOverrideType (inherited from ActionOverride)

+ +
pageOrSobjectType
+

a character

+ + +

AppBrand

+
footerColor
+

a character

+ +
headerColor
+

a character

+ +
logo
+

a character

+ +
logoVersion
+

an integer

+ +
shouldOverrideOrgTheme
+

a character either 'true' or 'false'

+ + +

AppComponentList

+
alignment
+

a character

+ +
components
+

a character

+ + +

AppMenu

+
fullName
+

a character (inherited from Metadata)

+ +
appMenuItems
+

a AppMenuItem

+ + +

AppMenuItem

+
name
+

a character

+ +
type
+

a character

+ + +

AppPreferences

+
enableCustomizeMyTabs
+

a character either 'true' or 'false'

+ +
enableKeyboardShortcuts
+

a character either 'true' or 'false'

+ +
enableListViewHover
+

a character either 'true' or 'false'

+ +
enableListViewReskin
+

a character either 'true' or 'false'

+ +
enableMultiMonitorComponents
+

a character either 'true' or 'false'

+ +
enablePinTabs
+

a character either 'true' or 'false'

+ +
enableTabHover
+

a character either 'true' or 'false'

+ +
enableTabLimits
+

a character either 'true' or 'false'

+ +
saveUserSessions
+

a character either 'true' or 'false'

+ + +

AppProfileActionOverride

+
actionName
+

a character (inherited from ProfileActionOverride)

+ +
content
+

a character (inherited from ProfileActionOverride)

+ +
formFactor
+

a FormFactor (inherited from ProfileActionOverride)

+ +
pageOrSobjectType
+

a character (inherited from ProfileActionOverride)

+ +
recordType
+

a character (inherited from ProfileActionOverride)

+ +
type
+

a ActionOverrideType (inherited from ProfileActionOverride)

+ +
profile
+

a character

+ + +

ApprovalAction

+
action
+

a WorkflowActionReference

+ + +

ApprovalEntryCriteria

+
booleanFilter
+

a character

+ +
criteriaItems
+

a FilterItem

+ +
formula
+

a character

+ + +

ApprovalPageField

+
field
+

a character

+ + +

ApprovalProcess

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
allowRecall
+

a character either 'true' or 'false'

+ +
allowedSubmitters
+

a ApprovalSubmitter

+ +
approvalPageFields
+

a ApprovalPageField

+ +
approvalStep
+

a ApprovalStep

+ +
description
+

a character

+ +
emailTemplate
+

a character

+ +
enableMobileDeviceAccess
+

a character either 'true' or 'false'

+ +
entryCriteria
+

a ApprovalEntryCriteria

+ +
finalApprovalActions
+

a ApprovalAction

+ +
finalApprovalRecordLock
+

a character either 'true' or 'false'

+ +
finalRejectionActions
+

a ApprovalAction

+ +
finalRejectionRecordLock
+

a character either 'true' or 'false'

+ +
initialSubmissionActions
+

a ApprovalAction

+ +
label
+

a character

+ +
nextAutomatedApprover
+

a NextAutomatedApprover

+ +
postTemplate
+

a character

+ +
recallActions
+

a ApprovalAction

+ +
recordEditability
+

a RecordEditabilityType - which is a character taking one of the following values:

  • AdminOnly

  • AdminOrCurrentApprover

    • -

-
showApprovalHistory

a character either 'true' or 'false'

- -
- -

ApprovalStep

-
-
allowDelegate

a character either 'true' or 'false'

-
approvalActions

a ApprovalAction

-
assignedApprover

a ApprovalStepApprover

-
description

a character

-
entryCriteria

a ApprovalEntryCriteria

-
ifCriteriaNotMet

a StepCriteriaNotMetType - which is a character taking one of the following values: -

    -

  • ApproveRecord

    • +
+ +
showApprovalHistory
+

a character either 'true' or 'false'

+ + +

ApprovalStep

+
allowDelegate
+

a character either 'true' or 'false'

+ +
approvalActions
+

a ApprovalAction

+ +
assignedApprover
+

a ApprovalStepApprover

+ +
description
+

a character

+ +
entryCriteria
+

a ApprovalEntryCriteria

+ +
ifCriteriaNotMet
+

a StepCriteriaNotMetType - which is a character taking one of the following values:

  • ApproveRecord

  • RejectRecord

  • GotoNextStep

    • -

-
label

a character

-
name

a character

-
rejectBehavior

a ApprovalStepRejectBehavior

-
rejectionActions

a ApprovalAction

- -
- -

ApprovalStepApprover

-
-
approver

a Approver

-
whenMultipleApprovers

a RoutingType - which is a character taking one of the following values: -

    -

  • Unanimous

    • +
+ +
label
+

a character

+ +
name
+

a character

+ +
rejectBehavior
+

a ApprovalStepRejectBehavior

+ +
rejectionActions
+

a ApprovalAction

+ + +

ApprovalStepApprover

+
approver
+

a Approver

+ +
whenMultipleApprovers
+

a RoutingType - which is a character taking one of the following values:

  • Unanimous

  • FirstResponse

    • -

+ -
-

ApprovalStepRejectBehavior

-
-
type

a StepRejectBehaviorType - which is a character taking one of the following values: -

    -

  • RejectRequest

    • +

ApprovalStepRejectBehavior

+
type
+

a StepRejectBehaviorType - which is a character taking one of the following values:

  • RejectRequest

  • BackToPrevious

    • -

+ + -
+

ApprovalSubmitter

+
submitter
+

a character

-

ApprovalSubmitter

-
-
submitter

a character

-
type

a ProcessSubmitterType - which is a character taking one of the following values: -

    -

  • group

    • +
    type
    +

    a ProcessSubmitterType - which is a character taking one of the following values:

    • group

    • role

    • user

    • roleSubordinates

      • @@ -676,137 +820,199 @@

      Details

    • portalRole

    • portalRoleSubordinates

    • allInternalUsers

      • -

    +
-
-

Approver

-
-
name

a character

-
type

a NextOwnerType - which is a character taking one of the following values: -

    -

  • adhoc

    • +

Approver

+
name
+

a character

+ +
type
+

a NextOwnerType - which is a character taking one of the following values:

  • adhoc

  • user

  • userHierarchyField

  • relatedUserField

  • queue

    • -

+ -
-

AppWorkspaceConfig

-
-
mappings

a WorkspaceMapping

+

AppWorkspaceConfig

+
mappings
+

a WorkspaceMapping

-
-

ArticleTypeChannelDisplay

-
-
articleTypeTemplates

a ArticleTypeTemplate

+

ArticleTypeChannelDisplay

+
articleTypeTemplates
+

a ArticleTypeTemplate

-
-

ArticleTypeTemplate

-
-
channel

a Channel - which is a character taking one of the following values: -

    -

  • AllChannels

    • +

ArticleTypeTemplate

+
channel
+

a Channel - which is a character taking one of the following values:

  • AllChannels

  • App

  • Pkb

  • Csp

  • Prm

    • -

-
page

a character

-
template

a Template - which is a character taking one of the following values: -

    -

  • Page

    • +
+ +
page
+

a character

+ +
template
+

a Template - which is a character taking one of the following values:

  • Page

  • Tab

  • Toc

    • -

- -
- -

AssignmentRule

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
ruleEntry

a RuleEntry

- -
- -

AssignmentRules

-
-
fullName

a character (inherited from Metadata)

-
assignmentRule

a AssignmentRule

- -
- -

AssistantRecommendationType

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
masterLabel

a character

-
platformActionlist

a PlatformActionList

-
sobjectType

a character

-
title

a character

- -
- -

Attachment

-
-
content

a character formed using base64encode

-
name

a character

- -
- -

AuraDefinitionBundle

-
-
fullName

a character (inherited from Metadata)

-
SVGContent

a character formed using base64encode

-
apiVersion

a numeric

-
controllerContent

a character formed using base64encode

-
description

a character

-
designContent

a character formed using base64encode

-
documentationContent

a character formed using base64encode

-
helperContent

a character formed using base64encode

-
markup

a character formed using base64encode

-
modelContent

a character formed using base64encode

-
packageVersions

a PackageVersion

-
rendererContent

a character formed using base64encode

-
styleContent

a character formed using base64encode

-
testsuiteContent

a character formed using base64encode

-
type

a AuraBundleType - which is a character taking one of the following values: -

    -

  • Application

    • -

  • Component

    • -

  • Event

    • -

  • Interface

    • -

  • Tokens

    • -

- -
- -

AuthProvider

-
-
fullName

a character (inherited from Metadata)

-
authorizeUrl

a character

-
consumerKey

a character

-
consumerSecret

a character

-
customMetadataTypeRecord

a character

-
defaultScopes

a character

-
errorUrl

a character

-
executionUser

a character

-
friendlyName

a character

-
iconUrl

a character

-
idTokenIssuer

a character

-
includeOrgIdInIdentifier

a character either 'true' or 'false'

-
logoutUrl

a character

-
plugin

a character

-
portal

a character

-
providerType

a AuthProviderType - which is a character taking one of the following values: -

    -

  • Facebook

    • -

  • Janrain

    • +
+ + +

AssignmentRule

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
ruleEntry
+

a RuleEntry

+ + +

AssignmentRules

+
fullName
+

a character (inherited from Metadata)

+ +
assignmentRule
+

a AssignmentRule

+ + +

AssistantRecommendationType

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
masterLabel
+

a character

+ +
platformActionlist
+

a PlatformActionList

+ +
sobjectType
+

a character

+ +
title
+

a character

+ + +

Attachment

+
content
+

a character formed using base64encode

+ +
name
+

a character

+ + +

AuraDefinitionBundle

+
fullName
+

a character (inherited from Metadata)

+ +
SVGContent
+

a character formed using base64encode

+ +
apiVersion
+

a numeric

+ +
controllerContent
+

a character formed using base64encode

+ +
description
+

a character

+ +
designContent
+

a character formed using base64encode

+ +
documentationContent
+

a character formed using base64encode

+ +
helperContent
+

a character formed using base64encode

+ +
markup
+

a character formed using base64encode

+ +
modelContent
+

a character formed using base64encode

+ +
packageVersions
+

a PackageVersion

+ +
rendererContent
+

a character formed using base64encode

+ +
styleContent
+

a character formed using base64encode

+ +
testsuiteContent
+

a character formed using base64encode

+ +
type
+

a AuraBundleType - which is a character taking one of the following values:

  • Application

    • +

  • Component

    • +

  • Event

    • +

  • Interface

    • +

  • Tokens

    • +
+ + +

AuthProvider

+
fullName
+

a character (inherited from Metadata)

+ +
authorizeUrl
+

a character

+ +
consumerKey
+

a character

+ +
consumerSecret
+

a character

+ +
customMetadataTypeRecord
+

a character

+ +
defaultScopes
+

a character

+ +
errorUrl
+

a character

+ +
executionUser
+

a character

+ +
friendlyName
+

a character

+ +
iconUrl
+

a character

+ +
idTokenIssuer
+

a character

+ +
includeOrgIdInIdentifier
+

a character either 'true' or 'false'

+ +
logoutUrl
+

a character

+ +
plugin
+

a character

+ +
portal
+

a character

+ +
providerType
+

a AuthProviderType - which is a character taking one of the following values:

  • Facebook

    • +

  • Janrain

  • Salesforce

  • OpenIdConnect

  • MicrosoftACS

    • @@ -815,173 +1021,330 @@

    Details

  • Google

  • GitHub

  • Custom

    • -

-
registrationHandler

a character

-
sendAccessTokenInHeader

a character either 'true' or 'false'

-
sendClientCredentialsInHeader

a character either 'true' or 'false'

-
tokenUrl

a character

-
userInfoUrl

a character

- -
- -

AutoResponseRule

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
ruleEntry

a RuleEntry

- -
- -

AutoResponseRules

-
-
fullName

a character (inherited from Metadata)

-
autoResponseRule

a AutoResponseRule

- -
- -

BrandingSet

-
-
fullName

a character (inherited from Metadata)

-
brandingSetProperty

a BrandingSetProperty

-
description

a character

-
masterLabel

a character

-
type

a character

- -
- -

BrandingSetProperty

-
-
propertyName

a character

-
propertyValue

a character

- -
- -

BusinessHoursEntry

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
default

a character either 'true' or 'false'

-
fridayEndTime

a character formatted as 'hh:mm:ssZ

-
fridayStartTime

a character formatted as 'hh:mm:ssZ

-
mondayEndTime

a character formatted as 'hh:mm:ssZ

-
mondayStartTime

a character formatted as 'hh:mm:ssZ

-
name

a character

-
saturdayEndTime

a character formatted as 'hh:mm:ssZ

-
saturdayStartTime

a character formatted as 'hh:mm:ssZ

-
sundayEndTime

a character formatted as 'hh:mm:ssZ

-
sundayStartTime

a character formatted as 'hh:mm:ssZ

-
thursdayEndTime

a character formatted as 'hh:mm:ssZ

-
thursdayStartTime

a character formatted as 'hh:mm:ssZ

-
timeZoneId

a character

-
tuesdayEndTime

a character formatted as 'hh:mm:ssZ

-
tuesdayStartTime

a character formatted as 'hh:mm:ssZ

-
wednesdayEndTime

a character formatted as 'hh:mm:ssZ

-
wednesdayStartTime

a character formatted as 'hh:mm:ssZ

- -
- -

BusinessHoursSettings

-
-
fullName

a character (inherited from Metadata)

-
businessHours

a BusinessHoursEntry

-
holidays

a Holiday

- -
- -

BusinessProcess

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
isActive

a character either 'true' or 'false'

-
values

a PicklistValue

- -
- -

CallCenter

-
-
fullName

a character (inherited from Metadata)

-
adapterUrl

a character

-
customSettings

a character

-
displayName

a character

-
displayNameLabel

a character

-
internalNameLabel

a character

-
sections

a CallCenterSection

-
version

a character

- -
- -

CallCenterItem

-
-
label

a character

-
name

a character

-
value

a character

- -
- -

CallCenterSection

-
-
items

a CallCenterItem

-
label

a character

-
name

a character

- -
- -

CampaignInfluenceModel

-
-
fullName

a character (inherited from Metadata)

-
isActive

a character either 'true' or 'false'

-
isDefaultModel

a character either 'true' or 'false'

-
isModelLocked

a character either 'true' or 'false'

-
modelDescription

a character

-
name

a character

-
recordPreference

a character

- -
- -

CaseSettings

-
-
fullName

a character (inherited from Metadata)

-
caseAssignNotificationTemplate

a character

-
caseCloseNotificationTemplate

a character

-
caseCommentNotificationTemplate

a character

-
caseCreateNotificationTemplate

a character

-
caseFeedItemSettings

a FeedItemSettings

-
closeCaseThroughStatusChange

a character either 'true' or 'false'

-
defaultCaseOwner

a character

-
defaultCaseOwnerType

a character

-
defaultCaseUser

a character

-
emailActionDefaultsHandlerClass

a character

-
emailToCase

a EmailToCaseSettings

-
enableCaseFeed

a character either 'true' or 'false'

-
enableDraftEmails

a character either 'true' or 'false'

-
enableEarlyEscalationRuleTriggers

a character either 'true' or 'false'

-
enableEmailActionDefaultsHandler

a character either 'true' or 'false'

-
enableSuggestedArticlesApplication

a character either 'true' or 'false'

-
enableSuggestedArticlesCustomerPortal

a character either 'true' or 'false'

-
enableSuggestedArticlesPartnerPortal

a character either 'true' or 'false'

-
enableSuggestedSolutions

a character either 'true' or 'false'

-
keepRecordTypeOnAssignmentRule

a character either 'true' or 'false'

-
notifyContactOnCaseComment

a character either 'true' or 'false'

-
notifyDefaultCaseOwner

a character either 'true' or 'false'

-
notifyOwnerOnCaseComment

a character either 'true' or 'false'

-
notifyOwnerOnCaseOwnerChange

a character either 'true' or 'false'

-
showEmailAttachmentsInCaseAttachmentsRL

a character either 'true' or 'false'

-
showFewerCloseActions

a character either 'true' or 'false'

-
systemUserEmail

a character

-
useSystemEmailAddress

a character either 'true' or 'false'

-
useSystemUserAsDefaultCaseUser

a character either 'true' or 'false'

-
webToCase

a WebToCaseSettings

- -
- -

CaseSubjectParticle

-
-
fullName

a character (inherited from Metadata)

-
index

an integer

-
textField

a character

-
type

a CaseSubjectParticleType - which is a character taking one of the following values: -

    -

  • ProvidedString

    • +
+ +
registrationHandler
+

a character

+ +
sendAccessTokenInHeader
+

a character either 'true' or 'false'

+ +
sendClientCredentialsInHeader
+

a character either 'true' or 'false'

+ +
tokenUrl
+

a character

+ +
userInfoUrl
+

a character

+ + +

AutoResponseRule

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
ruleEntry
+

a RuleEntry

+ + +

AutoResponseRules

+
fullName
+

a character (inherited from Metadata)

+ +
autoResponseRule
+

a AutoResponseRule

+ + +

BrandingSet

+
fullName
+

a character (inherited from Metadata)

+ +
brandingSetProperty
+

a BrandingSetProperty

+ +
description
+

a character

+ +
masterLabel
+

a character

+ +
type
+

a character

+ + +

BrandingSetProperty

+
propertyName
+

a character

+ +
propertyValue
+

a character

+ + +

BusinessHoursEntry

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
default
+

a character either 'true' or 'false'

+ +
fridayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
fridayStartTime
+

a character formatted as 'hh:mm:ssZ

+ +
mondayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
mondayStartTime
+

a character formatted as 'hh:mm:ssZ

+ +
name
+

a character

+ +
saturdayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
saturdayStartTime
+

a character formatted as 'hh:mm:ssZ

+ +
sundayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
sundayStartTime
+

a character formatted as 'hh:mm:ssZ

+ +
thursdayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
thursdayStartTime
+

a character formatted as 'hh:mm:ssZ

+ +
timeZoneId
+

a character

+ +
tuesdayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
tuesdayStartTime
+

a character formatted as 'hh:mm:ssZ

+ +
wednesdayEndTime
+

a character formatted as 'hh:mm:ssZ

+ +
wednesdayStartTime
+

a character formatted as 'hh:mm:ssZ

+ + +

BusinessHoursSettings

+
fullName
+

a character (inherited from Metadata)

+ +
businessHours
+

a BusinessHoursEntry

+ +
holidays
+

a Holiday

+ + +

BusinessProcess

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
isActive
+

a character either 'true' or 'false'

+ +
values
+

a PicklistValue

+ + +

CallCenter

+
fullName
+

a character (inherited from Metadata)

+ +
adapterUrl
+

a character

+ +
customSettings
+

a character

+ +
displayName
+

a character

+ +
displayNameLabel
+

a character

+ +
internalNameLabel
+

a character

+ +
sections
+

a CallCenterSection

+ +
version
+

a character

+ + +

CallCenterItem

+
label
+

a character

+ +
name
+

a character

+ +
value
+

a character

+ + +

CallCenterSection

+
items
+

a CallCenterItem

+ +
label
+

a character

+ +
name
+

a character

+ + +

CampaignInfluenceModel

+
fullName
+

a character (inherited from Metadata)

+ +
isActive
+

a character either 'true' or 'false'

+ +
isDefaultModel
+

a character either 'true' or 'false'

+ +
isModelLocked
+

a character either 'true' or 'false'

+ +
modelDescription
+

a character

+ +
name
+

a character

+ +
recordPreference
+

a character

+ + +

CaseSettings

+
fullName
+

a character (inherited from Metadata)

+ +
caseAssignNotificationTemplate
+

a character

+ +
caseCloseNotificationTemplate
+

a character

+ +
caseCommentNotificationTemplate
+

a character

+ +
caseCreateNotificationTemplate
+

a character

+ +
caseFeedItemSettings
+

a FeedItemSettings

+ +
closeCaseThroughStatusChange
+

a character either 'true' or 'false'

+ +
defaultCaseOwner
+

a character

+ +
defaultCaseOwnerType
+

a character

+ +
defaultCaseUser
+

a character

+ +
emailActionDefaultsHandlerClass
+

a character

+ +
emailToCase
+

a EmailToCaseSettings

+ +
enableCaseFeed
+

a character either 'true' or 'false'

+ +
enableDraftEmails
+

a character either 'true' or 'false'

+ +
enableEarlyEscalationRuleTriggers
+

a character either 'true' or 'false'

+ +
enableEmailActionDefaultsHandler
+

a character either 'true' or 'false'

+ +
enableSuggestedArticlesApplication
+

a character either 'true' or 'false'

+ +
enableSuggestedArticlesCustomerPortal
+

a character either 'true' or 'false'

+ +
enableSuggestedArticlesPartnerPortal
+

a character either 'true' or 'false'

+ +
enableSuggestedSolutions
+

a character either 'true' or 'false'

+ +
keepRecordTypeOnAssignmentRule
+

a character either 'true' or 'false'

+ +
notifyContactOnCaseComment
+

a character either 'true' or 'false'

+ +
notifyDefaultCaseOwner
+

a character either 'true' or 'false'

+ +
notifyOwnerOnCaseComment
+

a character either 'true' or 'false'

+ +
notifyOwnerOnCaseOwnerChange
+

a character either 'true' or 'false'

+ +
showEmailAttachmentsInCaseAttachmentsRL
+

a character either 'true' or 'false'

+ +
showFewerCloseActions
+

a character either 'true' or 'false'

+ +
systemUserEmail
+

a character

+ +
useSystemEmailAddress
+

a character either 'true' or 'false'

+ +
useSystemUserAsDefaultCaseUser
+

a character either 'true' or 'false'

+ +
webToCase
+

a WebToCaseSettings

+ + +

CaseSubjectParticle

+
fullName
+

a character (inherited from Metadata)

+ +
index
+

an integer

+ +
textField
+

a character

+ +
type
+

a CaseSubjectParticleType - which is a character taking one of the following values:

  • ProvidedString

  • Source

  • MessageType

  • SocialHandle

    • @@ -992,399 +1355,614 @@

    Details

  • PipeSeparator

  • ColonSeparator

  • HyphenSeparator

    • -

- -
- -

Certificate

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
caSigned

a character either 'true' or 'false'

-
encryptedWithPlatformEncryption

a character either 'true' or 'false'

-
expirationDate

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

-
keySize

an integer

-
masterLabel

a character

-
privateKeyExportable

a character either 'true' or 'false'

- -
- -

ChannelLayout

-
-
fullName

a character (inherited from Metadata)

-
enabledChannels

a character

-
label

a character

-
layoutItems

a ChannelLayoutItem

-
recordType

a character

- -
- -

ChannelLayoutItem

-
-
field

a character

- -
- -

ChartSummary

-
-
aggregate

a ReportSummaryType - which is a character taking one of the following values: -

    -

  • Sum

    • +
+ + +

Certificate

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
caSigned
+

a character either 'true' or 'false'

+ +
encryptedWithPlatformEncryption
+

a character either 'true' or 'false'

+ +
expirationDate
+

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

+ +
keySize
+

an integer

+ +
masterLabel
+

a character

+ +
privateKeyExportable
+

a character either 'true' or 'false'

+ + +

ChannelLayout

+
fullName
+

a character (inherited from Metadata)

+ +
enabledChannels
+

a character

+ +
label
+

a character

+ +
layoutItems
+

a ChannelLayoutItem

+ +
recordType
+

a character

+ + +

ChannelLayoutItem

+
field
+

a character

+ + +

ChartSummary

+
aggregate
+

a ReportSummaryType - which is a character taking one of the following values:

  • Sum

  • Average

  • Maximum

  • Minimum

  • None

    • -

-
axisBinding

a ChartAxis - which is a character taking one of the following values: -

    -

  • x

    • +
+ +
axisBinding
+

a ChartAxis - which is a character taking one of the following values:

  • x

  • y

  • y2

  • r

    • -

-
column

a character

- -
- -

ChatterAnswersReputationLevel

-
-
name

a character

-
value

an integer

- -
- -

ChatterAnswersSettings

-
-
fullName

a character (inherited from Metadata)

-
emailFollowersOnBestAnswer

a character either 'true' or 'false'

-
emailFollowersOnReply

a character either 'true' or 'false'

-
emailOwnerOnPrivateReply

a character either 'true' or 'false'

-
emailOwnerOnReply

a character either 'true' or 'false'

-
enableAnswerViaEmail

a character either 'true' or 'false'

-
enableChatterAnswers

a character either 'true' or 'false'

-
enableFacebookSSO

a character either 'true' or 'false'

-
enableInlinePublisher

a character either 'true' or 'false'

-
enableReputation

a character either 'true' or 'false'

-
enableRichTextEditor

a character either 'true' or 'false'

-
facebookAuthProvider

a character

-
showInPortals

a character either 'true' or 'false'

- -
- -

ChatterExtension

-
-
fullName

a character (inherited from Metadata)

-
compositionComponent

a character

-
description

a character

-
extensionName

a character

-
headerText

a character

-
hoverText

a character

-
icon

a character

-
isProtected

a character either 'true' or 'false'

-
masterLabel

a character

-
renderComponent

a character

-
type

a ChatterExtensionType - which is a character taking one of the following values: -

    -

  • Lightning

    • -

- -
- -

ChatterMobileSettings

-
-
enablePushNotifications

a character either 'true' or 'false'

- -
- -

CleanDataService

-
-
fullName

a character (inherited from Metadata)

-
cleanRules

a CleanRule

-
description

a character

-
masterLabel

a character

-
matchEngine

a character

- -
- -

CleanRule

-
-
bulkEnabled

a character either 'true' or 'false'

-
bypassTriggers

a character either 'true' or 'false'

-
bypassWorkflow

a character either 'true' or 'false'

-
description

a character

-
developerName

a character

-
fieldMappings

a FieldMapping

-
masterLabel

a character

-
matchRule

a character

-
sourceSobjectType

a character

-
status

a CleanRuleStatus - which is a character taking one of the following values: -

    -

  • Inactive

    • +
+ +
column
+

a character

+ + +

ChatterAnswersReputationLevel

+
name
+

a character

+ +
value
+

an integer

+ + +

ChatterAnswersSettings

+
fullName
+

a character (inherited from Metadata)

+ +
emailFollowersOnBestAnswer
+

a character either 'true' or 'false'

+ +
emailFollowersOnReply
+

a character either 'true' or 'false'

+ +
emailOwnerOnPrivateReply
+

a character either 'true' or 'false'

+ +
emailOwnerOnReply
+

a character either 'true' or 'false'

+ +
enableAnswerViaEmail
+

a character either 'true' or 'false'

+ +
enableChatterAnswers
+

a character either 'true' or 'false'

+ +
enableFacebookSSO
+

a character either 'true' or 'false'

+ +
enableInlinePublisher
+

a character either 'true' or 'false'

+ +
enableReputation
+

a character either 'true' or 'false'

+ +
enableRichTextEditor
+

a character either 'true' or 'false'

+ +
facebookAuthProvider
+

a character

+ +
showInPortals
+

a character either 'true' or 'false'

+ + +

ChatterExtension

+
fullName
+

a character (inherited from Metadata)

+ +
compositionComponent
+

a character

+ +
description
+

a character

+ +
extensionName
+

a character

+ +
headerText
+

a character

+ +
hoverText
+

a character

+ +
icon
+

a character

+ +
isProtected
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
renderComponent
+

a character

+ +
type
+

a ChatterExtensionType - which is a character taking one of the following values:

  • Lightning

    • +
+ + +

ChatterMobileSettings

+
enablePushNotifications
+

a character either 'true' or 'false'

+ + +

CleanDataService

+
fullName
+

a character (inherited from Metadata)

+ +
cleanRules
+

a CleanRule

+ +
description
+

a character

+ +
masterLabel
+

a character

+ +
matchEngine
+

a character

+ + +

CleanRule

+
bulkEnabled
+

a character either 'true' or 'false'

+ +
bypassTriggers
+

a character either 'true' or 'false'

+ +
bypassWorkflow
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
developerName
+

a character

+ +
fieldMappings
+

a FieldMapping

+ +
masterLabel
+

a character

+ +
matchRule
+

a character

+ +
sourceSobjectType
+

a character

+ +
status
+

a CleanRuleStatus - which is a character taking one of the following values:

  • Inactive

  • Active

    • -

-
targetSobjectType

a character

- -
- -

CodeLocation

-
-
column

an integer

-
line

an integer

-
numExecutions

an integer

-
time

a numeric

- -
- -

Community

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
chatterAnswersFacebookSsoUrl

a character

-
communityFeedPage

a character

-
dataCategoryName

a character

-
description

a character

-
emailFooterDocument

a character

-
emailHeaderDocument

a character

-
emailNotificationUrl

a character

-
enableChatterAnswers

a character either 'true' or 'false'

-
enablePrivateQuestions

a character either 'true' or 'false'

-
expertsGroup

a character

-
portal

a character

-
reputationLevels

a ReputationLevels

-
showInPortal

a character either 'true' or 'false'

-
site

a character

- -
- -

CommunityCustomThemeLayoutType

-
-
description

a character

-
label

a character

- -
- -

CommunityRoles

-
-
customerUserRole

a character

-
employeeUserRole

a character

-
partnerUserRole

a character

- -
- -

CommunityTemplateBundleInfo

-
-
description

a character

-
image

a character

-
order

an integer

-
title

a character

-
type

a CommunityTemplateBundleInfoType - which is a character taking one of the following values: -

    -

  • Highlight

    • -

  • PreviewImage

    • -

- -
- -

CommunityTemplateDefinition

-
-
fullName

a character (inherited from Metadata)

-
baseTemplate

a CommunityBaseTemplate - which is a character taking one of the following values: -

    -

  • c

    • -

-
bundlesInfo

a CommunityTemplateBundleInfo

-
category

a CommunityTemplateCategory - which is a character taking one of the following values: -

    -

  • IT

    • -

  • Marketing

    • -

  • Sales

    • -

  • Service

    • -

-
defaultBrandingSet

a character

-
defaultThemeDefinition

a character

-
description

a character

-
enableExtendedCleanUpOnDelete

a character either 'true' or 'false'

-
masterLabel

a character

-
navigationLinkSet

a NavigationLinkSet

-
pageSetting

a CommunityTemplatePageSetting

- -
- -

CommunityTemplatePageSetting

-
-
page

a character

-
themeLayout

a character

- -
- -

CommunityThemeDefinition

-
-
fullName

a character (inherited from Metadata)

-
customThemeLayoutType

a CommunityCustomThemeLayoutType

-
description

a character

-
enableExtendedCleanUpOnDelete

a character either 'true' or 'false'

-
masterLabel

a character

-
themeSetting

a CommunityThemeSetting

- -
- -

CommunityThemeSetting

-
-
customThemeLayoutType

a character

-
themeLayout

a character

-
themeLayoutType

a CommunityThemeLayoutType - which is a character taking one of the following values: -

    -

  • Login

    • -

  • Home

    • -

  • Inner

    • -

- -
- -

CompactLayout

-
-
fullName

a character (inherited from Metadata)

-
fields

a character

-
label

a character

- -
- -

CompanySettings

-
-
fullName

a character (inherited from Metadata)

-
fiscalYear

a FiscalYearSettings

- -
- -

ComponentInstance

-
-
componentInstanceProperties

a ComponentInstanceProperty

-
componentName

a character

-
visibilityRule

a UiFormulaRule

- -
- -

ComponentInstanceProperty

-
-
name

a character

-
type

a ComponentInstancePropertyTypeEnum - which is a character taking one of the following values: -

    -

  • decorator

    • -

-
value

a character

- -
- -

ConnectedApp

-
-
fullName

a character (inherited from Metadata)

-
attributes

a ConnectedAppAttribute

-
canvasConfig

a ConnectedAppCanvasConfig

-
contactEmail

a character

-
contactPhone

a character

-
description

a character

-
iconUrl

a character

-
infoUrl

a character

-
ipRanges

a ConnectedAppIpRange

-
label

a character

-
logoUrl

a character

-
mobileAppConfig

a ConnectedAppMobileDetailConfig

-
mobileStartUrl

a character

-
oauthConfig

a ConnectedAppOauthConfig

-
plugin

a character

-
samlConfig

a ConnectedAppSamlConfig

-
startUrl

a character

- -
- -

ConnectedAppAttribute

-
-
formula

a character

-
key

a character

- -
- -

ConnectedAppCanvasConfig

-
-
accessMethod

a AccessMethod - which is a character taking one of the following values: -

    -

  • Get

    • -

  • Post

    • -

-
canvasUrl

a character

-
lifecycleClass

a character

-
locations

a CanvasLocationOptions - which is a character taking one of the following values: -

    -

  • None

    • -

  • Chatter

    • -

  • UserProfile

    • -

  • Visualforce

    • -

  • Aura

    • -

  • Publisher

    • -

  • ChatterFeed

    • -

  • ServiceDesk

    • -

  • OpenCTI

    • -

  • AppLauncher

    • -

  • MobileNav

    • -

  • PageLayout

    • -

-
options

a CanvasOptions - which is a character taking one of the following values: -

    -

  • HideShare

    • +
+ +
targetSobjectType
+

a character

+ + +

CodeLocation

+
column
+

an integer

+ +
line
+

an integer

+ +
numExecutions
+

an integer

+ +
time
+

a numeric

+ + +

Community

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
chatterAnswersFacebookSsoUrl
+

a character

+ +
communityFeedPage
+

a character

+ +
dataCategoryName
+

a character

+ +
description
+

a character

+ +
emailFooterDocument
+

a character

+ +
emailHeaderDocument
+

a character

+ +
emailNotificationUrl
+

a character

+ +
enableChatterAnswers
+

a character either 'true' or 'false'

+ +
enablePrivateQuestions
+

a character either 'true' or 'false'

+ +
expertsGroup
+

a character

+ +
portal
+

a character

+ +
reputationLevels
+

a ReputationLevels

+ +
showInPortal
+

a character either 'true' or 'false'

+ +
site
+

a character

+ + +

CommunityCustomThemeLayoutType

+
description
+

a character

+ +
label
+

a character

+ + +

CommunityRoles

+
customerUserRole
+

a character

+ +
employeeUserRole
+

a character

+ +
partnerUserRole
+

a character

+ + +

CommunityTemplateBundleInfo

+
description
+

a character

+ +
image
+

a character

+ +
order
+

an integer

+ +
title
+

a character

+ +
type
+

a CommunityTemplateBundleInfoType - which is a character taking one of the following values:

  • Highlight

    • +

  • PreviewImage

    • +
+ + +

CommunityTemplateDefinition

+
fullName
+

a character (inherited from Metadata)

+ +
baseTemplate
+

a CommunityBaseTemplate - which is a character taking one of the following values:

  • c

    • +
+ +
bundlesInfo
+

a CommunityTemplateBundleInfo

+ +
category
+

a CommunityTemplateCategory - which is a character taking one of the following values:

  • IT

    • +

  • Marketing

    • +

  • Sales

    • +

  • Service

    • +
+ +
defaultBrandingSet
+

a character

+ +
defaultThemeDefinition
+

a character

+ +
description
+

a character

+ +
enableExtendedCleanUpOnDelete
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
navigationLinkSet
+

a NavigationLinkSet

+ +
pageSetting
+

a CommunityTemplatePageSetting

+ + +

CommunityTemplatePageSetting

+
page
+

a character

+ +
themeLayout
+

a character

+ + +

CommunityThemeDefinition

+
fullName
+

a character (inherited from Metadata)

+ +
customThemeLayoutType
+

a CommunityCustomThemeLayoutType

+ +
description
+

a character

+ +
enableExtendedCleanUpOnDelete
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
themeSetting
+

a CommunityThemeSetting

+ + +

CommunityThemeSetting

+
customThemeLayoutType
+

a character

+ +
themeLayout
+

a character

+ +
themeLayoutType
+

a CommunityThemeLayoutType - which is a character taking one of the following values:

  • Login

    • +

  • Home

    • +

  • Inner

    • +
+ + +

CompactLayout

+
fullName
+

a character (inherited from Metadata)

+ +
fields
+

a character

+ +
label
+

a character

+ + +

CompanySettings

+
fullName
+

a character (inherited from Metadata)

+ +
fiscalYear
+

a FiscalYearSettings

+ + +

ComponentInstance

+
componentInstanceProperties
+

a ComponentInstanceProperty

+ +
componentName
+

a character

+ +
visibilityRule
+

a UiFormulaRule

+ + +

ComponentInstanceProperty

+
name
+

a character

+ +
type
+

a ComponentInstancePropertyTypeEnum - which is a character taking one of the following values:

  • decorator

    • +
+ +
value
+

a character

+ + +

ConnectedApp

+
fullName
+

a character (inherited from Metadata)

+ +
attributes
+

a ConnectedAppAttribute

+ +
canvasConfig
+

a ConnectedAppCanvasConfig

+ +
contactEmail
+

a character

+ +
contactPhone
+

a character

+ +
description
+

a character

+ +
iconUrl
+

a character

+ +
infoUrl
+

a character

+ +
ipRanges
+

a ConnectedAppIpRange

+ +
label
+

a character

+ +
logoUrl
+

a character

+ +
mobileAppConfig
+

a ConnectedAppMobileDetailConfig

+ +
mobileStartUrl
+

a character

+ +
oauthConfig
+

a ConnectedAppOauthConfig

+ +
plugin
+

a character

+ +
samlConfig
+

a ConnectedAppSamlConfig

+ +
startUrl
+

a character

+ + +

ConnectedAppAttribute

+
formula
+

a character

+ +
key
+

a character

+ + +

ConnectedAppCanvasConfig

+
accessMethod
+

a AccessMethod - which is a character taking one of the following values:

  • Get

    • +

  • Post

    • +
+ +
canvasUrl
+

a character

+ +
lifecycleClass
+

a character

+ +
locations
+

a CanvasLocationOptions - which is a character taking one of the following values:

  • None

    • +

  • Chatter

    • +

  • UserProfile

    • +

  • Visualforce

    • +

  • Aura

    • +

  • Publisher

    • +

  • ChatterFeed

    • +

  • ServiceDesk

    • +

  • OpenCTI

    • +

  • AppLauncher

    • +

  • MobileNav

    • +

  • PageLayout

    • +
+ +
options
+

a CanvasOptions - which is a character taking one of the following values:

  • HideShare

  • HideHeader

  • PersonalEnabled

    • -

-
samlInitiationMethod

a SamlInitiationMethod - which is a character taking one of the following values: -

    -

  • None

    • +
+ +
samlInitiationMethod
+

a SamlInitiationMethod - which is a character taking one of the following values:

  • None

  • IdpInitiated

  • SpInitiated

    • -

- -
- -

ConnectedAppIpRange

-
-
description

a character

-
end

a character

-
start

a character

- -
- -

ConnectedAppMobileDetailConfig

-
-
applicationBinaryFile

a character formed using base64encode

-
applicationBinaryFileName

a character

-
applicationBundleIdentifier

a character

-
applicationFileLength

an integer

-
applicationIconFile

a character

-
applicationIconFileName

a character

-
applicationInstallUrl

a character

-
devicePlatform

a DevicePlatformType - which is a character taking one of the following values: -

    -

  • ios

    • +
+ + +

ConnectedAppIpRange

+
description
+

a character

+ +
end
+

a character

+ +
start
+

a character

+ + +

ConnectedAppMobileDetailConfig

+
applicationBinaryFile
+

a character formed using base64encode

+ +
applicationBinaryFileName
+

a character

+ +
applicationBundleIdentifier
+

a character

+ +
applicationFileLength
+

an integer

+ +
applicationIconFile
+

a character

+ +
applicationIconFileName
+

a character

+ +
applicationInstallUrl
+

a character

+ +
devicePlatform
+

a DevicePlatformType - which is a character taking one of the following values:

  • ios

  • android

    • -

-
deviceType

a DeviceType - which is a character taking one of the following values: -

    -

  • phone

    • +
+ +
deviceType
+

a DeviceType - which is a character taking one of the following values:

  • phone

  • tablet

  • minitablet

    • -

-
minimumOsVersion

a character

-
privateApp

a character either 'true' or 'false'

-
version

a character

- -
- -

ConnectedAppOauthConfig

-
-
callbackUrl

a character

-
certificate

a character

-
consumerKey

a character

-
consumerSecret

a character

-
scopes

a ConnectedAppOauthAccessScope - which is a character taking one of the following values: -

    -

  • Basic

    • +
+ +
minimumOsVersion
+

a character

+ +
privateApp
+

a character either 'true' or 'false'

+ +
version
+

a character

+ + +

ConnectedAppOauthConfig

+
callbackUrl
+

a character

+ +
certificate
+

a character

+ +
consumerKey
+

a character

+ +
consumerSecret
+

a character

+ +
scopes
+

a ConnectedAppOauthAccessScope - which is a character taking one of the following values:

  • Basic

  • Api

  • Web

  • Full

    • @@ -1400,274 +1978,418 @@

    Details

  • CustomPermissions

  • Wave

  • Eclair

    • -

-
singleLogoutUrl

a character

- -
- -

ConnectedAppSamlConfig

-
-
acsUrl

a character

-
certificate

a character

-
encryptionCertificate

a character

-
encryptionType

a SamlEncryptionType - which is a character taking one of the following values: -

    -

  • AES_128

    • +
+ +
singleLogoutUrl
+

a character

+ + +

ConnectedAppSamlConfig

+
acsUrl
+

a character

+ +
certificate
+

a character

+ +
encryptionCertificate
+

a character

+ +
encryptionType
+

a SamlEncryptionType - which is a character taking one of the following values:

  • AES_128

  • AES_256

  • Triple_Des

    • -

-
entityUrl

a character

-
issuer

a character

-
samlIdpSLOBindingEnum

a SamlIdpSLOBinding - which is a character taking one of the following values: -

    -

  • RedirectBinding

    • +
+ +
entityUrl
+

a character

+ +
issuer
+

a character

+ +
samlIdpSLOBindingEnum
+

a SamlIdpSLOBinding - which is a character taking one of the following values:

  • RedirectBinding

  • PostBinding

    • -

-
samlNameIdFormat

a SamlNameIdFormatType - which is a character taking one of the following values: -

    -

  • Unspecified

    • +
+ +
samlNameIdFormat
+

a SamlNameIdFormatType - which is a character taking one of the following values:

  • Unspecified

  • EmailAddress

  • Persistent

  • Transient

    • -

-
samlSloUrl

a character

-
samlSubjectCustomAttr

a character

-
samlSubjectType

a SamlSubjectType - which is a character taking one of the following values: -

    -

  • Username

    • +
+ +
samlSloUrl
+

a character

+ +
samlSubjectCustomAttr
+

a character

+ +
samlSubjectType
+

a SamlSubjectType - which is a character taking one of the following values:

  • Username

  • FederationId

  • UserId

  • SpokeId

  • CustomAttribute

  • PersistentId

    • -

- -
- -

Container

-
-
height

an integer

-
isContainerAutoSizeEnabled

a character either 'true' or 'false'

-
region

a character

-
sidebarComponents

a SidebarComponent

-
style

a character

-
unit

a character

-
width

an integer

- -
- -

ContentAsset

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
format

a ContentAssetFormat - which is a character taking one of the following values: -

    -

  • Original

    • +
+ + +

Container

+
height
+

an integer

+ +
isContainerAutoSizeEnabled
+

a character either 'true' or 'false'

+ +
region
+

a character

+ +
sidebarComponents
+

a SidebarComponent

+ +
style
+

a character

+ +
unit
+

a character

+ +
width
+

an integer

+ + +

ContentAsset

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
format
+

a ContentAssetFormat - which is a character taking one of the following values:

  • Original

  • ZippedVersions

    • -

-
language

a character

-
masterLabel

a character

-
originNetwork

a character

-
relationships

a ContentAssetRelationships

-
versions

a ContentAssetVersions

- -
- -

ContentAssetLink

-
-
access

a ContentAssetAccess - which is a character taking one of the following values: -

    -

  • VIEWER

    • +
+ +
language
+

a character

+ +
masterLabel
+

a character

+ +
originNetwork
+

a character

+ +
relationships
+

a ContentAssetRelationships

+ +
versions
+

a ContentAssetVersions

+ + +

ContentAssetLink

+
access
+

a ContentAssetAccess - which is a character taking one of the following values:

  • VIEWER

  • COLLABORATOR

  • INFERRED

    • -

-
isManagingWorkspace

a character either 'true' or 'false'

-
name

a character

- -
- -

ContentAssetRelationships

-
-
insightsApplication

a ContentAssetLink

-
network

a ContentAssetLink

-
organization

a ContentAssetLink

-
workspace

a ContentAssetLink

- -
- -

ContentAssetVersion

-
-
number

a character

-
pathOnClient

a character

-
zipEntry

a character

- -
- -

ContentAssetVersions

-
-
version

a ContentAssetVersion

- -
- -

ContractSettings

-
-
fullName

a character (inherited from Metadata)

-
autoCalculateEndDate

a character either 'true' or 'false'

-
autoExpirationDelay

a character

-
autoExpirationRecipient

a character

-
autoExpireContracts

a character either 'true' or 'false'

-
enableContractHistoryTracking

a character either 'true' or 'false'

-
notifyOwnersOnContractExpiration

a character either 'true' or 'false'

- -
- -

CorsWhitelistOrigin

-
-
fullName

a character (inherited from Metadata)

-
urlPattern

a character

- -
- -

CountriesAndStates

-
-
countries

a Country

- -
- -

Country

-
-
active

a character either 'true' or 'false'

-
integrationValue

a character

-
isoCode

a character

-
label

a character

-
orgDefault

a character either 'true' or 'false'

-
standard

a character either 'true' or 'false'

-
states

a State

-
visible

a character either 'true' or 'false'

- -
- -

CspTrustedSite

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
endpointUrl

a character

-
isActive

a character either 'true' or 'false'

- -
- -

CustomApplication

-
-
fullName

a character (inherited from Metadata)

-
actionOverrides

a AppActionOverride

-
brand

a AppBrand

-
consoleConfig

a ServiceCloudConsoleConfig

-
defaultLandingTab

a character

-
description

a character

-
formFactors

a FormFactor - which is a character taking one of the following values: -

    -

  • Small

    • +
+ +
isManagingWorkspace
+

a character either 'true' or 'false'

+ +
name
+

a character

+ + +

ContentAssetRelationships

+
insightsApplication
+

a ContentAssetLink

+ +
network
+

a ContentAssetLink

+ +
organization
+

a ContentAssetLink

+ +
workspace
+

a ContentAssetLink

+ + +

ContentAssetVersion

+
number
+

a character

+ +
pathOnClient
+

a character

+ +
zipEntry
+

a character

+ + +

ContentAssetVersions

+
version
+

a ContentAssetVersion

+ + +

ContractSettings

+
fullName
+

a character (inherited from Metadata)

+ +
autoCalculateEndDate
+

a character either 'true' or 'false'

+ +
autoExpirationDelay
+

a character

+ +
autoExpirationRecipient
+

a character

+ +
autoExpireContracts
+

a character either 'true' or 'false'

+ +
enableContractHistoryTracking
+

a character either 'true' or 'false'

+ +
notifyOwnersOnContractExpiration
+

a character either 'true' or 'false'

+ + +

CorsWhitelistOrigin

+
fullName
+

a character (inherited from Metadata)

+ +
urlPattern
+

a character

+ + +

CountriesAndStates

+
countries
+

a Country

+ + +

Country

+
active
+

a character either 'true' or 'false'

+ +
integrationValue
+

a character

+ +
isoCode
+

a character

+ +
label
+

a character

+ +
orgDefault
+

a character either 'true' or 'false'

+ +
standard
+

a character either 'true' or 'false'

+ +
states
+

a State

+ +
visible
+

a character either 'true' or 'false'

+ + +

CspTrustedSite

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
endpointUrl
+

a character

+ +
isActive
+

a character either 'true' or 'false'

+ + +

CustomApplication

+
fullName
+

a character (inherited from Metadata)

+ +
actionOverrides
+

a AppActionOverride

+ +
brand
+

a AppBrand

+ +
consoleConfig
+

a ServiceCloudConsoleConfig

+ +
defaultLandingTab
+

a character

+ +
description
+

a character

+ +
formFactors
+

a FormFactor - which is a character taking one of the following values:

  • Small

  • Medium

  • Large

    • -

-
isServiceCloudConsole

a character either 'true' or 'false'

-
label

a character

-
logo

a character

-
navType

a NavType - which is a character taking one of the following values: -

    -

  • Standard

    • +
+ +
isServiceCloudConsole
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
logo
+

a character

+ +
navType
+

a NavType - which is a character taking one of the following values:

  • Standard

  • Console

    • -

-
preferences

a AppPreferences

-
profileActionOverrides

a AppProfileActionOverride

-
setupExperience

a character

-
subscriberTabs

a character

-
tabs

a character

-
uiType

a UiType - which is a character taking one of the following values: -

    -

  • Aloha

    • +
+ +
preferences
+

a AppPreferences

+ +
profileActionOverrides
+

a AppProfileActionOverride

+ +
setupExperience
+

a character

+ +
subscriberTabs
+

a character

+ +
tabs
+

a character

+ +
uiType
+

a UiType - which is a character taking one of the following values:

  • Aloha

  • Lightning

    • -

-
utilityBar

a character

-
workspaceConfig

a AppWorkspaceConfig

- -
- -

CustomApplicationComponent

-
-
fullName

a character (inherited from Metadata)

-
buttonIconUrl

a character

-
buttonStyle

a character

-
buttonText

a character

-
buttonWidth

an integer

-
height

an integer

-
isHeightFixed

a character either 'true' or 'false'

-
isHidden

a character either 'true' or 'false'

-
isWidthFixed

a character either 'true' or 'false'

-
visualforcePage

a character

-
width

an integer

- -
- -

CustomApplicationTranslation

-
-
label

a character

-
name

a character

- -
- -

CustomConsoleComponents

-
-
primaryTabComponents

a PrimaryTabComponents

-
subtabComponents

a SubtabComponents

- -
- -

CustomDataType

-
-
fullName

a character (inherited from Metadata)

-
customDataTypeComponents

a CustomDataTypeComponent

-
description

a character

-
displayFormula

a character

-
editComponentsOnSeparateLines

a character either 'true' or 'false'

-
label

a character

-
rightAligned

a character either 'true' or 'false'

-
supportComponentsInReports

a character either 'true' or 'false'

- -
- -

CustomDataTypeComponent

-
-
developerSuffix

a character

-
enforceFieldRequiredness

a character either 'true' or 'false'

-
label

a character

-
length

an integer

-
precision

an integer

-
scale

an integer

-
sortOrder

a SortOrder - which is a character taking one of the following values: -

    -

  • Asc

    • -

  • Desc

    • -

-
sortPriority

an integer

-
type

a FieldType - which is a character taking one of the following values: -

    -

  • AutoNumber

    • -

  • Lookup

    • -

  • MasterDetail

    • -

  • Checkbox

    • -

  • Currency

    • -

  • Date

    • -

  • DateTime

    • -

  • Email

    • -

  • Number

    • -

  • Percent

    • -

  • Phone

    • -

  • Picklist

    • -

  • MultiselectPicklist

    • -

  • Text

    • -

  • TextArea

    • -

  • LongTextArea

    • -

  • Html

    • +
+ +
utilityBar
+

a character

+ +
workspaceConfig
+

a AppWorkspaceConfig

+ + +

CustomApplicationComponent

+
fullName
+

a character (inherited from Metadata)

+ +
buttonIconUrl
+

a character

+ +
buttonStyle
+

a character

+ +
buttonText
+

a character

+ +
buttonWidth
+

an integer

+ +
height
+

an integer

+ +
isHeightFixed
+

a character either 'true' or 'false'

+ +
isHidden
+

a character either 'true' or 'false'

+ +
isWidthFixed
+

a character either 'true' or 'false'

+ +
visualforcePage
+

a character

+ +
width
+

an integer

+ + +

CustomApplicationTranslation

+
label
+

a character

+ +
name
+

a character

+ + +

CustomConsoleComponents

+
primaryTabComponents
+

a PrimaryTabComponents

+ +
subtabComponents
+

a SubtabComponents

+ + +

CustomDataType

+
fullName
+

a character (inherited from Metadata)

+ +
customDataTypeComponents
+

a CustomDataTypeComponent

+ +
description
+

a character

+ +
displayFormula
+

a character

+ +
editComponentsOnSeparateLines
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
rightAligned
+

a character either 'true' or 'false'

+ +
supportComponentsInReports
+

a character either 'true' or 'false'

+ + +

CustomDataTypeComponent

+
developerSuffix
+

a character

+ +
enforceFieldRequiredness
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
length
+

an integer

+ +
precision
+

an integer

+ +
scale
+

an integer

+ +
sortOrder
+

a SortOrder - which is a character taking one of the following values:

  • Asc

    • +

  • Desc

    • +
+ +
sortPriority
+

an integer

+ +
type
+

a FieldType - which is a character taking one of the following values:

  • AutoNumber

    • +

  • Lookup

    • +

  • MasterDetail

    • +

  • Checkbox

    • +

  • Currency

    • +

  • Date

    • +

  • DateTime

    • +

  • Email

    • +

  • Number

    • +

  • Percent

    • +

  • Phone

    • +

  • Picklist

    • +

  • MultiselectPicklist

    • +

  • Text

    • +

  • TextArea

    • +

  • LongTextArea

    • +

  • Html

  • Url

  • EncryptedText

  • Summary

    • @@ -1679,180 +2401,335 @@

    Details

  • IndirectLookup

  • CustomDataType

  • Time

    • -

- -
- -

CustomDataTypeComponentTranslation

-
-
developerSuffix

a character

-
label

a character

- -
- -

CustomDataTypeTranslation

-
-
components

a CustomDataTypeComponentTranslation

-
customDataTypeName

a character

-
description

a character

-
label

a character

- -
- -

CustomExperience

-
-
fullName

a character (inherited from Metadata)

-
allowInternalUserLogin

a character either 'true' or 'false'

-
branding

a CustomExperienceBranding

-
changePasswordEmailTemplate

a character

-
emailFooterLogo

a character

-
emailFooterText

a character

-
emailSenderAddress

a character

-
emailSenderName

a character

-
enableErrorPageOverridesForVisualforce

a character either 'true' or 'false'

-
forgotPasswordEmailTemplate

a character

-
picassoSite

a character

-
sObjectType

a character

-
sendWelcomeEmail

a character either 'true' or 'false'

-
site

a character

-
siteAsContainerEnabled

a character either 'true' or 'false'

-
tabs

a CustomExperienceTabSet

-
urlPathPrefix

a character

-
welcomeEmailTemplate

a character

- -
- -

CustomExperienceBranding

-
-
loginFooterText

a character

-
loginLogo

a character

-
pageFooter

a character

-
pageHeader

a character

-
primaryColor

a character

-
primaryComplementColor

a character

-
quaternaryColor

a character

-
quaternaryComplementColor

a character

-
secondaryColor

a character

-
tertiaryColor

a character

-
tertiaryComplementColor

a character

-
zeronaryColor

a character

-
zeronaryComplementColor

a character

- -
- -

CustomExperienceTabSet

-
-
customTab

a character

-
defaultTab

a character

-
standardTab

a character

- -
- -

CustomFeedFilter

-
-
fullName

a character (inherited from Metadata)

-
criteria

a FeedFilterCriterion

-
description

a character

-
isProtected

a character either 'true' or 'false'

-
label

a character

- -
- -

CustomField

-
-
fullName

a character (inherited from Metadata)

-
businessOwnerGroup

a character

-
businessOwnerUser

a character

-
businessStatus

a character

-
caseSensitive

a character either 'true' or 'false'

-
customDataType

a character

-
defaultValue

a character

-
deleteConstraint

a DeleteConstraint - which is a character taking one of the following values: -

    -

  • Cascade

    • +
+ + +

CustomDataTypeComponentTranslation

+
developerSuffix
+

a character

+ +
label
+

a character

+ + +

CustomDataTypeTranslation

+
components
+

a CustomDataTypeComponentTranslation

+ +
customDataTypeName
+

a character

+ +
description
+

a character

+ +
label
+

a character

+ + +

CustomExperience

+
fullName
+

a character (inherited from Metadata)

+ +
allowInternalUserLogin
+

a character either 'true' or 'false'

+ +
branding
+

a CustomExperienceBranding

+ +
changePasswordEmailTemplate
+

a character

+ +
emailFooterLogo
+

a character

+ +
emailFooterText
+

a character

+ +
emailSenderAddress
+

a character

+ +
emailSenderName
+

a character

+ +
enableErrorPageOverridesForVisualforce
+

a character either 'true' or 'false'

+ +
forgotPasswordEmailTemplate
+

a character

+ +
picassoSite
+

a character

+ +
sObjectType
+

a character

+ +
sendWelcomeEmail
+

a character either 'true' or 'false'

+ +
site
+

a character

+ +
siteAsContainerEnabled
+

a character either 'true' or 'false'

+ +
tabs
+

a CustomExperienceTabSet

+ +
urlPathPrefix
+

a character

+ +
welcomeEmailTemplate
+

a character

+ + +

CustomExperienceBranding

+
loginFooterText
+

a character

+ +
loginLogo
+

a character

+ +
pageFooter
+

a character

+ +
pageHeader
+

a character

+ +
primaryColor
+

a character

+ +
primaryComplementColor
+

a character

+ +
quaternaryColor
+

a character

+ +
quaternaryComplementColor
+

a character

+ +
secondaryColor
+

a character

+ +
tertiaryColor
+

a character

+ +
tertiaryComplementColor
+

a character

+ +
zeronaryColor
+

a character

+ +
zeronaryComplementColor
+

a character

+ + +

CustomExperienceTabSet

+
customTab
+

a character

+ +
defaultTab
+

a character

+ +
standardTab
+

a character

+ + +

CustomFeedFilter

+
fullName
+

a character (inherited from Metadata)

+ +
criteria
+

a FeedFilterCriterion

+ +
description
+

a character

+ +
isProtected
+

a character either 'true' or 'false'

+ +
label
+

a character

+ + +

CustomField

+
fullName
+

a character (inherited from Metadata)

+ +
businessOwnerGroup
+

a character

+ +
businessOwnerUser
+

a character

+ +
businessStatus
+

a character

+ +
caseSensitive
+

a character either 'true' or 'false'

+ +
customDataType
+

a character

+ +
defaultValue
+

a character

+ +
deleteConstraint
+

a DeleteConstraint - which is a character taking one of the following values:

  • Cascade

  • Restrict

  • SetNull

    • -

-
deprecated

a character either 'true' or 'false'

-
description

a character

-
displayFormat

a character

-
encrypted

a character either 'true' or 'false'

-
escapeMarkup

a character either 'true' or 'false'

-
externalDeveloperName

a character

-
externalId

a character either 'true' or 'false'

-
fieldManageability

a FieldManageability - which is a character taking one of the following values: -

    -

  • DeveloperControlled

    • +
+ +
deprecated
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
displayFormat
+

a character

+ +
encrypted
+

a character either 'true' or 'false'

+ +
escapeMarkup
+

a character either 'true' or 'false'

+ +
externalDeveloperName
+

a character

+ +
externalId
+

a character either 'true' or 'false'

+ +
fieldManageability
+

a FieldManageability - which is a character taking one of the following values:

  • DeveloperControlled

  • SubscriberControlled

  • Locked

    • -

-
formula

a character

-
formulaTreatBlanksAs

a TreatBlanksAs - which is a character taking one of the following values: -

    -

  • BlankAsBlank

    • +
+ +
formula
+

a character

+ +
formulaTreatBlanksAs
+

a TreatBlanksAs - which is a character taking one of the following values:

  • BlankAsBlank

  • BlankAsZero

    • -

-
inlineHelpText

a character

-
isConvertLeadDisabled

a character either 'true' or 'false'

-
isFilteringDisabled

a character either 'true' or 'false'

-
isNameField

a character either 'true' or 'false'

-
isSortingDisabled

a character either 'true' or 'false'

-
label

a character

-
length

an integer

-
lookupFilter

a LookupFilter

-
maskChar

a EncryptedFieldMaskChar - which is a character taking one of the following values: -

    -

  • asterisk

    • +
+ +
inlineHelpText
+

a character

+ +
isConvertLeadDisabled
+

a character either 'true' or 'false'

+ +
isFilteringDisabled
+

a character either 'true' or 'false'

+ +
isNameField
+

a character either 'true' or 'false'

+ +
isSortingDisabled
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
length
+

an integer

+ +
lookupFilter
+

a LookupFilter

+ +
maskChar
+

a EncryptedFieldMaskChar - which is a character taking one of the following values:

  • asterisk

  • X

    • -

-
maskType

a EncryptedFieldMaskType - which is a character taking one of the following values: -

    -

  • all

    • +
+ +
maskType
+

a EncryptedFieldMaskType - which is a character taking one of the following values:

  • all

  • creditCard

  • ssn

  • lastFour

  • sin

  • nino

    • -

-
metadataRelationshipControllingField

a character

-
populateExistingRows

a character either 'true' or 'false'

-
precision

an integer

-
referenceTargetField

a character

-
referenceTo

a character

-
relationshipLabel

a character

-
relationshipName

a character

-
relationshipOrder

an integer

-
reparentableMasterDetail

a character either 'true' or 'false'

-
required

a character either 'true' or 'false'

-
restrictedAdminField

a character either 'true' or 'false'

-
scale

an integer

-
securityClassification

a SecurityClassification - which is a character taking one of the following values: -

    -

  • AccountInformation

    • +
+ +
metadataRelationshipControllingField
+

a character

+ +
populateExistingRows
+

a character either 'true' or 'false'

+ +
precision
+

an integer

+ +
referenceTargetField
+

a character

+ +
referenceTo
+

a character

+ +
relationshipLabel
+

a character

+ +
relationshipName
+

a character

+ +
relationshipOrder
+

an integer

+ +
reparentableMasterDetail
+

a character either 'true' or 'false'

+ +
required
+

a character either 'true' or 'false'

+ +
restrictedAdminField
+

a character either 'true' or 'false'

+ +
scale
+

an integer

+ +
securityClassification
+

a SecurityClassification - which is a character taking one of the following values:

  • AccountInformation

  • ConfigurationAndUsageData

  • DataIntendedToBePublic

  • BusinessSetupDataBusinessDataAndAggregates

  • AssociativeBusinessOrPersonalData

  • AuthenticationData

    • -

-
startingNumber

an integer

-
stripMarkup

a character either 'true' or 'false'

-
summarizedField

a character

-
summaryFilterItems

a FilterItem

-
summaryForeignKey

a character

-
summaryOperation

a SummaryOperations - which is a character taking one of the following values: -

    -

  • count

    • +
+ +
startingNumber
+

an integer

+ +
stripMarkup
+

a character either 'true' or 'false'

+ +
summarizedField
+

a character

+ +
summaryFilterItems
+

a FilterItem

+ +
summaryForeignKey
+

a character

+ +
summaryOperation
+

a SummaryOperations - which is a character taking one of the following values:

  • count

  • sum

  • min

  • max

    • -

-
trackFeedHistory

a character either 'true' or 'false'

-
trackHistory

a character either 'true' or 'false'

-
trackTrending

a character either 'true' or 'false'

-
type

a FieldType - which is a character taking one of the following values: -

    -

  • AutoNumber

    • +
+ +
trackFeedHistory
+

a character either 'true' or 'false'

+ +
trackHistory
+

a character either 'true' or 'false'

+ +
trackTrending
+

a character either 'true' or 'false'

+ +
type
+

a FieldType - which is a character taking one of the following values:

  • AutoNumber

  • Lookup

  • MasterDetail

  • Checkbox

    • @@ -1880,244 +2757,402 @@

    Details

  • IndirectLookup

  • CustomDataType

  • Time

    • -

-
unique

a character either 'true' or 'false'

-
valueSet

a ValueSet

-
visibleLines

an integer

-
writeRequiresMasterRead

a character either 'true' or 'false'

- -
- -

CustomFieldTranslation

-
-
caseValues

a ObjectNameCaseValue

-
gender

a Gender - which is a character taking one of the following values: -

    -

  • Neuter

    • +
+ +
unique
+

a character either 'true' or 'false'

+ +
valueSet
+

a ValueSet

+ +
visibleLines
+

an integer

+ +
writeRequiresMasterRead
+

a character either 'true' or 'false'

+ + +

CustomFieldTranslation

+
caseValues
+

a ObjectNameCaseValue

+ +
gender
+

a Gender - which is a character taking one of the following values:

  • Neuter

  • Masculine

  • Feminine

  • AnimateMasculine

    • -

-
help

a character

-
label

a character

-
lookupFilter

a LookupFilterTranslation

-
name

a character

-
picklistValues

a PicklistValueTranslation

-
relationshipLabel

a character

-
startsWith

a StartsWith - which is a character taking one of the following values: -

    -

  • Consonant

    • +
+ +
help
+

a character

+ +
label
+

a character

+ +
lookupFilter
+

a LookupFilterTranslation

+ +
name
+

a character

+ +
picklistValues
+

a PicklistValueTranslation

+ +
relationshipLabel
+

a character

+ +
startsWith
+

a StartsWith - which is a character taking one of the following values:

  • Consonant

  • Vowel

  • Special

    • -

- -
- -

CustomLabel

-
-
fullName

a character (inherited from Metadata)

-
categories

a character

-
language

a character

-
protected

a character either 'true' or 'false'

-
shortDescription

a character

-
value

a character

- -
- -

CustomLabels

-
-
fullName

a character (inherited from Metadata)

-
labels

a CustomLabel

- -
- -

CustomLabelTranslation

-
-
label

a character

-
name

a character

- -
- -

CustomMetadata

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
label

a character

-
protected

a character either 'true' or 'false'

-
values

a CustomMetadataValue

- -
- -

CustomMetadataValue

-
-
field

a character

-
value

a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)

- -
- -

CustomNotificationType

-
-
fullName

a character (inherited from Metadata)

-
customNotifTypeName

a character

-
description

a character

-
desktop

a character either 'true' or 'false'

-
email

a character either 'true' or 'false'

-
masterLabel

a character

-
mobile

a character either 'true' or 'false'

- -
- -

CustomObject

-
-
fullName

a character (inherited from Metadata)

-
actionOverrides

a ActionOverride

-
allowInChatterGroups

a character either 'true' or 'false'

-
articleTypeChannelDisplay

a ArticleTypeChannelDisplay

-
businessProcesses

a BusinessProcess

-
compactLayoutAssignment

a character

-
compactLayouts

a CompactLayout

-
customHelp

a character

-
customHelpPage

a character

-
customSettingsType

a CustomSettingsType - which is a character taking one of the following values: -

    -

  • List

    • +
+ + +

CustomLabel

+
fullName
+

a character (inherited from Metadata)

+ +
categories
+

a character

+ +
language
+

a character

+ +
protected
+

a character either 'true' or 'false'

+ +
shortDescription
+

a character

+ +
value
+

a character

+ + +

CustomLabels

+
fullName
+

a character (inherited from Metadata)

+ +
labels
+

a CustomLabel

+ + +

CustomLabelTranslation

+
label
+

a character

+ +
name
+

a character

+ + +

CustomMetadata

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
label
+

a character

+ +
protected
+

a character either 'true' or 'false'

+ +
values
+

a CustomMetadataValue

+ + +

CustomMetadataValue

+
field
+

a character

+ +
value
+

a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)

+ + +

CustomNotificationType

+
fullName
+

a character (inherited from Metadata)

+ +
customNotifTypeName
+

a character

+ +
description
+

a character

+ +
desktop
+

a character either 'true' or 'false'

+ +
email
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
mobile
+

a character either 'true' or 'false'

+ + +

CustomObject

+
fullName
+

a character (inherited from Metadata)

+ +
actionOverrides
+

a ActionOverride

+ +
allowInChatterGroups
+

a character either 'true' or 'false'

+ +
articleTypeChannelDisplay
+

a ArticleTypeChannelDisplay

+ +
businessProcesses
+

a BusinessProcess

+ +
compactLayoutAssignment
+

a character

+ +
compactLayouts
+

a CompactLayout

+ +
customHelp
+

a character

+ +
customHelpPage
+

a character

+ +
customSettingsType
+

a CustomSettingsType - which is a character taking one of the following values:

  • List

  • Hierarchy

    • -

-
dataStewardGroup

a character

-
dataStewardUser

a character

-
deploymentStatus

a DeploymentStatus - which is a character taking one of the following values: -

    -

  • InDevelopment

    • +
+ +
dataStewardGroup
+

a character

+ +
dataStewardUser
+

a character

+ +
deploymentStatus
+

a DeploymentStatus - which is a character taking one of the following values:

  • InDevelopment

  • Deployed

    • -

-
deprecated

a character either 'true' or 'false'

-
description

a character

-
enableActivities

a character either 'true' or 'false'

-
enableBulkApi

a character either 'true' or 'false'

-
enableChangeDataCapture

a character either 'true' or 'false'

-
enableDivisions

a character either 'true' or 'false'

-
enableEnhancedLookup

a character either 'true' or 'false'

-
enableFeeds

a character either 'true' or 'false'

-
enableHistory

a character either 'true' or 'false'

-
enableReports

a character either 'true' or 'false'

-
enableSearch

a character either 'true' or 'false'

-
enableSharing

a character either 'true' or 'false'

-
enableStreamingApi

a character either 'true' or 'false'

-
eventType

a PlatformEventType - which is a character taking one of the following values: -

    -

  • HighVolume

    • +
+ +
deprecated
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
enableActivities
+

a character either 'true' or 'false'

+ +
enableBulkApi
+

a character either 'true' or 'false'

+ +
enableChangeDataCapture
+

a character either 'true' or 'false'

+ +
enableDivisions
+

a character either 'true' or 'false'

+ +
enableEnhancedLookup
+

a character either 'true' or 'false'

+ +
enableFeeds
+

a character either 'true' or 'false'

+ +
enableHistory
+

a character either 'true' or 'false'

+ +
enableReports
+

a character either 'true' or 'false'

+ +
enableSearch
+

a character either 'true' or 'false'

+ +
enableSharing
+

a character either 'true' or 'false'

+ +
enableStreamingApi
+

a character either 'true' or 'false'

+ +
eventType
+

a PlatformEventType - which is a character taking one of the following values:

  • HighVolume

  • StandardVolume

    • -

-
externalDataSource

a character

-
externalName

a character

-
externalRepository

a character

-
externalSharingModel

a SharingModel - which is a character taking one of the following values: -

    -

  • Private

    • +
+ +
externalDataSource
+

a character

+ +
externalName
+

a character

+ +
externalRepository
+

a character

+ +
externalSharingModel
+

a SharingModel - which is a character taking one of the following values:

  • Private

  • Read

  • ReadSelect

  • ReadWrite

  • ReadWriteTransfer

  • FullAccess

  • ControlledByParent

    • -

-
fieldSets

a FieldSet

-
fields

a CustomField

-
gender

a Gender - which is a character taking one of the following values: -

    -

  • Neuter

    • +
+ +
fieldSets
+

a FieldSet

+ +
fields
+

a CustomField

+ +
gender
+

a Gender - which is a character taking one of the following values:

  • Neuter

  • Masculine

  • Feminine

  • AnimateMasculine

    • -

-
historyRetentionPolicy

a HistoryRetentionPolicy

-
household

a character either 'true' or 'false'

-
indexes

a Index

-
label

a character

-
listViews

a ListView

-
nameField

a CustomField

-
pluralLabel

a character

-
recordTypeTrackFeedHistory

a character either 'true' or 'false'

-
recordTypeTrackHistory

a character either 'true' or 'false'

-
recordTypes

a RecordType

-
searchLayouts

a SearchLayouts

-
sharingModel

a SharingModel - which is a character taking one of the following values: -

    -

  • Private

    • +
+ +
historyRetentionPolicy
+

a HistoryRetentionPolicy

+ +
household
+

a character either 'true' or 'false'

+ +
indexes
+

a Index

+ +
label
+

a character

+ +
listViews
+

a ListView

+ +
nameField
+

a CustomField

+ +
pluralLabel
+

a character

+ +
recordTypeTrackFeedHistory
+

a character either 'true' or 'false'

+ +
recordTypeTrackHistory
+

a character either 'true' or 'false'

+ +
recordTypes
+

a RecordType

+ +
searchLayouts
+

a SearchLayouts

+ +
sharingModel
+

a SharingModel - which is a character taking one of the following values:

  • Private

  • Read

  • ReadSelect

  • ReadWrite

  • ReadWriteTransfer

  • FullAccess

  • ControlledByParent

    • -

-
sharingReasons

a SharingReason

-
sharingRecalculations

a SharingRecalculation

-
startsWith

a StartsWith - which is a character taking one of the following values: -

    -

  • Consonant

    • +
+ +
sharingReasons
+

a SharingReason

+ +
sharingRecalculations
+

a SharingRecalculation

+ +
startsWith
+

a StartsWith - which is a character taking one of the following values:

  • Consonant

  • Vowel

  • Special

    • -

-
validationRules

a ValidationRule

-
visibility

a SetupObjectVisibility - which is a character taking one of the following values: -

    -

  • Protected

    • +
+ +
validationRules
+

a ValidationRule

+ +
visibility
+

a SetupObjectVisibility - which is a character taking one of the following values:

  • Protected

  • Public

    • -

-
webLinks

a WebLink

- -
- -

CustomObjectTranslation

-
-
fullName

a character (inherited from Metadata)

-
caseValues

a ObjectNameCaseValue

-
fieldSets

a FieldSetTranslation

-
fields

a CustomFieldTranslation

-
gender

a Gender - which is a character taking one of the following values: -

    -

  • Neuter

    • -

  • Masculine

    • +
+ +
webLinks
+

a WebLink

+ + +

CustomObjectTranslation

+
fullName
+

a character (inherited from Metadata)

+ +
caseValues
+

a ObjectNameCaseValue

+ +
fieldSets
+

a FieldSetTranslation

+ +
fields
+

a CustomFieldTranslation

+ +
gender
+

a Gender - which is a character taking one of the following values:

  • Neuter

    • +

  • Masculine

  • Feminine

  • AnimateMasculine

    • -

-
layouts

a LayoutTranslation

-
nameFieldLabel

a character

-
quickActions

a QuickActionTranslation

-
recordTypes

a RecordTypeTranslation

-
sharingReasons

a SharingReasonTranslation

-
standardFields

a StandardFieldTranslation

-
startsWith

a StartsWith - which is a character taking one of the following values: -

    -

  • Consonant

    • +
+ +
layouts
+

a LayoutTranslation

+ +
nameFieldLabel
+

a character

+ +
quickActions
+

a QuickActionTranslation

+ +
recordTypes
+

a RecordTypeTranslation

+ +
sharingReasons
+

a SharingReasonTranslation

+ +
standardFields
+

a StandardFieldTranslation

+ +
startsWith
+

a StartsWith - which is a character taking one of the following values:

  • Consonant

  • Vowel

  • Special

    • -

-
validationRules

a ValidationRuleTranslation

-
webLinks

a WebLinkTranslation

-
workflowTasks

a WorkflowTaskTranslation

- -
- -

CustomPageWebLink

-
-
fullName

a character (inherited from Metadata)

-
availability

a WebLinkAvailability - which is a character taking one of the following values: -

    -

  • online

    • +
+ +
validationRules
+

a ValidationRuleTranslation

+ +
webLinks
+

a WebLinkTranslation

+ +
workflowTasks
+

a WorkflowTaskTranslation

+ + +

CustomPageWebLink

+
fullName
+

a character (inherited from Metadata)

+ +
availability
+

a WebLinkAvailability - which is a character taking one of the following values:

  • online

  • offline

    • -

-
description

a character

-
displayType

a WebLinkDisplayType - which is a character taking one of the following values: -

    -

  • link

    • +
+ +
description
+

a character

+ +
displayType
+

a WebLinkDisplayType - which is a character taking one of the following values:

  • link

  • button

  • massActionButton

    • -

-
encodingKey

a Encoding - which is a character taking one of the following values: -

    -

  • UTF-8

    • +
+ +
encodingKey
+

a Encoding - which is a character taking one of the following values:

  • UTF-8

  • ISO-8859-1

  • Shift_JIS

  • ISO-2022-JP

    • @@ -2127,163 +3162,323 @@

    Details

  • GB2312

  • Big5-HKSCS

  • x-SJIS_0213

    • -

-
hasMenubar

a character either 'true' or 'false'

-
hasScrollbars

a character either 'true' or 'false'

-
hasToolbar

a character either 'true' or 'false'

-
height

an integer

-
isResizable

a character either 'true' or 'false'

-
linkType

a WebLinkType - which is a character taking one of the following values: -

    -

  • url

    • +
+ +
hasMenubar
+

a character either 'true' or 'false'

+ +
hasScrollbars
+

a character either 'true' or 'false'

+ +
hasToolbar
+

a character either 'true' or 'false'

+ +
height
+

an integer

+ +
isResizable
+

a character either 'true' or 'false'

+ +
linkType
+

a WebLinkType - which is a character taking one of the following values:

  • url

  • sControl

  • javascript

  • page

  • flow

    • -

-
masterLabel

a character

-
openType

a WebLinkWindowType - which is a character taking one of the following values: -

    -

  • newWindow

    • +
+ +
masterLabel
+

a character

+ +
openType
+

a WebLinkWindowType - which is a character taking one of the following values:

  • newWindow

  • sidebar

  • noSidebar

  • replace

  • onClickJavaScript

    • -

-
page

a character

-
position

a WebLinkPosition - which is a character taking one of the following values: -

    -

  • fullScreen

    • +
+ +
page
+

a character

+ +
position
+

a WebLinkPosition - which is a character taking one of the following values:

  • fullScreen

  • none

  • topLeft

    • -

-
protected

a character either 'true' or 'false'

-
requireRowSelection

a character either 'true' or 'false'

-
scontrol

a character

-
showsLocation

a character either 'true' or 'false'

-
showsStatus

a character either 'true' or 'false'

-
url

a character

-
width

an integer

- -
- -

CustomPageWebLinkTranslation

-
-
label

a character

-
name

a character

- -
- -

CustomPermission

-
-
fullName

a character (inherited from Metadata)

-
connectedApp

a character

-
description

a character

-
label

a character

-
requiredPermission

a CustomPermissionDependencyRequired

- -
- -

CustomPermissionDependencyRequired

-
-
customPermission

a character

-
dependency

a character either 'true' or 'false'

- -
- -

CustomShortcut

-
-
action

a character (inherited from DefaultShortcut)

-
active

a character either 'true' or 'false' (inherited from DefaultShortcut)

-
keyCommand

a character (inherited from DefaultShortcut)

-
description

a character

-
eventName

a character

- -
- -

CustomSite

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
allowHomePage

a character either 'true' or 'false'

-
allowStandardAnswersPages

a character either 'true' or 'false'

-
allowStandardIdeasPages

a character either 'true' or 'false'

-
allowStandardLookups

a character either 'true' or 'false'

-
allowStandardPortalPages

a character either 'true' or 'false'

-
allowStandardSearch

a character either 'true' or 'false'

-
analyticsTrackingCode

a character

-
authorizationRequiredPage

a character

-
bandwidthExceededPage

a character

-
browserXssProtection

a character either 'true' or 'false'

-
changePasswordPage

a character

-
chatterAnswersForgotPasswordConfirmPage

a character

-
chatterAnswersForgotPasswordPage

a character

-
chatterAnswersHelpPage

a character

-
chatterAnswersLoginPage

a character

-
chatterAnswersRegistrationPage

a character

-
clickjackProtectionLevel

a SiteClickjackProtectionLevel - which is a character taking one of the following values: -

    -

  • AllowAllFraming

    • +
+ +
protected
+

a character either 'true' or 'false'

+ +
requireRowSelection
+

a character either 'true' or 'false'

+ +
scontrol
+

a character

+ +
showsLocation
+

a character either 'true' or 'false'

+ +
showsStatus
+

a character either 'true' or 'false'

+ +
url
+

a character

+ +
width
+

an integer

+ + +

CustomPageWebLinkTranslation

+
label
+

a character

+ +
name
+

a character

+ + +

CustomPermission

+
fullName
+

a character (inherited from Metadata)

+ +
connectedApp
+

a character

+ +
description
+

a character

+ +
label
+

a character

+ +
requiredPermission
+

a CustomPermissionDependencyRequired

+ + +

CustomPermissionDependencyRequired

+
customPermission
+

a character

+ +
dependency
+

a character either 'true' or 'false'

+ + +

CustomShortcut

+
action
+

a character (inherited from DefaultShortcut)

+ +
active
+

a character either 'true' or 'false' (inherited from DefaultShortcut)

+ +
keyCommand
+

a character (inherited from DefaultShortcut)

+ +
description
+

a character

+ +
eventName
+

a character

+ + +

CustomSite

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
allowHomePage
+

a character either 'true' or 'false'

+ +
allowStandardAnswersPages
+

a character either 'true' or 'false'

+ +
allowStandardIdeasPages
+

a character either 'true' or 'false'

+ +
allowStandardLookups
+

a character either 'true' or 'false'

+ +
allowStandardPortalPages
+

a character either 'true' or 'false'

+ +
allowStandardSearch
+

a character either 'true' or 'false'

+ +
analyticsTrackingCode
+

a character

+ +
authorizationRequiredPage
+

a character

+ +
bandwidthExceededPage
+

a character

+ +
browserXssProtection
+

a character either 'true' or 'false'

+ +
changePasswordPage
+

a character

+ +
chatterAnswersForgotPasswordConfirmPage
+

a character

+ +
chatterAnswersForgotPasswordPage
+

a character

+ +
chatterAnswersHelpPage
+

a character

+ +
chatterAnswersLoginPage
+

a character

+ +
chatterAnswersRegistrationPage
+

a character

+ +
clickjackProtectionLevel
+

a SiteClickjackProtectionLevel - which is a character taking one of the following values:

  • AllowAllFraming

  • SameOriginOnly

  • NoFraming

    • -

-
contentSniffingProtection

a character either 'true' or 'false'

-
cspUpgradeInsecureRequests

a character either 'true' or 'false'

-
customWebAddresses

a SiteWebAddress

-
description

a character

-
favoriteIcon

a character

-
fileNotFoundPage

a character

-
forgotPasswordPage

a character

-
genericErrorPage

a character

-
guestProfile

a character

-
inMaintenancePage

a character

-
inactiveIndexPage

a character

-
indexPage

a character

-
masterLabel

a character

-
myProfilePage

a character

-
portal

a character

-
referrerPolicyOriginWhenCrossOrigin

a character either 'true' or 'false'

-
requireHttps

a character either 'true' or 'false'

-
requireInsecurePortalAccess

a character either 'true' or 'false'

-
robotsTxtPage

a character

-
rootComponent

a character

-
selfRegPage

a character

-
serverIsDown

a character

-
siteAdmin

a character

-
siteRedirectMappings

a SiteRedirectMapping

-
siteTemplate

a character

-
siteType

a SiteType - which is a character taking one of the following values: -

    -

  • Siteforce

    • +
+ +
contentSniffingProtection
+

a character either 'true' or 'false'

+ +
cspUpgradeInsecureRequests
+

a character either 'true' or 'false'

+ +
customWebAddresses
+

a SiteWebAddress

+ +
description
+

a character

+ +
favoriteIcon
+

a character

+ +
fileNotFoundPage
+

a character

+ +
forgotPasswordPage
+

a character

+ +
genericErrorPage
+

a character

+ +
guestProfile
+

a character

+ +
inMaintenancePage
+

a character

+ +
inactiveIndexPage
+

a character

+ +
indexPage
+

a character

+ +
masterLabel
+

a character

+ +
myProfilePage
+

a character

+ +
portal
+

a character

+ +
referrerPolicyOriginWhenCrossOrigin
+

a character either 'true' or 'false'

+ +
requireHttps
+

a character either 'true' or 'false'

+ +
requireInsecurePortalAccess
+

a character either 'true' or 'false'

+ +
robotsTxtPage
+

a character

+ +
rootComponent
+

a character

+ +
selfRegPage
+

a character

+ +
serverIsDown
+

a character

+ +
siteAdmin
+

a character

+ +
siteRedirectMappings
+

a SiteRedirectMapping

+ +
siteTemplate
+

a character

+ +
siteType
+

a SiteType - which is a character taking one of the following values:

  • Siteforce

  • Visualforce

  • User

    • -

-
subdomain

a character

-
urlPathPrefix

a character

- -
- -

CustomTab

-
-
fullName

a character (inherited from Metadata)

-
actionOverrides

a ActionOverride

-
auraComponent

a character

-
customObject

a character either 'true' or 'false'

-
description

a character

-
flexiPage

a character

-
frameHeight

an integer

-
hasSidebar

a character either 'true' or 'false'

-
icon

a character

-
label

a character

-
mobileReady

a character either 'true' or 'false'

-
motif

a character

-
page

a character

-
scontrol

a character

-
splashPageLink

a character

-
url

a character

-
urlEncodingKey

a Encoding - which is a character taking one of the following values: -

    -

  • UTF-8

    • +
+ +
subdomain
+

a character

+ +
urlPathPrefix
+

a character

+ + +

CustomTab

+
fullName
+

a character (inherited from Metadata)

+ +
actionOverrides
+

a ActionOverride

+ +
auraComponent
+

a character

+ +
customObject
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
flexiPage
+

a character

+ +
frameHeight
+

an integer

+ +
hasSidebar
+

a character either 'true' or 'false'

+ +
icon
+

a character

+ +
label
+

a character

+ +
mobileReady
+

a character either 'true' or 'false'

+ +
motif
+

a character

+ +
page
+

a character

+ +
scontrol
+

a character

+ +
splashPageLink
+

a character

+ +
url
+

a character

+ +
urlEncodingKey
+

a Encoding - which is a character taking one of the following values:

  • UTF-8

  • ISO-8859-1

  • Shift_JIS

  • ISO-2022-JP

    • @@ -2293,47 +3488,60 @@

    Details

  • GB2312

  • Big5-HKSCS

  • x-SJIS_0213

    • -

- -
- -

CustomTabTranslation

-
-
label

a character

-
name

a character

- -
- -

CustomValue

-
-
fullName

a character (inherited from Metadata)

-
color

a character

-
default

a character either 'true' or 'false'

-
description

a character

-
isActive

a character either 'true' or 'false'

-
label

a character

- -
- -

Dashboard

-
-
fullName

a character (inherited from Metadata)

-
backgroundEndColor

a character

-
backgroundFadeDirection

a ChartBackgroundDirection - which is a character taking one of the following values: -

    -

  • TopToBottom

    • +
+ + +

CustomTabTranslation

+
label
+

a character

+ +
name
+

a character

+ + +

CustomValue

+
fullName
+

a character (inherited from Metadata)

+ +
color
+

a character

+ +
default
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
isActive
+

a character either 'true' or 'false'

+ +
label
+

a character

+ + +

Dashboard

+
fullName
+

a character (inherited from Metadata)

+ +
backgroundEndColor
+

a character

+ +
backgroundFadeDirection
+

a ChartBackgroundDirection - which is a character taking one of the following values:

  • TopToBottom

  • LeftToRight

  • Diagonal

    • -

-
backgroundStartColor

a character

-
chartTheme

a ChartTheme - which is a character taking one of the following values: -

    -

  • light

    • +
+ +
backgroundStartColor
+

a character

+ +
chartTheme
+

a ChartTheme - which is a character taking one of the following values:

  • light

  • dark

    • -

-
colorPalette

a ChartColorPalettes - which is a character taking one of the following values: -

    -

  • Default

    • +
+ +
colorPalette
+

a ChartColorPalettes - which is a character taking one of the following values:

  • Default

  • gray

  • colorSafe

  • unity

    • @@ -2350,15 +3558,15 @@

    Details

  • water

  • earth

  • accessible

    • -

-
dashboardChartTheme

a ChartTheme - which is a character taking one of the following values: -

    -

  • light

    • +
+ +
dashboardChartTheme
+

a ChartTheme - which is a character taking one of the following values:

  • light

  • dark

    • -

-
dashboardColorPalette

a ChartColorPalettes - which is a character taking one of the following values: -

    -

  • Default

    • +
+ +
dashboardColorPalette
+

a ChartColorPalettes - which is a character taking one of the following values:

  • Default

  • gray

  • colorSafe

  • unity

    • @@ -2375,51 +3583,88 @@

    Details

  • water

  • earth

  • accessible

    • -

-
dashboardFilters

a DashboardFilter

-
dashboardGridLayout

a DashboardGridLayout

-
dashboardResultRefreshedDate

a character

-
dashboardResultRunningUser

a character

-
dashboardType

a DashboardType - which is a character taking one of the following values: -

    -

  • SpecifiedUser

    • +
+ +
dashboardFilters
+

a DashboardFilter

+ +
dashboardGridLayout
+

a DashboardGridLayout

+ +
dashboardResultRefreshedDate
+

a character

+ +
dashboardResultRunningUser
+

a character

+ +
dashboardType
+

a DashboardType - which is a character taking one of the following values:

  • SpecifiedUser

  • LoggedInUser

  • MyTeamUser

    • -

-
description

a character

-
folderName

a character

-
isGridLayout

a character either 'true' or 'false'

-
leftSection

a DashboardComponentSection

-
middleSection

a DashboardComponentSection

-
numSubscriptions

an integer

-
rightSection

a DashboardComponentSection

-
runningUser

a character

-
textColor

a character

-
title

a character

-
titleColor

a character

-
titleSize

an integer

- -
- -

DashboardComponent

-
-
autoselectColumnsFromReport

a character either 'true' or 'false'

-
chartAxisRange

a ChartRangeType - which is a character taking one of the following values: -

    -

  • Auto

    • +
+ +
description
+

a character

+ +
folderName
+

a character

+ +
isGridLayout
+

a character either 'true' or 'false'

+ +
leftSection
+

a DashboardComponentSection

+ +
middleSection
+

a DashboardComponentSection

+ +
numSubscriptions
+

an integer

+ +
rightSection
+

a DashboardComponentSection

+ +
runningUser
+

a character

+ +
textColor
+

a character

+ +
title
+

a character

+ +
titleColor
+

a character

+ +
titleSize
+

an integer

+ + +

DashboardComponent

+
autoselectColumnsFromReport
+

a character either 'true' or 'false'

+ +
chartAxisRange
+

a ChartRangeType - which is a character taking one of the following values:

  • Auto

  • Manual

    • -

-
chartAxisRangeMax

a numeric

-
chartAxisRangeMin

a numeric

-
chartSummary

a ChartSummary

-
componentChartTheme

a ChartTheme - which is a character taking one of the following values: -

    -

  • light

    • +
+ +
chartAxisRangeMax
+

a numeric

+ +
chartAxisRangeMin
+

a numeric

+ +
chartSummary
+

a ChartSummary

+ +
componentChartTheme
+

a ChartTheme - which is a character taking one of the following values:

  • light

  • dark

    • -

-
componentType

a DashboardComponentType - which is a character taking one of the following values: -

    -

  • Bar

    • +
+ +
componentType
+

a DashboardComponentType - which is a character taking one of the following values:

  • Bar

  • BarGrouped

  • BarStacked

  • BarStacked100

    • @@ -2446,120 +3691,196 @@

    Details

  • Scatter

  • ScatterGrouped

  • FlexTable

    • -

-
dashboardFilterColumns

a DashboardFilterColumn

-
dashboardTableColumn

a DashboardTableColumn

-
displayUnits

a ChartUnits - which is a character taking one of the following values: -

    -

  • Auto

    • +
+ +
dashboardFilterColumns
+

a DashboardFilterColumn

+ +
dashboardTableColumn
+

a DashboardTableColumn

+ +
displayUnits
+

a ChartUnits - which is a character taking one of the following values:

  • Auto

  • Integer

  • Hundreds

  • Thousands

  • Millions

  • Billions

  • Trillions

    • -

-
drillDownUrl

a character

-
drillEnabled

a character either 'true' or 'false'

-
drillToDetailEnabled

a character either 'true' or 'false'

-
enableHover

a character either 'true' or 'false'

-
expandOthers

a character either 'true' or 'false'

-
flexComponentProperties

a DashboardFlexTableComponentProperties

-
footer

a character

-
gaugeMax

a numeric

-
gaugeMin

a numeric

-
groupingColumn

a character

-
header

a character

-
indicatorBreakpoint1

a numeric

-
indicatorBreakpoint2

a numeric

-
indicatorHighColor

a character

-
indicatorLowColor

a character

-
indicatorMiddleColor

a character

-
legendPosition

a ChartLegendPosition - which is a character taking one of the following values: -

    -

  • Right

    • +
+ +
drillDownUrl
+

a character

+ +
drillEnabled
+

a character either 'true' or 'false'

+ +
drillToDetailEnabled
+

a character either 'true' or 'false'

+ +
enableHover
+

a character either 'true' or 'false'

+ +
expandOthers
+

a character either 'true' or 'false'

+ +
flexComponentProperties
+

a DashboardFlexTableComponentProperties

+ +
footer
+

a character

+ +
gaugeMax
+

a numeric

+ +
gaugeMin
+

a numeric

+ +
groupingColumn
+

a character

+ +
header
+

a character

+ +
indicatorBreakpoint1
+

a numeric

+ +
indicatorBreakpoint2
+

a numeric

+ +
indicatorHighColor
+

a character

+ +
indicatorLowColor
+

a character

+ +
indicatorMiddleColor
+

a character

+ +
legendPosition
+

a ChartLegendPosition - which is a character taking one of the following values:

  • Right

  • Bottom

  • OnChart

    • -

-
maxValuesDisplayed

an integer

-
metricLabel

a character

-
page

a character

-
pageHeightInPixels

an integer

-
report

a character

-
scontrol

a character

-
scontrolHeightInPixels

an integer

-
showPercentage

a character either 'true' or 'false'

-
showPicturesOnCharts

a character either 'true' or 'false'

-
showPicturesOnTables

a character either 'true' or 'false'

-
showRange

a character either 'true' or 'false'

-
showTotal

a character either 'true' or 'false'

-
showValues

a character either 'true' or 'false'

-
sortBy

a DashboardComponentFilter - which is a character taking one of the following values: -

    -

  • RowLabelAscending

    • +
+ +
maxValuesDisplayed
+

an integer

+ +
metricLabel
+

a character

+ +
page
+

a character

+ +
pageHeightInPixels
+

an integer

+ +
report
+

a character

+ +
scontrol
+

a character

+ +
scontrolHeightInPixels
+

an integer

+ +
showPercentage
+

a character either 'true' or 'false'

+ +
showPicturesOnCharts
+

a character either 'true' or 'false'

+ +
showPicturesOnTables
+

a character either 'true' or 'false'

+ +
showRange
+

a character either 'true' or 'false'

+ +
showTotal
+

a character either 'true' or 'false'

+ +
showValues
+

a character either 'true' or 'false'

+ +
sortBy
+

a DashboardComponentFilter - which is a character taking one of the following values:

  • RowLabelAscending

  • RowLabelDescending

  • RowValueAscending

  • RowValueDescending

    • -

-
title

a character

-
useReportChart

a character either 'true' or 'false'

- -
- -

DashboardComponentColumn

-
-
breakPoint1

a numeric

-
breakPoint2

a numeric

-
breakPointOrder

an integer

-
highRangeColor

an integer

-
lowRangeColor

an integer

-
midRangeColor

an integer

-
reportColumn

a character

-
showTotal

a character either 'true' or 'false'

-
type

a DashboardComponentColumnType - which is a character taking one of the following values: -

    -

  • NA

    • -

- -
- -

DashboardComponentSection

-
-
columnSize

a DashboardComponentSize - which is a character taking one of the following values: -

    -

  • Narrow

    • +
+ +
title
+

a character

+ +
useReportChart
+

a character either 'true' or 'false'

+ + +

DashboardComponentColumn

+
breakPoint1
+

a numeric

+ +
breakPoint2
+

a numeric

+ +
breakPointOrder
+

an integer

+ +
highRangeColor
+

an integer

+ +
lowRangeColor
+

an integer

+ +
midRangeColor
+

an integer

+ +
reportColumn
+

a character

+ +
showTotal
+

a character either 'true' or 'false'

+ +
type
+

a DashboardComponentColumnType - which is a character taking one of the following values:

  • NA

    • +
+ + +

DashboardComponentSection

+
columnSize
+

a DashboardComponentSize - which is a character taking one of the following values:

  • Narrow

  • Medium

  • Wide

    • -

-
components

a DashboardComponent

+ + +
components
+

a DashboardComponent

+ -
+

DashboardComponentSortInfo

+
sortColumn
+

a character

-

DashboardComponentSortInfo

-
-
sortColumn

a character

-
sortOrder

a character

+
sortOrder
+

a character

-
-

DashboardFilter

-
-
dashboardFilterOptions

a DashboardFilterOption

-
name

a character

+

DashboardFilter

+
dashboardFilterOptions
+

a DashboardFilterOption

-
+
name
+

a character

-

DashboardFilterColumn

-
-
column

a character

-
+

DashboardFilterColumn

+
column
+

a character

-

DashboardFilterOption

-
-
operator

a DashboardFilterOperation - which is a character taking one of the following values: -

    -

  • equals

    • + +

DashboardFilterOption

+
operator
+

a DashboardFilterOperation - which is a character taking one of the following values:

  • equals

  • notEqual

  • lessThan

  • greaterThan

    • @@ -2571,350 +3892,538 @@

    Details

  • includes

  • excludes

  • between

    • -

-
values

a character

- -
- -

DashboardFlexTableComponentProperties

-
-
flexTableColumn

a DashboardComponentColumn

-
flexTableSortInfo

a DashboardComponentSortInfo

-
hideChatterPhotos

a character either 'true' or 'false'

- -
- -

DashboardFolder

-
-
accessType

a FolderAccessTypes (inherited from Folder)

-
folderShares

a FolderShare (inherited from Folder)

-
name

a character (inherited from Folder)

-
publicFolderAccess

a PublicFolderAccess (inherited from Folder)

-
sharedTo

a SharedTo (inherited from Folder)

- -
- -

DashboardGridComponent

-
-
colSpan

an integer

-
columnIndex

an integer

-
dashboardComponent

a DashboardComponent

-
rowIndex

an integer

-
rowSpan

an integer

- -
- -

DashboardGridLayout

-
-
dashboardGridComponents

a DashboardGridComponent

-
numberOfColumns

an integer

-
rowHeight

an integer

- -
- -

DashboardMobileSettings

-
-
enableDashboardIPadApp

a character either 'true' or 'false'

- -
- -

DashboardTableColumn

-
-
aggregateType

a ReportSummaryType - which is a character taking one of the following values: -

    -

  • Sum

    • +
+ +
values
+

a character

+ + +

DashboardFlexTableComponentProperties

+
flexTableColumn
+

a DashboardComponentColumn

+ +
flexTableSortInfo
+

a DashboardComponentSortInfo

+ +
hideChatterPhotos
+

a character either 'true' or 'false'

+ + +

DashboardFolder

+
accessType
+

a FolderAccessTypes (inherited from Folder)

+ +
folderShares
+

a FolderShare (inherited from Folder)

+ +
name
+

a character (inherited from Folder)

+ +
publicFolderAccess
+

a PublicFolderAccess (inherited from Folder)

+ +
sharedTo
+

a SharedTo (inherited from Folder)

+ + +

DashboardGridComponent

+
colSpan
+

an integer

+ +
columnIndex
+

an integer

+ +
dashboardComponent
+

a DashboardComponent

+ +
rowIndex
+

an integer

+ +
rowSpan
+

an integer

+ + +

DashboardGridLayout

+
dashboardGridComponents
+

a DashboardGridComponent

+ +
numberOfColumns
+

an integer

+ +
rowHeight
+

an integer

+ + +

DashboardMobileSettings

+
enableDashboardIPadApp
+

a character either 'true' or 'false'

+ + +

DashboardTableColumn

+
aggregateType
+

a ReportSummaryType - which is a character taking one of the following values:

  • Sum

  • Average

  • Maximum

  • Minimum

  • None

    • -

-
calculatePercent

a character either 'true' or 'false'

-
column

a character

-
decimalPlaces

an integer

-
showTotal

a character either 'true' or 'false'

-
sortBy

a DashboardComponentFilter - which is a character taking one of the following values: -

    -

  • RowLabelAscending

    • +
+ +
calculatePercent
+

a character either 'true' or 'false'

+ +
column
+

a character

+ +
decimalPlaces
+

an integer

+ +
showTotal
+

a character either 'true' or 'false'

+ +
sortBy
+

a DashboardComponentFilter - which is a character taking one of the following values:

  • RowLabelAscending

  • RowLabelDescending

  • RowValueAscending

  • RowValueDescending

    • -

- -
- -

DataCategory

-
-
dataCategory

a DataCategory

-
label

a character

-
name

a character

- -
- -

DataCategoryGroup

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
dataCategory

a DataCategory

-
description

a character

-
label

a character

-
objectUsage

a ObjectUsage

- -
- -

DataPipeline

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
apiVersion

a numeric

-
label

a character

-
scriptType

a DataPipelineType - which is a character taking one of the following values: -

    -

  • Pig

    • -

- -
- -

DefaultShortcut

-
-
action

a character

-
active

a character either 'true' or 'false'

-
keyCommand

a character

- -
- -

DelegateGroup

-
-
fullName

a character (inherited from Metadata)

-
customObjects

a character

-
groups

a character

-
label

a character

-
loginAccess

a character either 'true' or 'false'

-
permissionSets

a character

-
profiles

a character

-
roles

a character

- -
- -

DeployDetails

-
-
componentFailures

a DeployMessage

-
componentSuccesses

a DeployMessage

-
retrieveResult

a RetrieveResult

-
runTestResult

a RunTestsResult

- -
- -

DeployOptions

-
-
allowMissingFiles

a character either 'true' or 'false'

-
autoUpdatePackage

a character either 'true' or 'false'

-
checkOnly

a character either 'true' or 'false'

-
ignoreWarnings

a character either 'true' or 'false'

-
performRetrieve

a character either 'true' or 'false'

-
purgeOnDelete

a character either 'true' or 'false'

-
rollbackOnError

a character either 'true' or 'false'

-
runTests

a character

-
singlePackage

a character either 'true' or 'false'

-
testLevel

a TestLevel - which is a character taking one of the following values: -

    -

  • NoTestRun

    • -

  • RunSpecifiedTests

    • -

  • RunLocalTests

    • -

  • RunAllTestsInOrg

    • -

- -
- -

DescribeMetadataObject

-
-
childXmlNames

a character

-
directoryName

a character

-
inFolder

a character either 'true' or 'false'

-
metaFile

a character either 'true' or 'false'

-
suffix

a character

-
xmlName

a character

- -
- -

Document

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
description

a character

-
internalUseOnly

a character either 'true' or 'false'

-
keywords

a character

-
name

a character

-
public

a character either 'true' or 'false'

- -
- -

DocumentFolder

-
-
accessType

a FolderAccessTypes (inherited from Folder)

-
folderShares

a FolderShare (inherited from Folder)

-
name

a character (inherited from Folder)

-
publicFolderAccess

a PublicFolderAccess (inherited from Folder)

-
sharedTo

a SharedTo (inherited from Folder)

- -
- -

DuplicateRule

-
-
fullName

a character (inherited from Metadata)

-
actionOnInsert

a DupeActionType - which is a character taking one of the following values: -

    -

  • Allow

    • -

  • Block

    • -

-
actionOnUpdate

a DupeActionType - which is a character taking one of the following values: -

    -

  • Allow

    • -

  • Block

    • -

-
alertText

a character

-
description

a character

-
duplicateRuleFilter

a DuplicateRuleFilter

-
duplicateRuleMatchRules

a DuplicateRuleMatchRule

-
isActive

a character either 'true' or 'false'

-
masterLabel

a character

-
operationsOnInsert

a character

-
operationsOnUpdate

a character

-
securityOption

a DupeSecurityOptionType - which is a character taking one of the following values: -

    -

  • EnforceSharingRules

    • +
+ + +

DataCategory

+
dataCategory
+

a DataCategory

+ +
label
+

a character

+ +
name
+

a character

+ + +

DataCategoryGroup

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
dataCategory
+

a DataCategory

+ +
description
+

a character

+ +
label
+

a character

+ +
objectUsage
+

a ObjectUsage

+ + +

DataPipeline

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
apiVersion
+

a numeric

+ +
label
+

a character

+ +
scriptType
+

a DataPipelineType - which is a character taking one of the following values:

  • Pig

    • +
+ + +

DefaultShortcut

+
action
+

a character

+ +
active
+

a character either 'true' or 'false'

+ +
keyCommand
+

a character

+ + +

DelegateGroup

+
fullName
+

a character (inherited from Metadata)

+ +
customObjects
+

a character

+ +
groups
+

a character

+ +
label
+

a character

+ +
loginAccess
+

a character either 'true' or 'false'

+ +
permissionSets
+

a character

+ +
profiles
+

a character

+ +
roles
+

a character

+ + +

DeployDetails

+
componentFailures
+

a DeployMessage

+ +
componentSuccesses
+

a DeployMessage

+ +
retrieveResult
+

a RetrieveResult

+ +
runTestResult
+

a RunTestsResult

+ + +

DeployOptions

+
allowMissingFiles
+

a character either 'true' or 'false'

+ +
autoUpdatePackage
+

a character either 'true' or 'false'

+ +
checkOnly
+

a character either 'true' or 'false'

+ +
ignoreWarnings
+

a character either 'true' or 'false'

+ +
performRetrieve
+

a character either 'true' or 'false'

+ +
purgeOnDelete
+

a character either 'true' or 'false'

+ +
rollbackOnError
+

a character either 'true' or 'false'

+ +
runTests
+

a character

+ +
singlePackage
+

a character either 'true' or 'false'

+ +
testLevel
+

a TestLevel - which is a character taking one of the following values:

  • NoTestRun

    • +

  • RunSpecifiedTests

    • +

  • RunLocalTests

    • +

  • RunAllTestsInOrg

    • +
+ + +

DescribeMetadataObject

+
childXmlNames
+

a character

+ +
directoryName
+

a character

+ +
inFolder
+

a character either 'true' or 'false'

+ +
metaFile
+

a character either 'true' or 'false'

+ +
suffix
+

a character

+ +
xmlName
+

a character

+ + +

Document

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
description
+

a character

+ +
internalUseOnly
+

a character either 'true' or 'false'

+ +
keywords
+

a character

+ +
name
+

a character

+ +
public
+

a character either 'true' or 'false'

+ + +

DocumentFolder

+
accessType
+

a FolderAccessTypes (inherited from Folder)

+ +
folderShares
+

a FolderShare (inherited from Folder)

+ +
name
+

a character (inherited from Folder)

+ +
publicFolderAccess
+

a PublicFolderAccess (inherited from Folder)

+ +
sharedTo
+

a SharedTo (inherited from Folder)

+ + +

DuplicateRule

+
fullName
+

a character (inherited from Metadata)

+ +
actionOnInsert
+

a DupeActionType - which is a character taking one of the following values:

  • Allow

    • +

  • Block

    • +
+ +
actionOnUpdate
+

a DupeActionType - which is a character taking one of the following values:

  • Allow

    • +

  • Block

    • +
+ +
alertText
+

a character

+ +
description
+

a character

+ +
duplicateRuleFilter
+

a DuplicateRuleFilter

+ +
duplicateRuleMatchRules
+

a DuplicateRuleMatchRule

+ +
isActive
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
operationsOnInsert
+

a character

+ +
operationsOnUpdate
+

a character

+ +
securityOption
+

a DupeSecurityOptionType - which is a character taking one of the following values:

  • EnforceSharingRules

  • BypassSharingRules

    • -

-
sortOrder

an integer

- -
- -

DuplicateRuleFilter

-
-
booleanFilter

a character

-
duplicateRuleFilterItems

a DuplicateRuleFilterItem

- -
- -

DuplicateRuleFilterItem

-
-
field

a character (inherited from FilterItem)

-
operation

a FilterOperation (inherited from FilterItem)

-
value

a character (inherited from FilterItem)

-
valueField

a character (inherited from FilterItem)

-
sortOrder

an integer

-
table

a character

- -
- -

DuplicateRuleMatchRule

-
-
matchRuleSObjectType

a character

-
matchingRule

a character

-
objectMapping

a ObjectMapping

- -
- -

EclairGeoData

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
maps

a EclairMap

-
masterLabel

a character

- -
- -

EclairMap

-
-
boundingBoxBottom

a numeric

-
boundingBoxLeft

a numeric

-
boundingBoxRight

a numeric

-
boundingBoxTop

a numeric

-
mapLabel

a character

-
mapName

a character

-
projection

a character

- -
- -

EmailFolder

-
-
accessType

a FolderAccessTypes (inherited from Folder)

-
folderShares

a FolderShare (inherited from Folder)

-
name

a character (inherited from Folder)

-
publicFolderAccess

a PublicFolderAccess (inherited from Folder)

-
sharedTo

a SharedTo (inherited from Folder)

- -
- -

EmailServicesAddress

-
-
authorizedSenders

a character

-
developerName

a character

-
isActive

a character either 'true' or 'false'

-
localPart

a character

-
runAsUser

a character

- -
- -

EmailServicesFunction

-
-
fullName

a character (inherited from Metadata)

-
apexClass

a character

-
attachmentOption

a EmailServicesAttOptions - which is a character taking one of the following values: -

    -

  • None

    • +
+ +
sortOrder
+

an integer

+ + +

DuplicateRuleFilter

+
booleanFilter
+

a character

+ +
duplicateRuleFilterItems
+

a DuplicateRuleFilterItem

+ + +

DuplicateRuleFilterItem

+
field
+

a character (inherited from FilterItem)

+ +
operation
+

a FilterOperation (inherited from FilterItem)

+ +
value
+

a character (inherited from FilterItem)

+ +
valueField
+

a character (inherited from FilterItem)

+ +
sortOrder
+

an integer

+ +
table
+

a character

+ + +

DuplicateRuleMatchRule

+
matchRuleSObjectType
+

a character

+ +
matchingRule
+

a character

+ +
objectMapping
+

a ObjectMapping

+ + +

EclairGeoData

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
maps
+

a EclairMap

+ +
masterLabel
+

a character

+ + +

EclairMap

+
boundingBoxBottom
+

a numeric

+ +
boundingBoxLeft
+

a numeric

+ +
boundingBoxRight
+

a numeric

+ +
boundingBoxTop
+

a numeric

+ +
mapLabel
+

a character

+ +
mapName
+

a character

+ +
projection
+

a character

+ + +

EmailFolder

+
accessType
+

a FolderAccessTypes (inherited from Folder)

+ +
folderShares
+

a FolderShare (inherited from Folder)

+ +
name
+

a character (inherited from Folder)

+ +
publicFolderAccess
+

a PublicFolderAccess (inherited from Folder)

+ +
sharedTo
+

a SharedTo (inherited from Folder)

+ + +

EmailServicesAddress

+
authorizedSenders
+

a character

+ +
developerName
+

a character

+ +
isActive
+

a character either 'true' or 'false'

+ +
localPart
+

a character

+ +
runAsUser
+

a character

+ + +

EmailServicesFunction

+
fullName
+

a character (inherited from Metadata)

+ +
apexClass
+

a character

+ +
attachmentOption
+

a EmailServicesAttOptions - which is a character taking one of the following values:

  • None

  • TextOnly

  • BinaryOnly

  • All

  • NoContent

    • -

-
authenticationFailureAction

a EmailServicesErrorAction - which is a character taking one of the following values: -

    -

  • UseSystemDefault

    • +
+ +
authenticationFailureAction
+

a EmailServicesErrorAction - which is a character taking one of the following values:

  • UseSystemDefault

  • Bounce

  • Discard

  • Requeue

    • -

-
authorizationFailureAction

a EmailServicesErrorAction - which is a character taking one of the following values: -

    -

  • UseSystemDefault

    • +
+ +
authorizationFailureAction
+

a EmailServicesErrorAction - which is a character taking one of the following values:

  • UseSystemDefault

  • Bounce

  • Discard

  • Requeue

    • -

-
authorizedSenders

a character

-
emailServicesAddresses

a EmailServicesAddress

-
errorRoutingAddress

a character

-
functionInactiveAction

a EmailServicesErrorAction - which is a character taking one of the following values: -

    -

  • UseSystemDefault

    • +
+ +
authorizedSenders
+

a character

+ +
emailServicesAddresses
+

a EmailServicesAddress

+ +
errorRoutingAddress
+

a character

+ +
functionInactiveAction
+

a EmailServicesErrorAction - which is a character taking one of the following values:

  • UseSystemDefault

  • Bounce

  • Discard

  • Requeue

    • -

-
functionName

a character

-
isActive

a character either 'true' or 'false'

-
isAuthenticationRequired

a character either 'true' or 'false'

-
isErrorRoutingEnabled

a character either 'true' or 'false'

-
isTextAttachmentsAsBinary

a character either 'true' or 'false'

-
isTlsRequired

a character either 'true' or 'false'

-
overLimitAction

a EmailServicesErrorAction - which is a character taking one of the following values: -

    -

  • UseSystemDefault

    • +
+ +
functionName
+

a character

+ +
isActive
+

a character either 'true' or 'false'

+ +
isAuthenticationRequired
+

a character either 'true' or 'false'

+ +
isErrorRoutingEnabled
+

a character either 'true' or 'false'

+ +
isTextAttachmentsAsBinary
+

a character either 'true' or 'false'

+ +
isTlsRequired
+

a character either 'true' or 'false'

+ +
overLimitAction
+

a EmailServicesErrorAction - which is a character taking one of the following values:

  • UseSystemDefault

  • Bounce

  • Discard

  • Requeue

    • -

- -
- -

EmailTemplate

-
-
content

a character formed using base64encode (inherited from MetadataWithContent)

-
apiVersion

a numeric

-
attachedDocuments

a character

-
attachments

a Attachment

-
available

a character either 'true' or 'false'

-
description

a character

-
encodingKey

a Encoding - which is a character taking one of the following values: -

    -

  • UTF-8

    • +
+ + +

EmailTemplate

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
apiVersion
+

a numeric

+ +
attachedDocuments
+

a character

+ +
attachments
+

a Attachment

+ +
available
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
encodingKey
+

a Encoding - which is a character taking one of the following values:

  • UTF-8

  • ISO-8859-1

  • Shift_JIS

  • ISO-2022-JP

    • @@ -2924,334 +4433,559 @@

    Details

  • GB2312

  • Big5-HKSCS

  • x-SJIS_0213

    • -

-
letterhead

a character

-
name

a character

-
packageVersions

a PackageVersion

-
relatedEntityType

a character

-
style

a EmailTemplateStyle - which is a character taking one of the following values: -

    -

  • none

    • +
+ +
letterhead
+

a character

+ +
name
+

a character

+ +
packageVersions
+

a PackageVersion

+ +
relatedEntityType
+

a character

+ +
style
+

a EmailTemplateStyle - which is a character taking one of the following values:

  • none

  • freeForm

  • formalLetter

  • promotionRight

  • promotionLeft

  • newsletter

  • products

    • -

-
subject

a character

-
textOnly

a character

-
type

a EmailTemplateType - which is a character taking one of the following values: -

    -

  • text

    • +
+ +
subject
+

a character

+ +
textOnly
+

a character

+ +
type
+

a EmailTemplateType - which is a character taking one of the following values:

  • text

  • html

  • custom

  • visualforce

    • -

-
uiType

a EmailTemplateUiType - which is a character taking one of the following values: -

    -

  • Aloha

    • +
+ +
uiType
+

a EmailTemplateUiType - which is a character taking one of the following values:

  • Aloha

  • SFX

  • SFX_Sample

    • -

+ -
-

EmailToCaseRoutingAddress

-
-
addressType

a EmailToCaseRoutingAddressType - which is a character taking one of the following values: -

    -

  • EmailToCase

    • +

EmailToCaseRoutingAddress

+
addressType
+

a EmailToCaseRoutingAddressType - which is a character taking one of the following values:

  • EmailToCase

  • Outlook

    • -

-
authorizedSenders

a character

-
caseOrigin

a character

-
caseOwner

a character

-
caseOwnerType

a character

-
casePriority

a character

-
createTask

a character either 'true' or 'false'

-
emailAddress

a character

-
emailServicesAddress

a character

-
isVerified

a character either 'true' or 'false'

-
routingName

a character

-
saveEmailHeaders

a character either 'true' or 'false'

-
taskStatus

a character

- -
- -

EmailToCaseSettings

-
-
enableE2CSourceTracking

a character either 'true' or 'false'

-
enableEmailToCase

a character either 'true' or 'false'

-
enableHtmlEmail

a character either 'true' or 'false'

-
enableOnDemandEmailToCase

a character either 'true' or 'false'

-
enableThreadIDInBody

a character either 'true' or 'false'

-
enableThreadIDInSubject

a character either 'true' or 'false'

-
notifyOwnerOnNewCaseEmail

a character either 'true' or 'false'

-
overEmailLimitAction

a EmailToCaseOnFailureActionType - which is a character taking one of the following values: -

    -

  • Bounce

    • +
+ +
authorizedSenders
+

a character

+ +
caseOrigin
+

a character

+ +
caseOwner
+

a character

+ +
caseOwnerType
+

a character

+ +
casePriority
+

a character

+ +
createTask
+

a character either 'true' or 'false'

+ +
emailAddress
+

a character

+ +
emailServicesAddress
+

a character

+ +
isVerified
+

a character either 'true' or 'false'

+ +
routingName
+

a character

+ +
saveEmailHeaders
+

a character either 'true' or 'false'

+ +
taskStatus
+

a character

+ + +

EmailToCaseSettings

+
enableE2CSourceTracking
+

a character either 'true' or 'false'

+ +
enableEmailToCase
+

a character either 'true' or 'false'

+ +
enableHtmlEmail
+

a character either 'true' or 'false'

+ +
enableOnDemandEmailToCase
+

a character either 'true' or 'false'

+ +
enableThreadIDInBody
+

a character either 'true' or 'false'

+ +
enableThreadIDInSubject
+

a character either 'true' or 'false'

+ +
notifyOwnerOnNewCaseEmail
+

a character either 'true' or 'false'

+ +
overEmailLimitAction
+

a EmailToCaseOnFailureActionType - which is a character taking one of the following values:

  • Bounce

  • Discard

  • Requeue

    • -

-
preQuoteSignature

a character either 'true' or 'false'

-
routingAddresses

a EmailToCaseRoutingAddress

-
unauthorizedSenderAction

a EmailToCaseOnFailureActionType - which is a character taking one of the following values: -

    -

  • Bounce

    • +
+ +
preQuoteSignature
+

a character either 'true' or 'false'

+ +
routingAddresses
+

a EmailToCaseRoutingAddress

+ +
unauthorizedSenderAction
+

a EmailToCaseOnFailureActionType - which is a character taking one of the following values:

  • Bounce

  • Discard

  • Requeue

    • -

- -
- -

EmbeddedServiceBranding

-
-
fullName

a character (inherited from Metadata)

-
contrastInvertedColor

a character

-
contrastPrimaryColor

a character

-
embeddedServiceConfig

a character

-
font

a character

-
masterLabel

a character

-
navBarColor

a character

-
primaryColor

a character

-
secondaryColor

a character

- -
- -

EmbeddedServiceConfig

-
-
fullName

a character (inherited from Metadata)

-
masterLabel

a character

-
site

a character

- -
- -

EmbeddedServiceFieldService

-
-
fullName

a character (inherited from Metadata)

-
appointmentBookingFlowName

a character

-
cancelApptBookingFlowName

a character

-
embeddedServiceConfig

a character

-
enabled

a character either 'true' or 'false'

-
fieldServiceConfirmCardImg

a character

-
fieldServiceHomeImg

a character

-
fieldServiceLogoImg

a character

-
masterLabel

a character

-
modifyApptBookingFlowName

a character

-
shouldShowExistingAppointment

a character either 'true' or 'false'

-
shouldShowNewAppointment

a character either 'true' or 'false'

- -
- -

EmbeddedServiceLiveAgent

-
-
fullName

a character (inherited from Metadata)

-
avatarImg

a character

-
customPrechatComponent

a character

-
embeddedServiceConfig

a character

-
embeddedServiceQuickActions

a EmbeddedServiceQuickAction

-
enabled

a character either 'true' or 'false'

-
fontSize

a EmbeddedServiceFontSize - which is a character taking one of the following values: -

    -

  • Small

    • +
+ + +

EmbeddedServiceBranding

+
fullName
+

a character (inherited from Metadata)

+ +
contrastInvertedColor
+

a character

+ +
contrastPrimaryColor
+

a character

+ +
embeddedServiceConfig
+

a character

+ +
font
+

a character

+ +
masterLabel
+

a character

+ +
navBarColor
+

a character

+ +
primaryColor
+

a character

+ +
secondaryColor
+

a character

+ + +

EmbeddedServiceConfig

+
fullName
+

a character (inherited from Metadata)

+ +
masterLabel
+

a character

+ +
site
+

a character

+ + +

EmbeddedServiceFieldService

+
fullName
+

a character (inherited from Metadata)

+ +
appointmentBookingFlowName
+

a character

+ +
cancelApptBookingFlowName
+

a character

+ +
embeddedServiceConfig
+

a character

+ +
enabled
+

a character either 'true' or 'false'

+ +
fieldServiceConfirmCardImg
+

a character

+ +
fieldServiceHomeImg
+

a character

+ +
fieldServiceLogoImg
+

a character

+ +
masterLabel
+

a character

+ +
modifyApptBookingFlowName
+

a character

+ +
shouldShowExistingAppointment
+

a character either 'true' or 'false'

+ +
shouldShowNewAppointment
+

a character either 'true' or 'false'

+ + +

EmbeddedServiceLiveAgent

+
fullName
+

a character (inherited from Metadata)

+ +
avatarImg
+

a character

+ +
customPrechatComponent
+

a character

+ +
embeddedServiceConfig
+

a character

+ +
embeddedServiceQuickActions
+

a EmbeddedServiceQuickAction

+ +
enabled
+

a character either 'true' or 'false'

+ +
fontSize
+

a EmbeddedServiceFontSize - which is a character taking one of the following values:

  • Small

  • Medium

  • Large

    • -

-
headerBackgroundImg

a character

-
liveAgentChatUrl

a character

-
liveAgentContentUrl

a character

-
liveChatButton

a character

-
liveChatDeployment

a character

-
masterLabel

a character

-
prechatBackgroundImg

a character

-
prechatEnabled

a character either 'true' or 'false'

-
prechatJson

a character

-
scenario

a EmbeddedServiceScenario - which is a character taking one of the following values: -

    -

  • Sales

    • +
+ +
headerBackgroundImg
+

a character

+ +
liveAgentChatUrl
+

a character

+ +
liveAgentContentUrl
+

a character

+ +
liveChatButton
+

a character

+ +
liveChatDeployment
+

a character

+ +
masterLabel
+

a character

+ +
prechatBackgroundImg
+

a character

+ +
prechatEnabled
+

a character either 'true' or 'false'

+ +
prechatJson
+

a character

+ +
scenario
+

a EmbeddedServiceScenario - which is a character taking one of the following values:

  • Sales

  • Service

  • Basic

    • -

-
smallCompanyLogoImg

a character

-
waitingStateBackgroundImg

a character

- -
- -

EmbeddedServiceQuickAction

-
-
embeddedServiceLiveAgent

a character

-
order

an integer

-
quickActionDefinition

a character

- -
- -

EntitlementProcess

-
-
fullName

a character (inherited from Metadata)

-
SObjectType

a character

-
active

a character either 'true' or 'false'

-
businessHours

a character

-
description

a character

-
entryStartDateField

a character

-
exitCriteriaBooleanFilter

a character

-
exitCriteriaFilterItems

a FilterItem

-
exitCriteriaFormula

a character

-
isRecordTypeApplied

a character either 'true' or 'false'

-
isVersionDefault

a character either 'true' or 'false'

-
milestones

a EntitlementProcessMilestoneItem

-
name

a character

-
recordType

a character

-
versionMaster

a character

-
versionNotes

a character

-
versionNumber

an integer

- -
- -

EntitlementProcessMilestoneItem

-
-
businessHours

a character

-
criteriaBooleanFilter

a character

-
milestoneCriteriaFilterItems

a FilterItem

-
milestoneCriteriaFormula

a character

-
milestoneName

a character

-
minutesCustomClass

a character

-
minutesToComplete

an integer

-
successActions

a WorkflowActionReference

-
timeTriggers

a EntitlementProcessMilestoneTimeTrigger

-
useCriteriaStartTime

a character either 'true' or 'false'

- -
- -

EntitlementProcessMilestoneTimeTrigger

-
-
actions

a WorkflowActionReference

-
timeLength

an integer

-
workflowTimeTriggerUnit

a MilestoneTimeUnits - which is a character taking one of the following values: -

    -

  • Minutes

    • -

  • Hours

    • -

  • Days

    • -

- -
- -

EntitlementSettings

-
-
fullName

a character (inherited from Metadata)

-
assetLookupLimitedToActiveEntitlementsOnAccount

a character either 'true' or 'false'

-
assetLookupLimitedToActiveEntitlementsOnContact

a character either 'true' or 'false'

-
assetLookupLimitedToSameAccount

a character either 'true' or 'false'

-
assetLookupLimitedToSameContact

a character either 'true' or 'false'

-
enableEntitlementVersioning

a character either 'true' or 'false'

-
enableEntitlements

a character either 'true' or 'false'

-
entitlementLookupLimitedToActiveStatus

a character either 'true' or 'false'

-
entitlementLookupLimitedToSameAccount

a character either 'true' or 'false'

-
entitlementLookupLimitedToSameAsset

a character either 'true' or 'false'

-
entitlementLookupLimitedToSameContact

a character either 'true' or 'false'

- -
- -

EntitlementTemplate

-
-
fullName

a character (inherited from Metadata)

-
businessHours

a character

-
casesPerEntitlement

an integer

-
entitlementProcess

a character

-
isPerIncident

a character either 'true' or 'false'

-
term

an integer

-
type

a character

- -
- -

EscalationAction

-
-
assignedTo

a character

-
assignedToTemplate

a character

-
assignedToType

a AssignToLookupValueType - which is a character taking one of the following values: -

    -

  • User

    • -

  • Queue

    • -

-
minutesToEscalation

an integer

-
notifyCaseOwner

a character either 'true' or 'false'

-
notifyEmail

a character

-
notifyTo

a character

-
notifyToTemplate

a character

- -
- -

EscalationRule

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
ruleEntry

a RuleEntry

- -
- -

EscalationRules

-
-
fullName

a character (inherited from Metadata)

-
escalationRule

a EscalationRule

- -
- -

EventDelivery

-
-
fullName

a character (inherited from Metadata)

-
eventParameters

a EventParameterMap

-
eventSubscription

a character

-
referenceData

a character

-
type

a EventDeliveryType - which is a character taking one of the following values: -

    -

  • StartFlow

    • -

  • ResumeFlow

    • -

+ -
+
smallCompanyLogoImg
+

a character

-

EventParameterMap

-
-
parameterName

a character

-
parameterValue

a character

+
waitingStateBackgroundImg
+

a character

-
-

EventSubscription

-
-
fullName

a character (inherited from Metadata)

-
active

a character either 'true' or 'false'

-
eventParameters

a EventParameterMap

-
eventType

a character

-
referenceData

a character

+

EmbeddedServiceQuickAction

+
embeddedServiceLiveAgent
+

a character

-
+
order
+

an integer

-

ExtendedErrorDetails

-
-
extendedErrorCode

a ExtendedErrorCode - which is a character taking one of the following values: -

    -

  • ACTIONCALL_DUPLICATE_INPUT_PARAM - Errors with this extended error code have the following properties: -actionCallName, parameterName

    • -

  • ACTIONCALL_DUPLICATE_OUTPUT_PARAM - Errors with this extended error code have the following properties: -actionCallName, parameterName

    • -

  • ACTIONCALL_MISSING_NAME - Errors with this extended error code have the following properties:

    • -

  • ACTIONCALL_MISSING_REQUIRED_PARAM - Errors with this extended error code have the following properties: -actionCallName, parameterName

    • -

  • ACTIONCALL_MISSING_REQUIRED_TYPE - Errors with this extended error code have the following properties: -actionCallName

    • -

  • ACTIONCALL_NOT_FOUND_WITH_NAME_AND_TYPE - Errors with this extended error code have the following properties:

    • -

  • ACTIONCALL_NOT_SUPPORTED_FOR_PROCESSTYPE - Errors with this extended error code have the following properties: -processType

    • -

  • APEXCALLOUT_INPUT_DUPLICATE - Errors with this extended error code have the following properties: -apexClassName, parameterName

    • -

  • APEXCALLOUT_INPUT_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: -apexClassName, parameterName

    • -

  • APEXCALLOUT_INVALID - Errors with this extended error code have the following properties: -apexClassName

    • -

  • APEXCALLOUT_MISSING_CLASSNAME - Errors with this extended error code have the following properties: -apexClassName

    • -

  • APEXCALLOUT_NOT_FOUND - Errors with this extended error code have the following properties: +

    quickActionDefinition
    +

    a character

    + + +

EntitlementProcess

+
fullName
+

a character (inherited from Metadata)

+ +
SObjectType
+

a character

+ +
active
+

a character either 'true' or 'false'

+ +
businessHours
+

a character

+ +
description
+

a character

+ +
entryStartDateField
+

a character

+ +
exitCriteriaBooleanFilter
+

a character

+ +
exitCriteriaFilterItems
+

a FilterItem

+ +
exitCriteriaFormula
+

a character

+ +
isRecordTypeApplied
+

a character either 'true' or 'false'

+ +
isVersionDefault
+

a character either 'true' or 'false'

+ +
milestones
+

a EntitlementProcessMilestoneItem

+ +
name
+

a character

+ +
recordType
+

a character

+ +
versionMaster
+

a character

+ +
versionNotes
+

a character

+ +
versionNumber
+

an integer

+ + +

EntitlementProcessMilestoneItem

+
businessHours
+

a character

+ +
criteriaBooleanFilter
+

a character

+ +
milestoneCriteriaFilterItems
+

a FilterItem

+ +
milestoneCriteriaFormula
+

a character

+ +
milestoneName
+

a character

+ +
minutesCustomClass
+

a character

+ +
minutesToComplete
+

an integer

+ +
successActions
+

a WorkflowActionReference

+ +
timeTriggers
+

a EntitlementProcessMilestoneTimeTrigger

+ +
useCriteriaStartTime
+

a character either 'true' or 'false'

+ + +

EntitlementProcessMilestoneTimeTrigger

+
actions
+

a WorkflowActionReference

+ +
timeLength
+

an integer

+ +
workflowTimeTriggerUnit
+

a MilestoneTimeUnits - which is a character taking one of the following values:

  • Minutes

    • +

  • Hours

    • +

  • Days

    • +
+ + +

EntitlementSettings

+
fullName
+

a character (inherited from Metadata)

+ +
assetLookupLimitedToActiveEntitlementsOnAccount
+

a character either 'true' or 'false'

+ +
assetLookupLimitedToActiveEntitlementsOnContact
+

a character either 'true' or 'false'

+ +
assetLookupLimitedToSameAccount
+

a character either 'true' or 'false'

+ +
assetLookupLimitedToSameContact
+

a character either 'true' or 'false'

+ +
enableEntitlementVersioning
+

a character either 'true' or 'false'

+ +
enableEntitlements
+

a character either 'true' or 'false'

+ +
entitlementLookupLimitedToActiveStatus
+

a character either 'true' or 'false'

+ +
entitlementLookupLimitedToSameAccount
+

a character either 'true' or 'false'

+ +
entitlementLookupLimitedToSameAsset
+

a character either 'true' or 'false'

+ +
entitlementLookupLimitedToSameContact
+

a character either 'true' or 'false'

+ + +

EntitlementTemplate

+
fullName
+

a character (inherited from Metadata)

+ +
businessHours
+

a character

+ +
casesPerEntitlement
+

an integer

+ +
entitlementProcess
+

a character

+ +
isPerIncident
+

a character either 'true' or 'false'

+ +
term
+

an integer

+ +
type
+

a character

+ + +

EscalationAction

+
assignedTo
+

a character

+ +
assignedToTemplate
+

a character

+ +
assignedToType
+

a AssignToLookupValueType - which is a character taking one of the following values:

  • User

    • +

  • Queue

    • +
+ +
minutesToEscalation
+

an integer

+ +
notifyCaseOwner
+

a character either 'true' or 'false'

+ +
notifyEmail
+

a character

+ +
notifyTo
+

a character

+ +
notifyToTemplate
+

a character

+ + +

EscalationRule

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
ruleEntry
+

a RuleEntry

+ + +

EscalationRules

+
fullName
+

a character (inherited from Metadata)

+ +
escalationRule
+

a EscalationRule

+ + +

EventDelivery

+
fullName
+

a character (inherited from Metadata)

+ +
eventParameters
+

a EventParameterMap

+ +
eventSubscription
+

a character

+ +
referenceData
+

a character

+ +
type
+

a EventDeliveryType - which is a character taking one of the following values:

  • StartFlow

    • +

  • ResumeFlow

    • +
+ + +

EventParameterMap

+
parameterName
+

a character

+ +
parameterValue
+

a character

+ + +

EventSubscription

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
eventParameters
+

a EventParameterMap

+ +
eventType
+

a character

+ +
referenceData
+

a character

+ + +

ExtendedErrorDetails

+
extendedErrorCode
+

a ExtendedErrorCode - which is a character taking one of the following values:

  • ACTIONCALL_DUPLICATE_INPUT_PARAM - Errors with this extended error code have the following properties: +actionCallName, parameterName

    • +

  • ACTIONCALL_DUPLICATE_OUTPUT_PARAM - Errors with this extended error code have the following properties: +actionCallName, parameterName

    • +

  • ACTIONCALL_MISSING_NAME - Errors with this extended error code have the following properties:

    • +

  • ACTIONCALL_MISSING_REQUIRED_PARAM - Errors with this extended error code have the following properties: +actionCallName, parameterName

    • +

  • ACTIONCALL_MISSING_REQUIRED_TYPE - Errors with this extended error code have the following properties: +actionCallName

    • +

  • ACTIONCALL_NOT_FOUND_WITH_NAME_AND_TYPE - Errors with this extended error code have the following properties:

    • +

  • ACTIONCALL_NOT_SUPPORTED_FOR_PROCESSTYPE - Errors with this extended error code have the following properties: +processType

    • +

  • APEXCALLOUT_INPUT_DUPLICATE - Errors with this extended error code have the following properties: +apexClassName, parameterName

    • +

  • APEXCALLOUT_INPUT_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: +apexClassName, parameterName

    • +

  • APEXCALLOUT_INVALID - Errors with this extended error code have the following properties: +apexClassName

    • +

  • APEXCALLOUT_MISSING_CLASSNAME - Errors with this extended error code have the following properties: +apexClassName

    • +

  • APEXCALLOUT_NOT_FOUND - Errors with this extended error code have the following properties: apexClassName

  • APEXCALLOUT_OUTPUT_INCOMPATIBLE_DATATYPE - Errors with this extended error code have the following properties: apexClassName, parameterName

    • @@ -3741,39 +5475,60 @@

    Details

  • WORKFLOW_RECURSIVECOUNTVARIABLE_DOESNT_SUPPORT_INPUT - Errors with this extended error code have the following properties: elementName

  • WORKFLOW_TRIGGERTYPE_INVALID_VALUE - Errors with this extended error code have the following properties:

    • -

- -
- -

ExternalDataSource

-
-
fullName

a character (inherited from Metadata)

-
authProvider

a character

-
certificate

a character

-
customConfiguration

a character

-
endpoint

a character

-
isWritable

a character either 'true' or 'false'

-
label

a character

-
oauthRefreshToken

a character

-
oauthScope

a character

-
oauthToken

a character

-
password

a character

-
principalType

a ExternalPrincipalType - which is a character taking one of the following values: -

    -

  • Anonymous

    • +
+ + +

ExternalDataSource

+
fullName
+

a character (inherited from Metadata)

+ +
authProvider
+

a character

+ +
certificate
+

a character

+ +
customConfiguration
+

a character

+ +
endpoint
+

a character

+ +
isWritable
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
oauthRefreshToken
+

a character

+ +
oauthScope
+

a character

+ +
oauthToken
+

a character

+ +
password
+

a character

+ +
principalType
+

a ExternalPrincipalType - which is a character taking one of the following values:

  • Anonymous

  • PerUser

  • NamedUser

    • -

-
protocol

a AuthenticationProtocol - which is a character taking one of the following values: -

    -

  • NoAuthentication

    • +
+ +
protocol
+

a AuthenticationProtocol - which is a character taking one of the following values:

  • NoAuthentication

  • Oauth

  • Password

    • -

-
repository

a character

-
type

a ExternalDataSourceType - which is a character taking one of the following values: -

    -

  • Datacloud

    • +
+ +
repository
+

a character

+ +
type
+

a ExternalDataSourceType - which is a character taking one of the following values:

  • Datacloud

  • Datajourney

  • OpenSearch

  • Identity

    • @@ -3784,30 +5539,44 @@

    Details

  • OData4

  • SimpleURL

  • Wrapper

    • -

-
username

a character

-
version

a character

- -
- -

ExternalServiceRegistration

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
label

a character

-
namedCredential

a character

-
schema

a character

-
schemaType

a character

-
schemaUrl

a character

-
status

a character

- -
- -

FeedFilterCriterion

-
-
feedItemType

a FeedItemType - which is a character taking one of the following values: -

    -

  • TrackedChange

    • +
+ +
username
+

a character

+ +
version
+

a character

+ + +

ExternalServiceRegistration

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
label
+

a character

+ +
namedCredential
+

a character

+ +
schema
+

a character

+ +
schemaType
+

a character

+ +
schemaUrl
+

a character

+ +
status
+

a character

+ + +

FeedFilterCriterion

+
feedItemType
+

a FeedItemType - which is a character taking one of the following values:

  • TrackedChange

  • UserStatus

  • TextPost

  • AdvancedTextPost

    • @@ -3836,28 +5605,31 @@

    Details

  • CreateRecordEvent

  • CanvasPost

  • AnnouncementPost

    • -

-
feedItemVisibility

a FeedItemVisibility - which is a character taking one of the following values: -

    -

  • AllUsers

    • +
+ +
feedItemVisibility
+

a FeedItemVisibility - which is a character taking one of the following values:

  • AllUsers

  • InternalUsers

    • -

-
relatedSObjectType

a character

- -
- -

FeedItemSettings

-
-
characterLimit

an integer

-
collapseThread

a character either 'true' or 'false'

-
displayFormat

a FeedItemDisplayFormat - which is a character taking one of the following values: -

    -

  • Default

    • +
+ +
relatedSObjectType
+

a character

+ + +

FeedItemSettings

+
characterLimit
+

an integer

+ +
collapseThread
+

a character either 'true' or 'false'

+ +
displayFormat
+

a FeedItemDisplayFormat - which is a character taking one of the following values:

  • Default

  • HideBlankLines

    • -

-
feedItemType

a FeedItemType - which is a character taking one of the following values: -

    -

  • TrackedChange

    • +
+ +
feedItemType
+

a FeedItemType - which is a character taking one of the following values:

  • TrackedChange

  • UserStatus

  • TextPost

  • AdvancedTextPost

    • @@ -3886,35 +5658,47 @@

    Details

  • CreateRecordEvent

  • CanvasPost

  • AnnouncementPost

    • -

+ + + +

FeedLayout

+
autocollapsePublisher
+

a character either 'true' or 'false'

-
+
compactFeed
+

a character either 'true' or 'false'

-

FeedLayout

-
-
autocollapsePublisher

a character either 'true' or 'false'

-
compactFeed

a character either 'true' or 'false'

-
feedFilterPosition

a FeedLayoutFilterPosition - which is a character taking one of the following values: -

    -

  • CenterDropDown

    • +
    feedFilterPosition
    +

    a FeedLayoutFilterPosition - which is a character taking one of the following values:

    • CenterDropDown

    • LeftFixed

    • LeftFloat

      • -

    -
    feedFilters

    a FeedLayoutFilter

    -
    fullWidthFeed

    a character either 'true' or 'false'

    -
    hideSidebar

    a character either 'true' or 'false'

    -
    highlightExternalFeedItems

    a character either 'true' or 'false'

    -
    leftComponents

    a FeedLayoutComponent

    -
    rightComponents

    a FeedLayoutComponent

    -
    useInlineFiltersInConsole

    a character either 'true' or 'false'

    - -
- -

FeedLayoutComponent

-
-
componentType

a FeedLayoutComponentType - which is a character taking one of the following values: -

    -

  • HelpAndToolLinks

    • +
+ +
feedFilters
+

a FeedLayoutFilter

+ +
fullWidthFeed
+

a character either 'true' or 'false'

+ +
hideSidebar
+

a character either 'true' or 'false'

+ +
highlightExternalFeedItems
+

a character either 'true' or 'false'

+ +
leftComponents
+

a FeedLayoutComponent

+ +
rightComponents
+

a FeedLayoutComponent

+ +
useInlineFiltersInConsole
+

a character either 'true' or 'false'

+ + +

FeedLayoutComponent

+
componentType
+

a FeedLayoutComponentType - which is a character taking one of the following values:

  • HelpAndToolLinks

  • CustomButtons

  • Following

  • Followers

    • @@ -3923,24 +5707,27 @@

    Details

  • Topics

  • CaseUnifiedFiles

  • Visualforce

    • -

-
height

an integer

-
page

a character

- -
- -

FeedLayoutFilter

-
-
feedFilterName

a character

-
feedFilterType

a FeedLayoutFilterType - which is a character taking one of the following values: -

    -

  • AllUpdates

    • +
+ +
height
+

an integer

+ +
page
+

a character

+ + +

FeedLayoutFilter

+
feedFilterName
+

a character

+ +
feedFilterType
+

a FeedLayoutFilterType - which is a character taking one of the following values:

  • AllUpdates

  • FeedItemType

  • Custom

    • -

-
feedItemType

a FeedItemType - which is a character taking one of the following values: -

    -

  • TrackedChange

    • +
+ +
feedItemType
+

a FeedItemType - which is a character taking one of the following values:

  • TrackedChange

  • UserStatus

  • TextPost

  • AdvancedTextPost

    • @@ -3969,127 +5756,178 @@

    Details

  • CreateRecordEvent

  • CanvasPost

  • AnnouncementPost

    • -

- -
- -

FieldMapping

-
-
SObjectType

a character

-
developerName

a character

-
fieldMappingRows

a FieldMappingRow

-
masterLabel

a character

- -
- -

FieldMappingField

-
-
dataServiceField

a character

-
dataServiceObjectName

a character

-
priority

an integer

- -
- -

FieldMappingRow

-
-
SObjectType

a character

-
fieldMappingFields

a FieldMappingField

-
fieldName

a character

-
mappingOperation

a MappingOperation - which is a character taking one of the following values: -

    -

  • Autofill

    • +
+ + +

FieldMapping

+
SObjectType
+

a character

+ +
developerName
+

a character

+ +
fieldMappingRows
+

a FieldMappingRow

+ +
masterLabel
+

a character

+ + +

FieldMappingField

+
dataServiceField
+

a character

+ +
dataServiceObjectName
+

a character

+ +
priority
+

an integer

+ + +

FieldMappingRow

+
SObjectType
+

a character

+ +
fieldMappingFields
+

a FieldMappingField

+ +
fieldName
+

a character

+ +
mappingOperation
+

a MappingOperation - which is a character taking one of the following values:

  • Autofill

  • Overwrite

    • -

- -
- -

FieldOverride

-
-
field

a character

-
formula

a character

-
literalValue

a character

- -
- -

FieldServiceSettings

-
-
fullName

a character (inherited from Metadata)

-
fieldServiceNotificationsOrgPref

a character either 'true' or 'false'

-
fieldServiceOrgPref

a character either 'true' or 'false'

-
serviceAppointmentsDueDateOffsetOrgValue

an integer

-
workOrderLineItemSearchFields

a character

-
workOrderSearchFields

a character

- -
- -

FieldSet

-
-
fullName

a character (inherited from Metadata)

-
availableFields

a FieldSetItem

-
description

a character

-
displayedFields

a FieldSetItem

-
label

a character

- -
- -

FieldSetItem

-
-
field

a character

-
isFieldManaged

a character either 'true' or 'false'

-
isRequired

a character either 'true' or 'false'

- -
- -

FieldSetTranslation

-
-
label

a character

-
name

a character

- -
- -

FieldValue

-
-
name

a character

-
value

a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)

- -
- -

FileProperties

-
-
createdById

a character

-
createdByName

a character

-
createdDate

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

-
fileName

a character

-
fullName

a character

-
id

a character

-
lastModifiedById

a character

-
lastModifiedByName

a character

-
lastModifiedDate

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

-
manageableState

a ManageableState - which is a character taking one of the following values: -

    -

  • released

    • +
+ + +

FieldOverride

+
field
+

a character

+ +
formula
+

a character

+ +
literalValue
+

a character

+ + +

FieldServiceSettings

+
fullName
+

a character (inherited from Metadata)

+ +
fieldServiceNotificationsOrgPref
+

a character either 'true' or 'false'

+ +
fieldServiceOrgPref
+

a character either 'true' or 'false'

+ +
serviceAppointmentsDueDateOffsetOrgValue
+

an integer

+ +
workOrderLineItemSearchFields
+

a character

+ +
workOrderSearchFields
+

a character

+ + +

FieldSet

+
fullName
+

a character (inherited from Metadata)

+ +
availableFields
+

a FieldSetItem

+ +
description
+

a character

+ +
displayedFields
+

a FieldSetItem

+ +
label
+

a character

+ + +

FieldSetItem

+
field
+

a character

+ +
isFieldManaged
+

a character either 'true' or 'false'

+ +
isRequired
+

a character either 'true' or 'false'

+ + +

FieldSetTranslation

+
label
+

a character

+ +
name
+

a character

+ + +

FieldValue

+
name
+

a character

+ +
value
+

a character that appears similar to any of the other accepted types (integer, numeric, date, datetime, boolean)

+ + +

FileProperties

+
createdById
+

a character

+ +
createdByName
+

a character

+ +
createdDate
+

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

+ +
fileName
+

a character

+ +
fullName
+

a character

+ +
id
+

a character

+ +
lastModifiedById
+

a character

+ +
lastModifiedByName
+

a character

+ +
lastModifiedDate
+

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

+ +
manageableState
+

a ManageableState - which is a character taking one of the following values:

  • released

  • deleted

  • deprecated

  • installed

  • beta

  • unmanaged

    • -

-
namespacePrefix

a character

-
type

a character

+ + +
namespacePrefix
+

a character

-
+
type
+

a character

-

FileTypeDispositionAssignmentBean

-
-
behavior

a FileDownloadBehavior - which is a character taking one of the following values: -

    -

  • DOWNLOAD

    • + +

FileTypeDispositionAssignmentBean

+
behavior
+

a FileDownloadBehavior - which is a character taking one of the following values:

  • DOWNLOAD

  • EXECUTE_IN_BROWSER

  • HYBRID

    • -

-
fileType

a FileType - which is a character taking one of the following values: -

    -

  • UNKNOWN

    • +
+ +
fileType
+

a FileType - which is a character taking one of the following values:

  • UNKNOWN

  • PDF

  • POWER_POINT

  • POWER_POINT_X

    • @@ -4200,25 +6038,29 @@

    Details

  • SQL

  • XHTML

  • EXCELT

    • -

-
securityRiskFileType

a character either 'true' or 'false'

+ + +
securityRiskFileType
+

a character either 'true' or 'false'

+ -
+

FileUploadAndDownloadSecuritySettings

+
fullName
+

a character (inherited from Metadata)

-

FileUploadAndDownloadSecuritySettings

-
-
fullName

a character (inherited from Metadata)

-
dispositions

a FileTypeDispositionAssignmentBean

-
noHtmlUploadAsAttachment

a character either 'true' or 'false'

+
dispositions
+

a FileTypeDispositionAssignmentBean

-
+
noHtmlUploadAsAttachment
+

a character either 'true' or 'false'

-

FilterItem

-
-
field

a character

-
operation

a FilterOperation - which is a character taking one of the following values: -

    -

  • equals

    • + +

FilterItem

+
field
+

a character

+ +
operation
+

a FilterOperation - which is a character taking one of the following values:

  • equals

  • notEqual

  • lessThan

  • greaterThan

    • @@ -4230,40 +6072,61 @@

    Details

  • includes

  • excludes

  • within

    • -

-
value

a character

-
valueField

a character

- -
- -

FindSimilarOppFilter

-
-
similarOpportunitiesDisplayColumns

a character

-
similarOpportunitiesMatchFields

a character

- -
- -

FiscalYearSettings

-
-
fiscalYearNameBasedOn

a character

-
startMonth

a character

- -
- -

FlexiPage

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
flexiPageRegions

a FlexiPageRegion

-
masterLabel

a character

-
parentFlexiPage

a character

-
platformActionlist

a PlatformActionList

-
quickActionList

a QuickActionList

-
sobjectType

a character

-
template

a FlexiPageTemplateInstance

-
type

a FlexiPageType - which is a character taking one of the following values: -

    -

  • AppPage

    • +
+ +
value
+

a character

+ +
valueField
+

a character

+ + +

FindSimilarOppFilter

+
similarOpportunitiesDisplayColumns
+

a character

+ +
similarOpportunitiesMatchFields
+

a character

+ + +

FiscalYearSettings

+
fiscalYearNameBasedOn
+

a character

+ +
startMonth
+

a character

+ + +

FlexiPage

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
flexiPageRegions
+

a FlexiPageRegion

+ +
masterLabel
+

a character

+ +
parentFlexiPage
+

a character

+ +
platformActionlist
+

a PlatformActionList

+ +
quickActionList
+

a QuickActionList

+ +
sobjectType
+

a character

+ +
template
+

a FlexiPageTemplateInstance

+ +
type
+

a FlexiPageType - which is a character taking one of the following values:

  • AppPage

  • ObjectPage

  • RecordPage

  • HomePage

    • @@ -4281,107 +6144,163 @@

    Details

  • CommThemeLayoutPage

  • UtilityBar

  • RecordPreview

    • -

+ -
-

FlexiPageRegion

-
-
appendable

a RegionFlagStatus - which is a character taking one of the following values: -

    -

  • disabled

    • +

FlexiPageRegion

+
appendable
+

a RegionFlagStatus - which is a character taking one of the following values:

  • disabled

  • enabled

    • -

-
componentInstances

a ComponentInstance

-
mode

a FlexiPageRegionMode - which is a character taking one of the following values: -

    -

  • Append

    • +
+ +
componentInstances
+

a ComponentInstance

+ +
mode
+

a FlexiPageRegionMode - which is a character taking one of the following values:

  • Append

  • Prepend

  • Replace

    • -

-
name

a character

-
prependable

a RegionFlagStatus - which is a character taking one of the following values: -

    -

  • disabled

    • +
+ +
name
+

a character

+ +
prependable
+

a RegionFlagStatus - which is a character taking one of the following values:

  • disabled

  • enabled

    • -

-
replaceable

a RegionFlagStatus - which is a character taking one of the following values: -

    -

  • disabled

    • +
+ +
replaceable
+

a RegionFlagStatus - which is a character taking one of the following values:

  • disabled

  • enabled

    • -

-
type

a FlexiPageRegionType - which is a character taking one of the following values: -

    -

  • Region

    • +
+ +
type
+

a FlexiPageRegionType - which is a character taking one of the following values:

  • Region

  • Facet

    • -

- -
- -

FlexiPageTemplateInstance

-
-
name

a character

-
properties

a ComponentInstanceProperty

- -
- -

Flow

-
-
fullName

a character (inherited from Metadata)

-
actionCalls

a FlowActionCall

-
apexPluginCalls

a FlowApexPluginCall

-
assignments

a FlowAssignment

-
choices

a FlowChoice

-
constants

a FlowConstant

-
decisions

a FlowDecision

-
description

a character

-
dynamicChoiceSets

a FlowDynamicChoiceSet

-
formulas

a FlowFormula

-
interviewLabel

a character

-
label

a character

-
loops

a FlowLoop

-
processMetadataValues

a FlowMetadataValue

-
processType

a FlowProcessType - which is a character taking one of the following values: -

    -

  • AutoLaunchedFlow

    • -

  • Flow

    • -

  • Workflow

    • -

  • CustomEvent

    • -

  • InvocableProcess

    • -

  • LoginFlow

    • -

  • ActionPlan

    • -

  • JourneyBuilderIntegration

    • -

  • UserProvisioningFlow

    • -

  • Survey

    • +
+ + +

FlexiPageTemplateInstance

+
name
+

a character

+ +
properties
+

a ComponentInstanceProperty

+ + +

Flow

+
fullName
+

a character (inherited from Metadata)

+ +
actionCalls
+

a FlowActionCall

+ +
apexPluginCalls
+

a FlowApexPluginCall

+ +
assignments
+

a FlowAssignment

+ +
choices
+

a FlowChoice

+ +
constants
+

a FlowConstant

+ +
decisions
+

a FlowDecision

+ +
description
+

a character

+ +
dynamicChoiceSets
+

a FlowDynamicChoiceSet

+ +
formulas
+

a FlowFormula

+ +
interviewLabel
+

a character

+ +
label
+

a character

+ +
loops
+

a FlowLoop

+ +
processMetadataValues
+

a FlowMetadataValue

+ +
processType
+

a FlowProcessType - which is a character taking one of the following values:

  • AutoLaunchedFlow

    • +

  • Flow

    • +

  • Workflow

    • +

  • CustomEvent

    • +

  • InvocableProcess

    • +

  • LoginFlow

    • +

  • ActionPlan

    • +

  • JourneyBuilderIntegration

    • +

  • UserProvisioningFlow

    • +

  • Survey

  • FieldServiceMobile

  • OrchestrationFlow

  • FieldServiceWeb

  • TransactionSecurityFlow

    • -

-
recordCreates

a FlowRecordCreate

-
recordDeletes

a FlowRecordDelete

-
recordLookups

a FlowRecordLookup

-
recordUpdates

a FlowRecordUpdate

-
screens

a FlowScreen

-
stages

a FlowStage

-
startElementReference

a character

-
steps

a FlowStep

-
subflows

a FlowSubflow

-
textTemplates

a FlowTextTemplate

-
variables

a FlowVariable

-
waits

a FlowWait

- -
- -

FlowActionCall

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
actionName

a character

-
actionType

a InvocableActionType - which is a character taking one of the following values: -

    -

  • apex

    • +
+ +
recordCreates
+

a FlowRecordCreate

+ +
recordDeletes
+

a FlowRecordDelete

+ +
recordLookups
+

a FlowRecordLookup

+ +
recordUpdates
+

a FlowRecordUpdate

+ +
screens
+

a FlowScreen

+ +
stages
+

a FlowStage

+ +
startElementReference
+

a character

+ +
steps
+

a FlowStep

+ +
subflows
+

a FlowSubflow

+ +
textTemplates
+

a FlowTextTemplate

+ +
variables
+

a FlowVariable

+ +
waits
+

a FlowWait

+ + +

FlowActionCall

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
actionName
+

a character

+ +
actionType
+

a InvocableActionType - which is a character taking one of the following values:

  • apex

  • chatterPost

  • contentWorkspaceEnableFolders

  • emailAlert

    • @@ -4403,113 +6322,162 @@

    Details

  • orchestrationDebugLog

  • choosePricebook

  • localAction

    • -

-
connector

a FlowConnector

-
faultConnector

a FlowConnector

-
inputParameters

a FlowActionCallInputParameter

-
outputParameters

a FlowActionCallOutputParameter

- -
- -

FlowActionCallInputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
name

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowActionCallOutputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
name

a character

- -
- -

FlowApexPluginCall

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
apexClass

a character

-
connector

a FlowConnector

-
faultConnector

a FlowConnector

-
inputParameters

a FlowApexPluginCallInputParameter

-
outputParameters

a FlowApexPluginCallOutputParameter

- -
- -

FlowApexPluginCallInputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
name

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowApexPluginCallOutputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
name

a character

- -
- -

FlowAssignment

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
assignmentItems

a FlowAssignmentItem

-
connector

a FlowConnector

- -
- -

FlowAssignmentItem

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
operator

a FlowAssignmentOperator - which is a character taking one of the following values: -

    -

  • Assign

    • +
+ +
connector
+

a FlowConnector

+ +
faultConnector
+

a FlowConnector

+ +
inputParameters
+

a FlowActionCallInputParameter

+ +
outputParameters
+

a FlowActionCallOutputParameter

+ + +

FlowActionCallInputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
name
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowActionCallOutputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
name
+

a character

+ + +

FlowApexPluginCall

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
apexClass
+

a character

+ +
connector
+

a FlowConnector

+ +
faultConnector
+

a FlowConnector

+ +
inputParameters
+

a FlowApexPluginCallInputParameter

+ +
outputParameters
+

a FlowApexPluginCallOutputParameter

+ + +

FlowApexPluginCallInputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
name
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowApexPluginCallOutputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
name
+

a character

+ + +

FlowAssignment

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
assignmentItems
+

a FlowAssignmentItem

+ +
connector
+

a FlowConnector

+ + +

FlowAssignmentItem

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
operator
+

a FlowAssignmentOperator - which is a character taking one of the following values:

  • Assign

  • Add

  • Subtract

  • AddItem

    • -

-
value

a FlowElementReferenceOrValue

+ -
+
value
+

a FlowElementReferenceOrValue

-

FlowBaseElement

-
-
processMetadataValues

a FlowMetadataValue

-
+

FlowBaseElement

+
processMetadataValues
+

a FlowMetadataValue

-

FlowCategory

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
flowCategoryItems

a FlowCategoryItems

-
masterLabel

a character

-
+

FlowCategory

+
fullName
+

a character (inherited from Metadata)

-

FlowCategoryItems

-
-
flow

a character

+
description
+

a character

-
+
flowCategoryItems
+

a FlowCategoryItems

-

FlowChoice

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
choiceText

a character

-
dataType

a FlowDataType - which is a character taking one of the following values: -

    -

  • Currency

    • +
    masterLabel
    +

    a character

    + + +

FlowCategoryItems

+
flow
+

a character

+ + +

FlowChoice

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
choiceText
+

a character

+ +
dataType
+

a FlowDataType - which is a character taking one of the following values:

  • Currency

  • Date

  • Number

  • String

    • @@ -4518,43 +6486,57 @@

    Details

  • DateTime

  • Picklist

  • Multipicklist

    • -

-
userInput

a FlowChoiceUserInput

-
value

a FlowElementReferenceOrValue

- -
- -

FlowChoiceTranslation

-
-
choiceText

a character

-
name

a character

-
userInput

a FlowChoiceUserInputTranslation

- -
- -

FlowChoiceUserInput

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
isRequired

a character either 'true' or 'false'

-
promptText

a character

-
validationRule

a FlowInputValidationRule

- -
- -

FlowChoiceUserInputTranslation

-
-
promptText

a character

-
validationRule

a FlowInputValidationRuleTranslation

- -
- -

FlowCondition

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
leftValueReference

a character

-
operator

a FlowComparisonOperator - which is a character taking one of the following values: -

    -

  • EqualTo

    • +
+ +
userInput
+

a FlowChoiceUserInput

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowChoiceTranslation

+
choiceText
+

a character

+ +
name
+

a character

+ +
userInput
+

a FlowChoiceUserInputTranslation

+ + +

FlowChoiceUserInput

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
isRequired
+

a character either 'true' or 'false'

+ +
promptText
+

a character

+ +
validationRule
+

a FlowInputValidationRule

+ + +

FlowChoiceUserInputTranslation

+
promptText
+

a character

+ +
validationRule
+

a FlowInputValidationRuleTranslation

+ + +

FlowCondition

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
leftValueReference
+

a character

+ +
operator
+

a FlowComparisonOperator - which is a character taking one of the following values:

  • EqualTo

  • NotEqualTo

  • GreaterThan

  • LessThan

    • @@ -4567,73 +6549,29 @@

    Details

  • WasSet

  • WasSelected

  • WasVisited

    • -

-
rightValue

a FlowElementReferenceOrValue

+ -
+
rightValue
+

a FlowElementReferenceOrValue

-

FlowConnector

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
targetReference

a character

-
+

FlowConnector

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

-

FlowConstant

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
dataType

a FlowDataType - which is a character taking one of the following values: -

    -

  • Currency

    • -

  • Date

    • -

  • Number

    • -

  • String

    • -

  • Boolean

    • -

  • SObject

    • -

  • DateTime

    • -

  • Picklist

    • -

  • Multipicklist

    • -

-
value

a FlowElementReferenceOrValue

- -
- -

FlowDecision

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
defaultConnector

a FlowConnector

-
defaultConnectorLabel

a character

-
rules

a FlowRule

- -
- -

FlowDefinition

-
-
fullName

a character (inherited from Metadata)

-
activeVersionNumber

an integer

-
description

a character

-
masterLabel

a character

- -
- -

FlowDefinitionTranslation

-
-
flows

a FlowTranslation

-
fullName

a character

-
label

a character

- -
- -

FlowDynamicChoiceSet

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
dataType

a FlowDataType - which is a character taking one of the following values: -

    -

  • Currency

    • +
    targetReference
    +

    a character

    + + +

FlowConstant

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
dataType
+

a FlowDataType - which is a character taking one of the following values:

  • Currency

  • Date

  • Number

  • String

    • @@ -4642,50 +6580,66 @@

    Details

  • DateTime

  • Picklist

  • Multipicklist

    • -

-
displayField

a character

-
filters

a FlowRecordFilter

-
limit

an integer

-
object

a character

-
outputAssignments

a FlowOutputFieldAssignment

-
picklistField

a character

-
picklistObject

a character

-
sortField

a character

-
sortOrder

a SortOrder - which is a character taking one of the following values: -

    -

  • Asc

    • -

  • Desc

    • -

-
valueField

a character

- -
- -

FlowElement

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
description

a character

-
name

a character

- -
- -

FlowElementReferenceOrValue

-
-
booleanValue

a character either 'true' or 'false'

-
dateTimeValue

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

-
dateValue

a character formatted as 'yyyy-mm-dd'

-
elementReference

a character

-
numberValue

a numeric

-
stringValue

a character

- -
- -

FlowFormula

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
dataType

a FlowDataType - which is a character taking one of the following values: -

    -

  • Currency

    • +
+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowDecision

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
defaultConnector
+

a FlowConnector

+ +
defaultConnectorLabel
+

a character

+ +
rules
+

a FlowRule

+ + +

FlowDefinition

+
fullName
+

a character (inherited from Metadata)

+ +
activeVersionNumber
+

an integer

+ +
description
+

a character

+ +
masterLabel
+

a character

+ + +

FlowDefinitionTranslation

+
flows
+

a FlowTranslation

+ +
fullName
+

a character

+ +
label
+

a character

+ + +

FlowDynamicChoiceSet

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
dataType
+

a FlowDataType - which is a character taking one of the following values:

  • Currency

  • Date

  • Number

  • String

    • @@ -4694,355 +6648,81 @@

    Details

  • DateTime

  • Picklist

  • Multipicklist

    • -

-
expression

a character

-
scale

an integer

- -
- -

FlowInputFieldAssignment

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
field

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowInputValidationRule

-
-
errorMessage

a character

-
formulaExpression

a character

- -
- -

FlowInputValidationRuleTranslation

-
-
errorMessage

a character

- -
- -

FlowLoop

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
assignNextValueToReference

a character

-
collectionReference

a character

-
iterationOrder

a IterationOrder - which is a character taking one of the following values: -

    -

  • Asc

    • -

  • Desc

    • -

-
nextValueConnector

a FlowConnector

-
noMoreValuesConnector

a FlowConnector

- -
- -

FlowMetadataValue

-
-
name

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowNode

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
label

a character

-
locationX

an integer

-
locationY

an integer

- -
- -

FlowOutputFieldAssignment

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
field

a character

- -
- -

FlowRecordCreate

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
assignRecordIdToReference

a character

-
connector

a FlowConnector

-
faultConnector

a FlowConnector

-
inputAssignments

a FlowInputFieldAssignment

-
inputReference

a character

-
object

a character

- -
- -

FlowRecordDelete

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
connector

a FlowConnector

-
faultConnector

a FlowConnector

-
filters

a FlowRecordFilter

-
inputReference

a character

-
object

a character

- -
- -

FlowRecordFilter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
field

a character

-
operator

a FlowRecordFilterOperator - which is a character taking one of the following values: -

    -

  • EqualTo

    • -

  • NotEqualTo

    • -

  • GreaterThan

    • -

  • LessThan

    • -

  • GreaterThanOrEqualTo

    • -

  • LessThanOrEqualTo

    • -

  • StartsWith

    • -

  • EndsWith

    • -

  • Contains

    • -

  • IsNull

    • -

-
value

a FlowElementReferenceOrValue

- -
- -

FlowRecordLookup

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
assignNullValuesIfNoRecordsFound

a character either 'true' or 'false'

-
connector

a FlowConnector

-
faultConnector

a FlowConnector

-
filters

a FlowRecordFilter

-
object

a character

-
outputAssignments

a FlowOutputFieldAssignment

-
outputReference

a character

-
queriedFields

a character

-
sortField

a character

-
sortOrder

a SortOrder - which is a character taking one of the following values: -

    -

  • Asc

    • +
+ +
displayField
+

a character

+ +
filters
+

a FlowRecordFilter

+ +
limit
+

an integer

+ +
object
+

a character

+ +
outputAssignments
+

a FlowOutputFieldAssignment

+ +
picklistField
+

a character

+ +
picklistObject
+

a character

+ +
sortField
+

a character

+ +
sortOrder
+

a SortOrder - which is a character taking one of the following values:

  • Asc

  • Desc

    • -

- -
- -

FlowRecordUpdate

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
connector

a FlowConnector

-
faultConnector

a FlowConnector

-
filters

a FlowRecordFilter

-
inputAssignments

a FlowInputFieldAssignment

-
inputReference

a character

-
object

a character

- -
- -

FlowRule

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
conditionLogic

a character

-
conditions

a FlowCondition

-
connector

a FlowConnector

-
label

a character

- -
- -

FlowScreen

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
allowBack

a character either 'true' or 'false'

-
allowFinish

a character either 'true' or 'false'

-
allowPause

a character either 'true' or 'false'

-
connector

a FlowConnector

-
fields

a FlowScreenField

-
helpText

a character

-
pausedText

a character

-
rules

a FlowScreenRule

-
showFooter

a character either 'true' or 'false'

-
showHeader

a character either 'true' or 'false'

- -
- -

FlowScreenField

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
choiceReferences

a character

-
dataType

a FlowDataType - which is a character taking one of the following values: -

    -

  • Currency

    • -

  • Date

    • -

  • Number

    • -

  • String

    • -

  • Boolean

    • -

  • SObject

    • -

  • DateTime

    • -

  • Picklist

    • -

  • Multipicklist

    • -

-
defaultSelectedChoiceReference

a character

-
defaultValue

a FlowElementReferenceOrValue

-
extensionName

a character

-
fieldText

a character

-
fieldType

a FlowScreenFieldType - which is a character taking one of the following values: -

    -

  • DisplayText

    • -

  • InputField

    • -

  • LargeTextArea

    • -

  • PasswordField

    • -

  • RadioButtons

    • -

  • DropdownBox

    • -

  • MultiSelectCheckboxes

    • -

  • MultiSelectPicklist

    • -

  • ComponentInstance

    • -

-
helpText

a character

-
inputParameters

a FlowScreenFieldInputParameter

-
isRequired

a character either 'true' or 'false'

-
isVisible

a character either 'true' or 'false'

-
outputParameters

a FlowScreenFieldOutputParameter

-
scale

an integer

-
validationRule

a FlowInputValidationRule

- -
- -

FlowScreenFieldInputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
name

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowScreenFieldOutputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
name

a character

- -
- -

FlowScreenFieldTranslation

-
-
fieldText

a character

-
helpText

a character

-
name

a character

-
validationRule

a FlowInputValidationRuleTranslation

- -
- -

FlowScreenRule

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
conditionLogic

a character

-
conditions

a FlowCondition

-
label

a character

-
ruleActions

a FlowScreenRuleAction

- -
- -

FlowScreenRuleAction

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
attribute

a character

-
fieldReference

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowScreenTranslation

-
-
fields

a FlowScreenFieldTranslation

-
helpText

a character

-
name

a character

-
pausedText

a character

- -
- -

FlowStage

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
isActive

a character either 'true' or 'false'

-
label

a character

-
stageOrder

an integer

- -
- -

FlowStep

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
connectors

a FlowConnector

- -
- -

FlowSubflow

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
connector

a FlowConnector

-
flowName

a character

-
inputAssignments

a FlowSubflowInputAssignment

-
outputAssignments

a FlowSubflowOutputAssignment

- -
- -

FlowSubflowInputAssignment

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
name

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowSubflowOutputAssignment

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
name

a character

- -
- -

FlowTextTemplate

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
text

a character

- -
- -

FlowTranslation

-
-
choices

a FlowChoiceTranslation

-
fullName

a character

-
label

a character

-
screens

a FlowScreenTranslation

- -
- -

FlowVariable

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
dataType

a FlowDataType - which is a character taking one of the following values: -

    -

  • Currency

    • +
+ +
valueField
+

a character

+ + +

FlowElement

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
description
+

a character

+ +
name
+

a character

+ + +

FlowElementReferenceOrValue

+
booleanValue
+

a character either 'true' or 'false'

+ +
dateTimeValue
+

a character formatted as 'yyyy-mm-ddThh:mm:ssZ'

+ +
dateValue
+

a character formatted as 'yyyy-mm-dd'

+ +
elementReference
+

a character

+ +
numberValue
+

a numeric

+ +
stringValue
+

a character

+ + +

FlowFormula

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
dataType
+

a FlowDataType - which is a character taking one of the following values:

  • Currency

  • Date

  • Number

  • String

    • @@ -5051,828 +6731,2288 @@

    Details

  • DateTime

  • Picklist

  • Multipicklist

    • -

-
isCollection

a character either 'true' or 'false'

-
isInput

a character either 'true' or 'false'

-
isOutput

a character either 'true' or 'false'

-
objectType

a character

-
scale

an integer

-
value

a FlowElementReferenceOrValue

- -
- -

FlowWait

-
-
label

a character (inherited from FlowNode)

-
locationX

an integer (inherited from FlowNode)

-
locationY

an integer (inherited from FlowNode)

-
defaultConnector

a FlowConnector

-
defaultConnectorLabel

a character

-
faultConnector

a FlowConnector

-
waitEvents

a FlowWaitEvent

- -
- -

FlowWaitEvent

-
-
description

a character (inherited from FlowElement)

-
name

a character (inherited from FlowElement)

-
conditionLogic

a character

-
conditions

a FlowCondition

-
connector

a FlowConnector

-
eventType

a character

-
inputParameters

a FlowWaitEventInputParameter

-
label

a character

-
outputParameters

a FlowWaitEventOutputParameter

- -
- -

FlowWaitEventInputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
name

a character

-
value

a FlowElementReferenceOrValue

- -
- -

FlowWaitEventOutputParameter

-
-
processMetadataValues

a FlowMetadataValue (inherited from FlowBaseElement)

-
assignToReference

a character

-
name

a character

- -
- -

Folder

-
-
fullName

a character (inherited from Metadata)

-
accessType

a FolderAccessTypes - which is a character taking one of the following values: -

    -

  • Shared

    • -

  • Public

    • -

  • Hidden

    • -

  • PublicInternal

    • -

-
folderShares

a FolderShare

-
name

a character

-
publicFolderAccess

a PublicFolderAccess - which is a character taking one of the following values: -

    -

  • ReadOnly

    • -

  • ReadWrite

    • -

-
sharedTo

a SharedTo

+ -
+
expression
+

a character

-

FolderShare

-
-
accessLevel

a FolderShareAccessLevel - which is a character taking one of the following values: -

    -

  • View

    • -

  • EditAllContents

    • -

  • Manage

    • -

-
sharedTo

a character

-
sharedToType

a FolderSharedToType - which is a character taking one of the following values: -

    -

  • Group

    • -

  • Role

    • -

  • RoleAndSubordinates

    • -

  • RoleAndSubordinatesInternal

    • -

  • Manager

    • -

  • ManagerAndSubordinatesInternal

    • -

  • Organization

    • -

  • Territory

    • -

  • TerritoryAndSubordinates

    • -

  • AllPrmUsers

    • -

  • User

    • -

  • PartnerUser

    • -

  • AllCspUsers

    • -

  • CustomerPortalUser

    • -

  • PortalRole

    • -

  • PortalRoleAndSubordinates

    • -

  • ChannelProgramGroup

    • -

+
scale
+

an integer

-
-

ForecastingCategoryMapping

-
-
forecastingItemCategoryApiName

a character

-
weightedSourceCategories

a WeightedSourceCategory

+

FlowInputFieldAssignment

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

-
+
field
+

a character

-

ForecastingDisplayedFamilySettings

-
-
productFamily

a character

+
value
+

a FlowElementReferenceOrValue

-
-

ForecastingSettings

-
-
fullName

a character (inherited from Metadata)

-
displayCurrency

a DisplayCurrency - which is a character taking one of the following values: -

    -

  • CORPORATE

    • -

  • PERSONAL

    • -

-
enableForecasts

a character either 'true' or 'false'

-
forecastingCategoryMappings

a ForecastingCategoryMapping

-
forecastingDisplayedFamilySettings

a ForecastingDisplayedFamilySettings

-
forecastingTypeSettings

a ForecastingTypeSettings

- -
- -

ForecastingTypeSettings

-
-
active

a character either 'true' or 'false'

-
adjustmentsSettings

a AdjustmentsSettings

-
displayedCategoryApiNames

a character

-
forecastRangeSettings

a ForecastRangeSettings

-
forecastedCategoryApiNames

a character

-
forecastingDateType

a ForecastingDateType - which is a character taking one of the following values: -

    -

  • OpportunityCloseDate

    • -

  • ProductDate

    • -

  • ScheduleDate

    • -

-
hasProductFamily

a character either 'true' or 'false'

-
isAmount

a character either 'true' or 'false'

-
isAvailable

a character either 'true' or 'false'

-
isQuantity

a character either 'true' or 'false'

-
managerAdjustableCategoryApiNames

a character

-
masterLabel

a character

-
name

a character

-
opportunityListFieldsLabelMappings

a OpportunityListFieldsLabelMapping

-
opportunityListFieldsSelectedSettings

a OpportunityListFieldsSelectedSettings

-
opportunityListFieldsUnselectedSettings

a OpportunityListFieldsUnselectedSettings

-
opportunitySplitName

a character

-
ownerAdjustableCategoryApiNames

a character

-
quotasSettings

a QuotasSettings

-
territory2ModelName

a character

- -
- -

ForecastRangeSettings

-
-
beginning

an integer

-
displaying

an integer

-
periodType

a PeriodTypes - which is a character taking one of the following values: -

    -

  • Month

    • -

  • Quarter

    • -

  • Week

    • -

  • Year

    • -

- -
- -

GlobalPicklistValue

-
-
fullName

a character (inherited from Metadata)

-
color

a character

-
default

a character either 'true' or 'false'

-
description

a character

-
isActive

a character either 'true' or 'false'

- -
- -

GlobalQuickActionTranslation

-
-
label

a character

-
name

a character

- -
- -

GlobalValueSet

-
-
fullName

a character (inherited from Metadata)

-
customValue

a CustomValue

-
description

a character

-
masterLabel

a character

-
sorted

a character either 'true' or 'false'

- -
- -

GlobalValueSetTranslation

-
-
fullName

a character (inherited from Metadata)

-
valueTranslation

a ValueTranslation

- -
- -

Group

-
-
fullName

a character (inherited from Metadata)

-
doesIncludeBosses

a character either 'true' or 'false'

-
name

a character

- -
- -

HistoryRetentionPolicy

-
-
archiveAfterMonths

an integer

-
archiveRetentionYears

an integer

-
description

a character

- -
- -

Holiday

-
-
activityDate

a character formatted as 'yyyy-mm-dd'

-
businessHours

a character

-
description

a character

-
endTime

a character formatted as 'hh:mm:ssZ

-
isRecurring

a character either 'true' or 'false'

-
name

a character

-
recurrenceDayOfMonth

an integer

-
recurrenceDayOfWeek

a character

-
recurrenceDayOfWeekMask

an integer

-
recurrenceEndDate

a character formatted as 'yyyy-mm-dd'

-
recurrenceInstance

a character

-
recurrenceInterval

an integer

-
recurrenceMonthOfYear

a character

-
recurrenceStartDate

a character formatted as 'yyyy-mm-dd'

-
recurrenceType

a character

-
startTime

a character formatted as 'hh:mm:ssZ

- -
- -

HomePageComponent

-
-
fullName

a character (inherited from Metadata)

-
body

a character

-
height

an integer

-
links

a character

-
page

a character

-
pageComponentType

a PageComponentType - which is a character taking one of the following values: -

    -

  • links

    • -

  • htmlArea

    • -

  • imageOrNote

    • -

  • visualforcePage

    • -

-
showLabel

a character either 'true' or 'false'

-
showScrollbars

a character either 'true' or 'false'

-
width

a PageComponentWidth - which is a character taking one of the following values: -

    -

  • narrow

    • -

  • wide

    • -

- -
- -

HomePageLayout

-
-
fullName

a character (inherited from Metadata)

-
narrowComponents

a character

-
wideComponents

a character

- -
- -

IdeaReputationLevel

-
-
name

a character

-
value

an integer

- -
- -

IdeasSettings

-
-
fullName

a character (inherited from Metadata)

-
enableChatterProfile

a character either 'true' or 'false'

-
enableIdeaThemes

a character either 'true' or 'false'

-
enableIdeas

a character either 'true' or 'false'

-
enableIdeasReputation

a character either 'true' or 'false'

-
halfLife

a numeric

-
ideasProfilePage

a character

- -
- -

Index

-
-
fullName

a character (inherited from Metadata)

-
fields

a IndexField

-
label

a character

- -
- -

IndexField

-
-
name

a character

-
sortDirection

a character

- -
- -

InsightType

-
-
fullName

a character (inherited from Metadata)

-
defaultTrendType

a InsightTrendType - which is a character taking one of the following values: -

    -

  • Positive

    • -

  • Negative

    • -

  • Informational

    • -

  • Suggestion

    • -

-
description

a character

-
isProtected

a character either 'true' or 'false'

-
masterLabel

a character

-
parentType

a InsightParentType - which is a character taking one of the following values: -

    -

  • Opportunity

    • -

  • Account

    • -

-
title

a character

- -
- -

InstalledPackage

-
-
fullName

a character (inherited from Metadata)

-
password

a character

-
versionNumber

a character

- -
- -

IntegrationHubSettings

-
-
fullName

a character (inherited from Metadata)

-
canonicalName

a character

-
canonicalNameBindingChar

a character

-
description

a character

-
isEnabled

a character either 'true' or 'false'

-
isProtected

a character either 'true' or 'false'

-
masterLabel

a character

-
setupData

a character

-
setupDefinition

a character

-
setupNamespace

a character

-
setupSimpleName

a character

-
uUID

a character

-
version

a character

-
versionBuild

an integer

-
versionMajor

an integer

-
versionMinor

an integer

- -
- -

IntegrationHubSettingsType

-
-
fullName

a character (inherited from Metadata)

-
canonicalName

a character

-
canonicalNameBindingChar

a character

-
description

a character

-
isEnabled

a character either 'true' or 'false'

-
isProtected

a character either 'true' or 'false'

-
masterLabel

a character

-
setupNamespace

a character

-
setupSimpleName

a character

-
uUID

a character

-
version

a character

-
versionBuild

an integer

-
versionMajor

an integer

-
versionMinor

an integer

- -
- -

IpRange

-
-
description

a character

-
end

a character

-
start

a character

- -
- -

KeyboardShortcuts

-
-
customShortcuts

a CustomShortcut

-
defaultShortcuts

a DefaultShortcut

- -
- -

Keyword

-
-
keyword

a character

- -
- -

KeywordList

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
keywords

a Keyword

-
masterLabel

a character

- -
- -

KnowledgeAnswerSettings

-
-
assignTo

a character

-
defaultArticleType

a character

-
enableArticleCreation

a character either 'true' or 'false'

- -
- -

KnowledgeCaseField

-
-
name

a character

- -
- -

KnowledgeCaseFieldsSettings

-
-
field

a KnowledgeCaseField

- -
- -

KnowledgeCaseSettings

-
-
articlePDFCreationProfile

a character

-
articlePublicSharingCommunities

a KnowledgeCommunitiesSettings

-
articlePublicSharingSites

a KnowledgeSitesSettings

-
articlePublicSharingSitesChatterAnswers

a KnowledgeSitesSettings

-
assignTo

a character

-
customizationClass

a character

-
defaultContributionArticleType

a character

-
editor

a KnowledgeCaseEditor - which is a character taking one of the following values: -

    -

  • simple

    • -

  • standard

    • -

-
enableArticleCreation

a character either 'true' or 'false'

-
enableArticlePublicSharingSites

a character either 'true' or 'false'

-
enableCaseDataCategoryMapping

a character either 'true' or 'false'

-
useProfileForPDFCreation

a character either 'true' or 'false'

- -
- -

KnowledgeCommunitiesSettings

-
-
community

a character

- -
- -

KnowledgeLanguage

-
-
active

a character either 'true' or 'false'

-
defaultAssignee

a character

-
defaultAssigneeType

a KnowledgeLanguageLookupValueType - which is a character taking one of the following values: -

    -

  • User

    • -

  • Queue

    • -

-
defaultReviewer

a character

-
defaultReviewerType

a KnowledgeLanguageLookupValueType - which is a character taking one of the following values: -

    -

  • User

    • -

  • Queue

    • -

-
name

a character

- -
- -

KnowledgeLanguageSettings

-
-
language

a KnowledgeLanguage

- -
- -

KnowledgeSettings

-
-
fullName

a character (inherited from Metadata)

-
answers

a KnowledgeAnswerSettings

-
cases

a KnowledgeCaseSettings

-
defaultLanguage

a character

-
enableChatterQuestionKBDeflection

a character either 'true' or 'false'

-
enableCreateEditOnArticlesTab

a character either 'true' or 'false'

-
enableExternalMediaContent

a character either 'true' or 'false'

-
enableKnowledge

a character either 'true' or 'false'

-
enableLightningKnowledge

a character either 'true' or 'false'

-
languages

a KnowledgeLanguageSettings

-
showArticleSummariesCustomerPortal

a character either 'true' or 'false'

-
showArticleSummariesInternalApp

a character either 'true' or 'false'

-
showArticleSummariesPartnerPortal

a character either 'true' or 'false'

-
showValidationStatusField

a character either 'true' or 'false'

-
suggestedArticles

a KnowledgeSuggestedArticlesSettings

- -
- -

KnowledgeSitesSettings

-
-
site

a character

- -
- -

KnowledgeSuggestedArticlesSettings

-
-
caseFields

a KnowledgeCaseFieldsSettings

-
useSuggestedArticlesForCase

a character either 'true' or 'false'

-
workOrderFields

a KnowledgeWorkOrderFieldsSettings

-
workOrderLineItemFields

a KnowledgeWorkOrderLineItemFieldsSettings

- -
- -

KnowledgeWorkOrderField

-
-
name

a character

- -
- -

KnowledgeWorkOrderFieldsSettings

-
-
field

a KnowledgeWorkOrderField

- -
- -

KnowledgeWorkOrderLineItemField

-
-
name

a character

- -
- -

KnowledgeWorkOrderLineItemFieldsSettings

-
-
field

a KnowledgeWorkOrderLineItemField

- -
- -

Layout

-
-
fullName

a character (inherited from Metadata)

-
customButtons

a character

-
customConsoleComponents

a CustomConsoleComponents

-
emailDefault

a character either 'true' or 'false'

-
excludeButtons

a character

-
feedLayout

a FeedLayout

-
headers

a LayoutHeader - which is a character taking one of the following values: -

    -

  • PersonalTagging

    • -

  • PublicTagging

    • -

-
layoutSections

a LayoutSection

-
miniLayout

a MiniLayout

-
multilineLayoutFields

a character

-
platformActionList

a PlatformActionList

-
quickActionList

a QuickActionList

-
relatedContent

a RelatedContent

-
relatedLists

a RelatedListItem

-
relatedObjects

a character

-
runAssignmentRulesDefault

a character either 'true' or 'false'

-
showEmailCheckbox

a character either 'true' or 'false'

-
showHighlightsPanel

a character either 'true' or 'false'

-
showInteractionLogPanel

a character either 'true' or 'false'

-
showKnowledgeComponent

a character either 'true' or 'false'

-
showRunAssignmentRulesCheckbox

a character either 'true' or 'false'

-
showSolutionSection

a character either 'true' or 'false'

-
showSubmitAndAttachButton

a character either 'true' or 'false'

-
summaryLayout

a SummaryLayout

- -
- -

LayoutColumn

-
-
layoutItems

a LayoutItem

-
reserved

a character

- -
- -

LayoutItem

-
-
analyticsCloudComponent

a AnalyticsCloudComponentLayoutItem

-
behavior

a UiBehavior - which is a character taking one of the following values: -

    -

  • Edit

    • -

  • Required

    • -

  • Readonly

    • -

-
canvas

a character

-
component

a character

-
customLink

a character

-
emptySpace

a character either 'true' or 'false'

-
field

a character

-
height

an integer

-
page

a character

-
reportChartComponent

a ReportChartComponentLayoutItem

-
scontrol

a character

-
showLabel

a character either 'true' or 'false'

-
showScrollbars

a character either 'true' or 'false'

-
width

a character

- -
- -

LayoutSection

-
-
customLabel

a character either 'true' or 'false'

-
detailHeading

a character either 'true' or 'false'

-
editHeading

a character either 'true' or 'false'

-
label

a character

-
layoutColumns

a LayoutColumn

-
style

a LayoutSectionStyle - which is a character taking one of the following values: -

    -

  • TwoColumnsTopToBottom

    • -

  • TwoColumnsLeftToRight

    • -

  • OneColumn

    • -

  • CustomLinks

    • -

+

FlowInputValidationRule

+
errorMessage
+

a character

-
+
formulaExpression
+

a character

-

LayoutSectionTranslation

-
-
label

a character

-
section

a character

-
+

FlowInputValidationRuleTranslation

+
errorMessage
+

a character

-

LayoutTranslation

-
-
layout

a character

-
layoutType

a character

-
sections

a LayoutSectionTranslation

-
+

FlowLoop

+
label
+

a character (inherited from FlowNode)

-

LeadConvertSettings

-
-
fullName

a character (inherited from Metadata)

-
allowOwnerChange

a character either 'true' or 'false'

-
objectMapping

a ObjectMapping

-
opportunityCreationOptions

a VisibleOrRequired - which is a character taking one of the following values: -

    -

  • VisibleOptional

    • -

  • VisibleRequired

    • -

  • NotVisible

    • -

- -
- -

Letterhead

-
-
fullName

a character (inherited from Metadata)

-
available

a character either 'true' or 'false'

-
backgroundColor

a character

-
bodyColor

a character

-
bottomLine

a LetterheadLine

-
description

a character

-
footer

a LetterheadHeaderFooter

-
header

a LetterheadHeaderFooter

-
middleLine

a LetterheadLine

-
name

a character

-
topLine

a LetterheadLine

- -
- -

LetterheadHeaderFooter

-
-
backgroundColor

a character

-
height

an integer

-
horizontalAlignment

a LetterheadHorizontalAlignment - which is a character taking one of the following values: -

    -

  • None

    • -

  • Left

    • -

  • Center

    • -

  • Right

    • -

-
logo

a character

-
verticalAlignment

a LetterheadVerticalAlignment - which is a character taking one of the following values: -

    -

  • None

    • +
    locationX
    +

    an integer (inherited from FlowNode)

    + +
    locationY
    +

    an integer (inherited from FlowNode)

    + +
    assignNextValueToReference
    +

    a character

    + +
    collectionReference
    +

    a character

    + +
    iterationOrder
    +

    a IterationOrder - which is a character taking one of the following values:

    • Asc

      • +

    • Desc

      • +
    + +
    nextValueConnector
    +

    a FlowConnector

    + +
    noMoreValuesConnector
    +

    a FlowConnector

    + + +

FlowMetadataValue

+
name
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowNode

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
label
+

a character

+ +
locationX
+

an integer

+ +
locationY
+

an integer

+ + +

FlowOutputFieldAssignment

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
field
+

a character

+ + +

FlowRecordCreate

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
assignRecordIdToReference
+

a character

+ +
connector
+

a FlowConnector

+ +
faultConnector
+

a FlowConnector

+ +
inputAssignments
+

a FlowInputFieldAssignment

+ +
inputReference
+

a character

+ +
object
+

a character

+ + +

FlowRecordDelete

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
connector
+

a FlowConnector

+ +
faultConnector
+

a FlowConnector

+ +
filters
+

a FlowRecordFilter

+ +
inputReference
+

a character

+ +
object
+

a character

+ + +

FlowRecordFilter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
field
+

a character

+ +
operator
+

a FlowRecordFilterOperator - which is a character taking one of the following values:

  • EqualTo

    • +

  • NotEqualTo

    • +

  • GreaterThan

    • +

  • LessThan

    • +

  • GreaterThanOrEqualTo

    • +

  • LessThanOrEqualTo

    • +

  • StartsWith

    • +

  • EndsWith

    • +

  • Contains

    • +

  • IsNull

    • +
+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowRecordLookup

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
assignNullValuesIfNoRecordsFound
+

a character either 'true' or 'false'

+ +
connector
+

a FlowConnector

+ +
faultConnector
+

a FlowConnector

+ +
filters
+

a FlowRecordFilter

+ +
object
+

a character

+ +
outputAssignments
+

a FlowOutputFieldAssignment

+ +
outputReference
+

a character

+ +
queriedFields
+

a character

+ +
sortField
+

a character

+ +
sortOrder
+

a SortOrder - which is a character taking one of the following values:

  • Asc

    • +

  • Desc

    • +
+ + +

FlowRecordUpdate

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
connector
+

a FlowConnector

+ +
faultConnector
+

a FlowConnector

+ +
filters
+

a FlowRecordFilter

+ +
inputAssignments
+

a FlowInputFieldAssignment

+ +
inputReference
+

a character

+ +
object
+

a character

+ + +

FlowRule

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
conditionLogic
+

a character

+ +
conditions
+

a FlowCondition

+ +
connector
+

a FlowConnector

+ +
label
+

a character

+ + +

FlowScreen

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
allowBack
+

a character either 'true' or 'false'

+ +
allowFinish
+

a character either 'true' or 'false'

+ +
allowPause
+

a character either 'true' or 'false'

+ +
connector
+

a FlowConnector

+ +
fields
+

a FlowScreenField

+ +
helpText
+

a character

+ +
pausedText
+

a character

+ +
rules
+

a FlowScreenRule

+ +
showFooter
+

a character either 'true' or 'false'

+ +
showHeader
+

a character either 'true' or 'false'

+ + +

FlowScreenField

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
choiceReferences
+

a character

+ +
dataType
+

a FlowDataType - which is a character taking one of the following values:

  • Currency

    • +

  • Date

    • +

  • Number

    • +

  • String

    • +

  • Boolean

    • +

  • SObject

    • +

  • DateTime

    • +

  • Picklist

    • +

  • Multipicklist

    • +
+ +
defaultSelectedChoiceReference
+

a character

+ +
defaultValue
+

a FlowElementReferenceOrValue

+ +
extensionName
+

a character

+ +
fieldText
+

a character

+ +
fieldType
+

a FlowScreenFieldType - which is a character taking one of the following values:

  • DisplayText

    • +

  • InputField

    • +

  • LargeTextArea

    • +

  • PasswordField

    • +

  • RadioButtons

    • +

  • DropdownBox

    • +

  • MultiSelectCheckboxes

    • +

  • MultiSelectPicklist

    • +

  • ComponentInstance

    • +
+ +
helpText
+

a character

+ +
inputParameters
+

a FlowScreenFieldInputParameter

+ +
isRequired
+

a character either 'true' or 'false'

+ +
isVisible
+

a character either 'true' or 'false'

+ +
outputParameters
+

a FlowScreenFieldOutputParameter

+ +
scale
+

an integer

+ +
validationRule
+

a FlowInputValidationRule

+ + +

FlowScreenFieldInputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
name
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowScreenFieldOutputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
name
+

a character

+ + +

FlowScreenFieldTranslation

+
fieldText
+

a character

+ +
helpText
+

a character

+ +
name
+

a character

+ +
validationRule
+

a FlowInputValidationRuleTranslation

+ + +

FlowScreenRule

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
conditionLogic
+

a character

+ +
conditions
+

a FlowCondition

+ +
label
+

a character

+ +
ruleActions
+

a FlowScreenRuleAction

+ + +

FlowScreenRuleAction

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
attribute
+

a character

+ +
fieldReference
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowScreenTranslation

+
fields
+

a FlowScreenFieldTranslation

+ +
helpText
+

a character

+ +
name
+

a character

+ +
pausedText
+

a character

+ + +

FlowStage

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
isActive
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
stageOrder
+

an integer

+ + +

FlowStep

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
connectors
+

a FlowConnector

+ + +

FlowSubflow

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
connector
+

a FlowConnector

+ +
flowName
+

a character

+ +
inputAssignments
+

a FlowSubflowInputAssignment

+ +
outputAssignments
+

a FlowSubflowOutputAssignment

+ + +

FlowSubflowInputAssignment

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
name
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowSubflowOutputAssignment

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
name
+

a character

+ + +

FlowTextTemplate

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
text
+

a character

+ + +

FlowTranslation

+
choices
+

a FlowChoiceTranslation

+ +
fullName
+

a character

+ +
label
+

a character

+ +
screens
+

a FlowScreenTranslation

+ + +

FlowVariable

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
dataType
+

a FlowDataType - which is a character taking one of the following values:

  • Currency

    • +

  • Date

    • +

  • Number

    • +

  • String

    • +

  • Boolean

    • +

  • SObject

    • +

  • DateTime

    • +

  • Picklist

    • +

  • Multipicklist

    • +
+ +
isCollection
+

a character either 'true' or 'false'

+ +
isInput
+

a character either 'true' or 'false'

+ +
isOutput
+

a character either 'true' or 'false'

+ +
objectType
+

a character

+ +
scale
+

an integer

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowWait

+
label
+

a character (inherited from FlowNode)

+ +
locationX
+

an integer (inherited from FlowNode)

+ +
locationY
+

an integer (inherited from FlowNode)

+ +
defaultConnector
+

a FlowConnector

+ +
defaultConnectorLabel
+

a character

+ +
faultConnector
+

a FlowConnector

+ +
waitEvents
+

a FlowWaitEvent

+ + +

FlowWaitEvent

+
description
+

a character (inherited from FlowElement)

+ +
name
+

a character (inherited from FlowElement)

+ +
conditionLogic
+

a character

+ +
conditions
+

a FlowCondition

+ +
connector
+

a FlowConnector

+ +
eventType
+

a character

+ +
inputParameters
+

a FlowWaitEventInputParameter

+ +
label
+

a character

+ +
outputParameters
+

a FlowWaitEventOutputParameter

+ + +

FlowWaitEventInputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
name
+

a character

+ +
value
+

a FlowElementReferenceOrValue

+ + +

FlowWaitEventOutputParameter

+
processMetadataValues
+

a FlowMetadataValue (inherited from FlowBaseElement)

+ +
assignToReference
+

a character

+ +
name
+

a character

+ + +

Folder

+
fullName
+

a character (inherited from Metadata)

+ +
accessType
+

a FolderAccessTypes - which is a character taking one of the following values:

  • Shared

    • +

  • Public

    • +

  • Hidden

    • +

  • PublicInternal

    • +
+ +
folderShares
+

a FolderShare

+ +
name
+

a character

+ +
publicFolderAccess
+

a PublicFolderAccess - which is a character taking one of the following values:

  • ReadOnly

    • +

  • ReadWrite

    • +
+ +
sharedTo
+

a SharedTo

+ + +

FolderShare

+
accessLevel
+

a FolderShareAccessLevel - which is a character taking one of the following values:

  • View

    • +

  • EditAllContents

    • +

  • Manage

    • +
+ +
sharedTo
+

a character

+ +
sharedToType
+

a FolderSharedToType - which is a character taking one of the following values:

  • Group

    • +

  • Role

    • +

  • RoleAndSubordinates

    • +

  • RoleAndSubordinatesInternal

    • +

  • Manager

    • +

  • ManagerAndSubordinatesInternal

    • +

  • Organization

    • +

  • Territory

    • +

  • TerritoryAndSubordinates

    • +

  • AllPrmUsers

    • +

  • User

    • +

  • PartnerUser

    • +

  • AllCspUsers

    • +

  • CustomerPortalUser

    • +

  • PortalRole

    • +

  • PortalRoleAndSubordinates

    • +

  • ChannelProgramGroup

    • +
+ + +

ForecastingCategoryMapping

+
forecastingItemCategoryApiName
+

a character

+ +
weightedSourceCategories
+

a WeightedSourceCategory

+ + +

ForecastingDisplayedFamilySettings

+
productFamily
+

a character

+ + +

ForecastingSettings

+
fullName
+

a character (inherited from Metadata)

+ +
displayCurrency
+

a DisplayCurrency - which is a character taking one of the following values:

  • CORPORATE

    • +

  • PERSONAL

    • +
+ +
enableForecasts
+

a character either 'true' or 'false'

+ +
forecastingCategoryMappings
+

a ForecastingCategoryMapping

+ +
forecastingDisplayedFamilySettings
+

a ForecastingDisplayedFamilySettings

+ +
forecastingTypeSettings
+

a ForecastingTypeSettings

+ + +

ForecastingTypeSettings

+
active
+

a character either 'true' or 'false'

+ +
adjustmentsSettings
+

a AdjustmentsSettings

+ +
displayedCategoryApiNames
+

a character

+ +
forecastRangeSettings
+

a ForecastRangeSettings

+ +
forecastedCategoryApiNames
+

a character

+ +
forecastingDateType
+

a ForecastingDateType - which is a character taking one of the following values:

  • OpportunityCloseDate

    • +

  • ProductDate

    • +

  • ScheduleDate

    • +
+ +
hasProductFamily
+

a character either 'true' or 'false'

+ +
isAmount
+

a character either 'true' or 'false'

+ +
isAvailable
+

a character either 'true' or 'false'

+ +
isQuantity
+

a character either 'true' or 'false'

+ +
managerAdjustableCategoryApiNames
+

a character

+ +
masterLabel
+

a character

+ +
name
+

a character

+ +
opportunityListFieldsLabelMappings
+

a OpportunityListFieldsLabelMapping

+ +
opportunityListFieldsSelectedSettings
+

a OpportunityListFieldsSelectedSettings

+ +
opportunityListFieldsUnselectedSettings
+

a OpportunityListFieldsUnselectedSettings

+ +
opportunitySplitName
+

a character

+ +
ownerAdjustableCategoryApiNames
+

a character

+ +
quotasSettings
+

a QuotasSettings

+ +
territory2ModelName
+

a character

+ + +

ForecastRangeSettings

+
beginning
+

an integer

+ +
displaying
+

an integer

+ +
periodType
+

a PeriodTypes - which is a character taking one of the following values:

  • Month

    • +

  • Quarter

    • +

  • Week

    • +

  • Year

    • +
+ + +

GlobalPicklistValue

+
fullName
+

a character (inherited from Metadata)

+ +
color
+

a character

+ +
default
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
isActive
+

a character either 'true' or 'false'

+ + +

GlobalQuickActionTranslation

+
label
+

a character

+ +
name
+

a character

+ + +

GlobalValueSet

+
fullName
+

a character (inherited from Metadata)

+ +
customValue
+

a CustomValue

+ +
description
+

a character

+ +
masterLabel
+

a character

+ +
sorted
+

a character either 'true' or 'false'

+ + +

GlobalValueSetTranslation

+
fullName
+

a character (inherited from Metadata)

+ +
valueTranslation
+

a ValueTranslation

+ + +

Group

+
fullName
+

a character (inherited from Metadata)

+ +
doesIncludeBosses
+

a character either 'true' or 'false'

+ +
name
+

a character

+ + +

HistoryRetentionPolicy

+
archiveAfterMonths
+

an integer

+ +
archiveRetentionYears
+

an integer

+ +
description
+

a character

+ + +

Holiday

+
activityDate
+

a character formatted as 'yyyy-mm-dd'

+ +
businessHours
+

a character

+ +
description
+

a character

+ +
endTime
+

a character formatted as 'hh:mm:ssZ

+ +
isRecurring
+

a character either 'true' or 'false'

+ +
name
+

a character

+ +
recurrenceDayOfMonth
+

an integer

+ +
recurrenceDayOfWeek
+

a character

+ +
recurrenceDayOfWeekMask
+

an integer

+ +
recurrenceEndDate
+

a character formatted as 'yyyy-mm-dd'

+ +
recurrenceInstance
+

a character

+ +
recurrenceInterval
+

an integer

+ +
recurrenceMonthOfYear
+

a character

+ +
recurrenceStartDate
+

a character formatted as 'yyyy-mm-dd'

+ +
recurrenceType
+

a character

+ +
startTime
+

a character formatted as 'hh:mm:ssZ

+ + +

HomePageComponent

+
fullName
+

a character (inherited from Metadata)

+ +
body
+

a character

+ +
height
+

an integer

+ +
links
+

a character

+ +
page
+

a character

+ +
pageComponentType
+

a PageComponentType - which is a character taking one of the following values:

  • links

    • +

  • htmlArea

    • +

  • imageOrNote

    • +

  • visualforcePage

    • +
+ +
showLabel
+

a character either 'true' or 'false'

+ +
showScrollbars
+

a character either 'true' or 'false'

+ +
width
+

a PageComponentWidth - which is a character taking one of the following values:

  • narrow

    • +

  • wide

    • +
+ + +

HomePageLayout

+
fullName
+

a character (inherited from Metadata)

+ +
narrowComponents
+

a character

+ +
wideComponents
+

a character

+ + +

IdeaReputationLevel

+
name
+

a character

+ +
value
+

an integer

+ + +

IdeasSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableChatterProfile
+

a character either 'true' or 'false'

+ +
enableIdeaThemes
+

a character either 'true' or 'false'

+ +
enableIdeas
+

a character either 'true' or 'false'

+ +
enableIdeasReputation
+

a character either 'true' or 'false'

+ +
halfLife
+

a numeric

+ +
ideasProfilePage
+

a character

+ + +

Index

+
fullName
+

a character (inherited from Metadata)

+ +
fields
+

a IndexField

+ +
label
+

a character

+ + +

IndexField

+
name
+

a character

+ +
sortDirection
+

a character

+ + +

InsightType

+
fullName
+

a character (inherited from Metadata)

+ +
defaultTrendType
+

a InsightTrendType - which is a character taking one of the following values:

  • Positive

    • +

  • Negative

    • +

  • Informational

    • +

  • Suggestion

    • +
+ +
description
+

a character

+ +
isProtected
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
parentType
+

a InsightParentType - which is a character taking one of the following values:

  • Opportunity

    • +

  • Account

    • +
+ +
title
+

a character

+ + +

InstalledPackage

+
fullName
+

a character (inherited from Metadata)

+ +
password
+

a character

+ +
versionNumber
+

a character

+ + +

IntegrationHubSettings

+
fullName
+

a character (inherited from Metadata)

+ +
canonicalName
+

a character

+ +
canonicalNameBindingChar
+

a character

+ +
description
+

a character

+ +
isEnabled
+

a character either 'true' or 'false'

+ +
isProtected
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
setupData
+

a character

+ +
setupDefinition
+

a character

+ +
setupNamespace
+

a character

+ +
setupSimpleName
+

a character

+ +
uUID
+

a character

+ +
version
+

a character

+ +
versionBuild
+

an integer

+ +
versionMajor
+

an integer

+ +
versionMinor
+

an integer

+ + +

IntegrationHubSettingsType

+
fullName
+

a character (inherited from Metadata)

+ +
canonicalName
+

a character

+ +
canonicalNameBindingChar
+

a character

+ +
description
+

a character

+ +
isEnabled
+

a character either 'true' or 'false'

+ +
isProtected
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
setupNamespace
+

a character

+ +
setupSimpleName
+

a character

+ +
uUID
+

a character

+ +
version
+

a character

+ +
versionBuild
+

an integer

+ +
versionMajor
+

an integer

+ +
versionMinor
+

an integer

+ + +

IpRange

+
description
+

a character

+ +
end
+

a character

+ +
start
+

a character

+ + +

KeyboardShortcuts

+
customShortcuts
+

a CustomShortcut

+ +
defaultShortcuts
+

a DefaultShortcut

+ + +

Keyword

+
keyword
+

a character

+ + +

KeywordList

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
keywords
+

a Keyword

+ +
masterLabel
+

a character

+ + +

KnowledgeAnswerSettings

+
assignTo
+

a character

+ +
defaultArticleType
+

a character

+ +
enableArticleCreation
+

a character either 'true' or 'false'

+ + +

KnowledgeCaseField

+
name
+

a character

+ + +

KnowledgeCaseFieldsSettings

+
field
+

a KnowledgeCaseField

+ + +

KnowledgeCaseSettings

+
articlePDFCreationProfile
+

a character

+ +
articlePublicSharingCommunities
+

a KnowledgeCommunitiesSettings

+ +
articlePublicSharingSites
+

a KnowledgeSitesSettings

+ +
articlePublicSharingSitesChatterAnswers
+

a KnowledgeSitesSettings

+ +
assignTo
+

a character

+ +
customizationClass
+

a character

+ +
defaultContributionArticleType
+

a character

+ +
editor
+

a KnowledgeCaseEditor - which is a character taking one of the following values:

  • simple

    • +

  • standard

    • +
+ +
enableArticleCreation
+

a character either 'true' or 'false'

+ +
enableArticlePublicSharingSites
+

a character either 'true' or 'false'

+ +
enableCaseDataCategoryMapping
+

a character either 'true' or 'false'

+ +
useProfileForPDFCreation
+

a character either 'true' or 'false'

+ + +

KnowledgeCommunitiesSettings

+
community
+

a character

+ + +

KnowledgeLanguage

+
active
+

a character either 'true' or 'false'

+ +
defaultAssignee
+

a character

+ +
defaultAssigneeType
+

a KnowledgeLanguageLookupValueType - which is a character taking one of the following values:

  • User

    • +

  • Queue

    • +
+ +
defaultReviewer
+

a character

+ +
defaultReviewerType
+

a KnowledgeLanguageLookupValueType - which is a character taking one of the following values:

  • User

    • +

  • Queue

    • +
+ +
name
+

a character

+ + +

KnowledgeLanguageSettings

+
language
+

a KnowledgeLanguage

+ + +

KnowledgeSettings

+
fullName
+

a character (inherited from Metadata)

+ +
answers
+

a KnowledgeAnswerSettings

+ +
cases
+

a KnowledgeCaseSettings

+ +
defaultLanguage
+

a character

+ +
enableChatterQuestionKBDeflection
+

a character either 'true' or 'false'

+ +
enableCreateEditOnArticlesTab
+

a character either 'true' or 'false'

+ +
enableExternalMediaContent
+

a character either 'true' or 'false'

+ +
enableKnowledge
+

a character either 'true' or 'false'

+ +
enableLightningKnowledge
+

a character either 'true' or 'false'

+ +
languages
+

a KnowledgeLanguageSettings

+ +
showArticleSummariesCustomerPortal
+

a character either 'true' or 'false'

+ +
showArticleSummariesInternalApp
+

a character either 'true' or 'false'

+ +
showArticleSummariesPartnerPortal
+

a character either 'true' or 'false'

+ +
showValidationStatusField
+

a character either 'true' or 'false'

+ +
suggestedArticles
+

a KnowledgeSuggestedArticlesSettings

+ + +

KnowledgeSitesSettings

+
site
+

a character

+ + +

KnowledgeSuggestedArticlesSettings

+
caseFields
+

a KnowledgeCaseFieldsSettings

+ +
useSuggestedArticlesForCase
+

a character either 'true' or 'false'

+ +
workOrderFields
+

a KnowledgeWorkOrderFieldsSettings

+ +
workOrderLineItemFields
+

a KnowledgeWorkOrderLineItemFieldsSettings

+ + +

KnowledgeWorkOrderField

+
name
+

a character

+ + +

KnowledgeWorkOrderFieldsSettings

+
field
+

a KnowledgeWorkOrderField

+ + +

KnowledgeWorkOrderLineItemField

+
name
+

a character

+ + +

KnowledgeWorkOrderLineItemFieldsSettings

+
field
+

a KnowledgeWorkOrderLineItemField

+ + +

Layout

+
fullName
+

a character (inherited from Metadata)

+ +
customButtons
+

a character

+ +
customConsoleComponents
+

a CustomConsoleComponents

+ +
emailDefault
+

a character either 'true' or 'false'

+ +
excludeButtons
+

a character

+ +
feedLayout
+

a FeedLayout

+ +
headers
+

a LayoutHeader - which is a character taking one of the following values:

  • PersonalTagging

    • +

  • PublicTagging

    • +
+ +
layoutSections
+

a LayoutSection

+ +
miniLayout
+

a MiniLayout

+ +
multilineLayoutFields
+

a character

+ +
platformActionList
+

a PlatformActionList

+ +
quickActionList
+

a QuickActionList

+ +
relatedContent
+

a RelatedContent

+ +
relatedLists
+

a RelatedListItem

+ +
relatedObjects
+

a character

+ +
runAssignmentRulesDefault
+

a character either 'true' or 'false'

+ +
showEmailCheckbox
+

a character either 'true' or 'false'

+ +
showHighlightsPanel
+

a character either 'true' or 'false'

+ +
showInteractionLogPanel
+

a character either 'true' or 'false'

+ +
showKnowledgeComponent
+

a character either 'true' or 'false'

+ +
showRunAssignmentRulesCheckbox
+

a character either 'true' or 'false'

+ +
showSolutionSection
+

a character either 'true' or 'false'

+ +
showSubmitAndAttachButton
+

a character either 'true' or 'false'

+ +
summaryLayout
+

a SummaryLayout

+ + +

LayoutColumn

+
layoutItems
+

a LayoutItem

+ +
reserved
+

a character

+ + +

LayoutItem

+
analyticsCloudComponent
+

a AnalyticsCloudComponentLayoutItem

+ +
behavior
+

a UiBehavior - which is a character taking one of the following values:

  • Edit

    • +

  • Required

    • +

  • Readonly

    • +
+ +
canvas
+

a character

+ +
component
+

a character

+ +
customLink
+

a character

+ +
emptySpace
+

a character either 'true' or 'false'

+ +
field
+

a character

+ +
height
+

an integer

+ +
page
+

a character

+ +
reportChartComponent
+

a ReportChartComponentLayoutItem

+ +
scontrol
+

a character

+ +
showLabel
+

a character either 'true' or 'false'

+ +
showScrollbars
+

a character either 'true' or 'false'

+ +
width
+

a character

+ + +

LayoutSection

+
customLabel
+

a character either 'true' or 'false'

+ +
detailHeading
+

a character either 'true' or 'false'

+ +
editHeading
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
layoutColumns
+

a LayoutColumn

+ +
style
+

a LayoutSectionStyle - which is a character taking one of the following values:

  • TwoColumnsTopToBottom

    • +

  • TwoColumnsLeftToRight

    • +

  • OneColumn

    • +

  • CustomLinks

    • +
+ + +

LayoutSectionTranslation

+
label
+

a character

+ +
section
+

a character

+ + +

LayoutTranslation

+
layout
+

a character

+ +
layoutType
+

a character

+ +
sections
+

a LayoutSectionTranslation

+ + +

LeadConvertSettings

+
fullName
+

a character (inherited from Metadata)

+ +
allowOwnerChange
+

a character either 'true' or 'false'

+ +
objectMapping
+

a ObjectMapping

+ +
opportunityCreationOptions
+

a VisibleOrRequired - which is a character taking one of the following values:

  • VisibleOptional

    • +

  • VisibleRequired

    • +

  • NotVisible

    • +
+ + +

Letterhead

+
fullName
+

a character (inherited from Metadata)

+ +
available
+

a character either 'true' or 'false'

+ +
backgroundColor
+

a character

+ +
bodyColor
+

a character

+ +
bottomLine
+

a LetterheadLine

+ +
description
+

a character

+ +
footer
+

a LetterheadHeaderFooter

+ +
header
+

a LetterheadHeaderFooter

+ +
middleLine
+

a LetterheadLine

+ +
name
+

a character

+ +
topLine
+

a LetterheadLine

+ + +

LetterheadHeaderFooter

+
backgroundColor
+

a character

+ +
height
+

an integer

+ +
horizontalAlignment
+

a LetterheadHorizontalAlignment - which is a character taking one of the following values:

  • None

    • +

  • Left

    • +

  • Center

    • +

  • Right

    • +
+ +
logo
+

a character

+ +
verticalAlignment
+

a LetterheadVerticalAlignment - which is a character taking one of the following values:

  • None

    • +

  • Top

    • +

  • Middle

    • +

  • Bottom

    • +
+ + +

LetterheadLine

+
color
+

a character

+ +
height
+

an integer

+ + +

LicensedCustomPermissions

+
customPermission
+

a character

+ +
licenseDefinition
+

a character

+ + +

LicenseDefinition

+
fullName
+

a character (inherited from Metadata)

+ +
aggregationGroup
+

a character

+ +
description
+

a character

+ +
isPublished
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
licensedCustomPermissions
+

a LicensedCustomPermissions

+ +
licensingAuthority
+

a character

+ +
licensingAuthorityProvider
+

a character

+ +
minPlatformVersion
+

an integer

+ +
origin
+

a character

+ +
revision
+

an integer

+ +
trialLicenseDuration
+

an integer

+ +
trialLicenseQuantity
+

an integer

+ + +

LightningBolt

+
fullName
+

a character (inherited from Metadata)

+ +
category
+

a LightningBoltCategory - which is a character taking one of the following values:

  • IT

    • +

  • Marketing

    • +

  • Sales

    • +

  • Service

    • +
+ +
lightningBoltFeatures
+

a LightningBoltFeatures

+ +
lightningBoltImages
+

a LightningBoltImages

+ +
lightningBoltItems
+

a LightningBoltItems

+ +
masterLabel
+

a character

+ +
publisher
+

a character

+ +
summary
+

a character

+ + +

LightningBoltFeatures

+
description
+

a character

+ +
order
+

an integer

+ +
title
+

a character

+ + +

LightningBoltImages

+
image
+

a character

+ +
order
+

an integer

+ + +

LightningBoltItems

+
name
+

a character

+ +
type
+

a character

+ + +

LightningComponentBundle

+
fullName
+

a character (inherited from Metadata)

+ +
apiVersion
+

a numeric

+ +
isExposed
+

a character either 'true' or 'false'

+ + +

LightningExperienceTheme

+
fullName
+

a character (inherited from Metadata)

+ +
defaultBrandingSet
+

a character

+ +
description
+

a character

+ +
masterLabel
+

a character

+ +
shouldOverrideLoadingImage
+

a character either 'true' or 'false'

+ + +

ListMetadataQuery

+
folder
+

a character

+ +
type
+

a character

+ + +

ListPlacement

+
height
+

an integer

+ +
location
+

a character

+ +
units
+

a character

+ +
width
+

an integer

+ + +

ListView

+
fullName
+

a character (inherited from Metadata)

+ +
booleanFilter
+

a character

+ +
columns
+

a character

+ +
division
+

a character

+ +
filterScope
+

a FilterScope - which is a character taking one of the following values:

  • Everything

    • +

  • Mine

    • +

  • Queue

    • +

  • Delegated

    • +

  • MyTerritory

    • +

  • MyTeamTerritory

    • +

  • Team

    • +

  • AssignedToMe

    • +
+ +
filters
+

a ListViewFilter

+ +
label
+

a character

+ +
language
+

a Language - which is a character taking one of the following values:

  • en_US

    • +

  • de

    • +

  • es

    • +

  • fr

    • +

  • it

    • +

  • ja

    • +

  • sv

    • +

  • ko

    • +

  • zh_TW

    • +

  • zh_CN

    • +

  • pt_BR

    • +

  • nl_NL

    • +

  • da

    • +

  • th

    • +

  • fi

    • +

  • ru

    • +

  • es_MX

    • +

  • no

    • +

  • hu

    • +

  • pl

    • +

  • cs

    • +

  • tr

    • +

  • in

    • +

  • ro

    • +

  • vi

    • +

  • uk

    • +

  • iw

    • +

  • el

    • +

  • bg

    • +

  • en_GB

    • +

  • ar

    • +

  • sk

    • +

  • pt_PT

    • +

  • hr

    • +

  • sl

    • +

  • fr_CA

    • +

  • ka

    • +

  • sr

    • +

  • sh

    • +

  • en_AU

    • +

  • en_MY

    • +

  • en_IN

    • +

  • en_PH

    • +

  • en_CA

    • +

  • ro_MD

    • +

  • bs

    • +

  • mk

    • +

  • lv

    • +

  • lt

    • +

  • et

    • +

  • sq

    • +

  • sh_ME

    • +

  • mt

    • +

  • ga

    • +

  • eu

    • +

  • cy

    • +

  • is

    • +

  • ms

    • +

  • tl

    • +

  • lb

    • +

  • rm

    • +

  • hy

    • +

  • hi

    • +

  • ur

    • +

  • bn

    • +

  • de_AT

    • +

  • de_CH

    • +

  • ta

    • +

  • ar_DZ

    • +

  • ar_BH

    • +

  • ar_EG

    • +

  • ar_IQ

    • +

  • ar_JO

    • +

  • ar_KW

    • +

  • ar_LB

    • +

  • ar_LY

    • +

  • ar_MA

    • +

  • ar_OM

    • +

  • ar_QA

    • +

  • ar_SA

    • +

  • ar_SD

    • +

  • ar_SY

    • +

  • ar_TN

    • +

  • ar_AE

    • +

  • ar_YE

    • +

  • zh_SG

    • +

  • zh_HK

    • +

  • en_HK

    • +

  • en_IE

    • +

  • en_SG

    • +

  • en_ZA

    • +

  • fr_BE

    • +

  • fr_LU

    • +

  • fr_CH

    • +

  • de_BE

    • +

  • de_LU

    • +

  • it_CH

    • +

  • nl_BE

    • +

  • es_AR

    • +

  • es_BO

    • +

  • es_CL

    • +

  • es_CO

    • +

  • es_CR

    • +

  • es_DO

    • +

  • es_EC

    • +

  • es_SV

    • +

  • es_GT

    • +

  • es_HN

    • +

  • es_NI

    • +

  • es_PA

    • +

  • es_PY

    • +

  • es_PE

    • +

  • es_PR

    • +

  • es_US

    • +

  • es_UY

    • +

  • es_VE

    • +

  • ca

    • +

  • eo

    • +

  • iw_EO

    • +
+ +
queue
+

a character

+ +
sharedTo
+

a SharedTo

+ + +

ListViewFilter

+
field
+

a character

+ +
operation
+

a FilterOperation - which is a character taking one of the following values:

  • equals

    • +

  • notEqual

    • +

  • lessThan

    • +

  • greaterThan

    • +

  • lessOrEqual

    • +

  • greaterOrEqual

    • +

  • contains

    • +

  • notContain

    • +

  • startsWith

    • +

  • includes

    • +

  • excludes

    • +

  • within

    • +
+ +
value
+

a character

+ + +

LiveAgentConfig

+
enableLiveChat
+

a character either 'true' or 'false'

+ +
openNewAccountSubtab
+

a character either 'true' or 'false'

+ +
openNewCaseSubtab
+

a character either 'true' or 'false'

+ +
openNewContactSubtab
+

a character either 'true' or 'false'

+ +
openNewLeadSubtab
+

a character either 'true' or 'false'

+ +
openNewVFPageSubtab
+

a character either 'true' or 'false'

+ +
pageNamesToOpen
+

a character

+ +
showKnowledgeArticles
+

a character either 'true' or 'false'

+ + +

LiveAgentSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableLiveAgent
+

a character either 'true' or 'false'

+ + +

LiveChatAgentConfig

+
fullName
+

a character (inherited from Metadata)

+ +
assignments
+

a AgentConfigAssignments

+ +
autoGreeting
+

a character

+ +
capacity
+

an integer

+ +
criticalWaitTime
+

an integer

+ +
customAgentName
+

a character

+ +
enableAgentFileTransfer
+

a character either 'true' or 'false'

+ +
enableAgentSneakPeek
+

a character either 'true' or 'false'

+ +
enableAssistanceFlag
+

a character either 'true' or 'false'

+ +
enableAutoAwayOnDecline
+

a character either 'true' or 'false'

+ +
enableAutoAwayOnPushTimeout
+

a character either 'true' or 'false'

+ +
enableChatConferencing
+

a character either 'true' or 'false'

+ +
enableChatMonitoring
+

a character either 'true' or 'false'

+ +
enableChatTransferToAgent
+

a character either 'true' or 'false'

+ +
enableChatTransferToButton
+

a character either 'true' or 'false'

+ +
enableChatTransferToSkill
+

a character either 'true' or 'false'

+ +
enableLogoutSound
+

a character either 'true' or 'false'

+ +
enableNotifications
+

a character either 'true' or 'false'

+ +
enableRequestSound
+

a character either 'true' or 'false'

+ +
enableSneakPeek
+

a character either 'true' or 'false'

+ +
enableVisitorBlocking
+

a character either 'true' or 'false'

+ +
enableWhisperMessage
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
supervisorDefaultAgentStatusFilter
+

a SupervisorAgentStatusFilter - which is a character taking one of the following values:

  • Online

    • +

  • Away

    • +

  • Offline

    • +
+ +
supervisorDefaultButtonFilter
+

a character

+ +
supervisorDefaultSkillFilter
+

a character

+ +
supervisorSkills
+

a SupervisorAgentConfigSkills

+ +
transferableButtons
+

a AgentConfigButtons

+ +
transferableSkills
+

a AgentConfigSkills

+ + +

LiveChatButton

+
fullName
+

a character (inherited from Metadata)

+ +
animation
+

a LiveChatButtonPresentation - which is a character taking one of the following values:

  • Slide

    • +

  • Fade

    • +

  • Appear

    • +

  • Custom

    • +
+ +
autoGreeting
+

a character

+ +
chasitorIdleTimeout
+

an integer

+ +
chasitorIdleTimeoutWarning
+

an integer

+ +
chatPage
+

a character

+ +
customAgentName
+

a character

+ +
deployments
+

a LiveChatButtonDeployments

+ +
enableQueue
+

a character either 'true' or 'false'

+ +
inviteEndPosition
+

a LiveChatButtonInviteEndPosition - which is a character taking one of the following values:

  • TopLeft

  • Top

    • -

  • Middle

    • +

  • TopRight

    • +

  • Left

    • +

  • Center

    • +

  • Right

    • +

  • BottomLeft

  • Bottom

    • -

- -
- -

LetterheadLine

-
-
color

a character

-
height

an integer

- -
- -

LicensedCustomPermissions

-
-
customPermission

a character

-
licenseDefinition

a character

- -
- -

LicenseDefinition

-
-
fullName

a character (inherited from Metadata)

-
aggregationGroup

a character

-
description

a character

-
isPublished

a character either 'true' or 'false'

-
label

a character

-
licensedCustomPermissions

a LicensedCustomPermissions

-
licensingAuthority

a character

-
licensingAuthorityProvider

a character

-
minPlatformVersion

an integer

-
origin

a character

-
revision

an integer

-
trialLicenseDuration

an integer

-
trialLicenseQuantity

an integer

- -
- -

LightningBolt

-
-
fullName

a character (inherited from Metadata)

-
category

a LightningBoltCategory - which is a character taking one of the following values: -

    -

  • IT

    • -

  • Marketing

    • -

  • Sales

    • -

  • Service

    • -

-
lightningBoltFeatures

a LightningBoltFeatures

-
lightningBoltImages

a LightningBoltImages

-
lightningBoltItems

a LightningBoltItems

-
masterLabel

a character

-
publisher

a character

-
summary

a character

- -
- -

LightningBoltFeatures

-
-
description

a character

-
order

an integer

-
title

a character

- -
- -

LightningBoltImages

-
-
image

a character

-
order

an integer

- -
- -

LightningBoltItems

-
-
name

a character

-
type

a character

- -
- -

LightningComponentBundle

-
-
fullName

a character (inherited from Metadata)

-
apiVersion

a numeric

-
isExposed

a character either 'true' or 'false'

- -
- -

LightningExperienceTheme

-
-
fullName

a character (inherited from Metadata)

-
defaultBrandingSet

a character

-
description

a character

-
masterLabel

a character

-
shouldOverrideLoadingImage

a character either 'true' or 'false'

- -
- -

ListMetadataQuery

-
-
folder

a character

-
type

a character

- -
- -

ListPlacement

-
-
height

an integer

-
location

a character

-
units

a character

-
width

an integer

- -
- -

ListView

-
-
fullName

a character (inherited from Metadata)

-
booleanFilter

a character

-
columns

a character

-
division

a character

-
filterScope

a FilterScope - which is a character taking one of the following values: -

    -

  • Everything

    • -

  • Mine

    • -

  • Queue

    • -

  • Delegated

    • -

  • MyTerritory

    • -

  • MyTeamTerritory

    • -

  • Team

    • -

  • AssignedToMe

    • -

-
filters

a ListViewFilter

-
label

a character

-
language

a Language - which is a character taking one of the following values: -

    -

  • en_US

    • +

  • BottomRight

    • +
+ +
inviteImage
+

a character

+ +
inviteStartPosition
+

a LiveChatButtonInviteStartPosition - which is a character taking one of the following values:

  • TopLeft

    • +

  • TopLeftTop

    • +

  • Top

    • +

  • TopRightTop

    • +

  • TopRight

    • +

  • TopRightRight

    • +

  • Right

    • +

  • BottomRightRight

    • +

  • BottomRight

    • +

  • BottomRightBottom

    • +

  • Bottom

    • +

  • BottomLeftBottom

    • +

  • BottomLeft

    • +

  • BottomLeftLeft

    • +

  • Left

    • +

  • TopLeftLeft

    • +
+ +
isActive
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
numberOfReroutingAttempts
+

an integer

+ +
offlineImage
+

a character

+ +
onlineImage
+

a character

+ +
optionsCustomRoutingIsEnabled
+

a character either 'true' or 'false'

+ +
optionsHasChasitorIdleTimeout
+

a character either 'true' or 'false'

+ +
optionsHasInviteAfterAccept
+

a character either 'true' or 'false'

+ +
optionsHasInviteAfterReject
+

a character either 'true' or 'false'

+ +
optionsHasRerouteDeclinedRequest
+

a character either 'true' or 'false'

+ +
optionsIsAutoAccept
+

a character either 'true' or 'false'

+ +
optionsIsInviteAutoRemove
+

a character either 'true' or 'false'

+ +
overallQueueLength
+

an integer

+ +
perAgentQueueLength
+

an integer

+ +
postChatPage
+

a character

+ +
postChatUrl
+

a character

+ +
preChatFormPage
+

a character

+ +
preChatFormUrl
+

a character

+ +
pushTimeOut
+

an integer

+ +
routingType
+

a LiveChatButtonRoutingType - which is a character taking one of the following values:

  • Choice

    • +

  • LeastActive

    • +

  • MostAvailable

    • +
+ +
site
+

a character

+ +
skills
+

a LiveChatButtonSkills

+ +
timeToRemoveInvite
+

an integer

+ +
type
+

a LiveChatButtonType - which is a character taking one of the following values:

  • Standard

    • +

  • Invite

    • +
+ +
windowLanguage
+

a Language - which is a character taking one of the following values:

  • en_US

  • de

  • es

  • fr

    • @@ -5991,1903 +9131,2366 @@

    Details

  • ca

  • eo

  • iw_EO

    • -

-
queue

a character

-
sharedTo

a SharedTo

- -
- -

ListViewFilter

-
-
field

a character

-
operation

a FilterOperation - which is a character taking one of the following values: -

    -

  • equals

    • -

  • notEqual

    • -

  • lessThan

    • -

  • greaterThan

    • -

  • lessOrEqual

    • -

  • greaterOrEqual

    • -

  • contains

    • -

  • notContain

    • -

  • startsWith

    • -

  • includes

    • -

  • excludes

    • -

  • within

    • -

-
value

a character

- -
- -

LiveAgentConfig

-
-
enableLiveChat

a character either 'true' or 'false'

-
openNewAccountSubtab

a character either 'true' or 'false'

-
openNewCaseSubtab

a character either 'true' or 'false'

-
openNewContactSubtab

a character either 'true' or 'false'

-
openNewLeadSubtab

a character either 'true' or 'false'

-
openNewVFPageSubtab

a character either 'true' or 'false'

-
pageNamesToOpen

a character

-
showKnowledgeArticles

a character either 'true' or 'false'

- -
- -

LiveAgentSettings

-
-
fullName

a character (inherited from Metadata)

-
enableLiveAgent

a character either 'true' or 'false'

- -
- -

LiveChatAgentConfig

-
-
fullName

a character (inherited from Metadata)

-
assignments

a AgentConfigAssignments

-
autoGreeting

a character

-
capacity

an integer

-
criticalWaitTime

an integer

-
customAgentName

a character

-
enableAgentFileTransfer

a character either 'true' or 'false'

-
enableAgentSneakPeek

a character either 'true' or 'false'

-
enableAssistanceFlag

a character either 'true' or 'false'

-
enableAutoAwayOnDecline

a character either 'true' or 'false'

-
enableAutoAwayOnPushTimeout

a character either 'true' or 'false'

-
enableChatConferencing

a character either 'true' or 'false'

-
enableChatMonitoring

a character either 'true' or 'false'

-
enableChatTransferToAgent

a character either 'true' or 'false'

-
enableChatTransferToButton

a character either 'true' or 'false'

-
enableChatTransferToSkill

a character either 'true' or 'false'

-
enableLogoutSound

a character either 'true' or 'false'

-
enableNotifications

a character either 'true' or 'false'

-
enableRequestSound

a character either 'true' or 'false'

-
enableSneakPeek

a character either 'true' or 'false'

-
enableVisitorBlocking

a character either 'true' or 'false'

-
enableWhisperMessage

a character either 'true' or 'false'

-
label

a character

-
supervisorDefaultAgentStatusFilter

a SupervisorAgentStatusFilter - which is a character taking one of the following values: -

    -

  • Online

    • -

  • Away

    • -

  • Offline

    • -

-
supervisorDefaultButtonFilter

a character

-
supervisorDefaultSkillFilter

a character

-
supervisorSkills

a SupervisorAgentConfigSkills

-
transferableButtons

a AgentConfigButtons

-
transferableSkills

a AgentConfigSkills

- -
- -

LiveChatButton

-
-
fullName

a character (inherited from Metadata)

-
animation

a LiveChatButtonPresentation - which is a character taking one of the following values: -

    -

  • Slide

    • -

  • Fade

    • -

  • Appear

    • -

  • Custom

    • -

-
autoGreeting

a character

-
chasitorIdleTimeout

an integer

-
chasitorIdleTimeoutWarning

an integer

-
chatPage

a character

-
customAgentName

a character

-
deployments

a LiveChatButtonDeployments

-
enableQueue

a character either 'true' or 'false'

-
inviteEndPosition

a LiveChatButtonInviteEndPosition - which is a character taking one of the following values: -

    -

  • TopLeft

    • -

  • Top

    • -

  • TopRight

    • -

  • Left

    • -

  • Center

    • -

  • Right

    • -

  • BottomLeft

    • -

  • Bottom

    • -

  • BottomRight

    • -

-
inviteImage

a character

-
inviteStartPosition

a LiveChatButtonInviteStartPosition - which is a character taking one of the following values: -

    -

  • TopLeft

    • -

  • TopLeftTop

    • -

  • Top

    • -

  • TopRightTop

    • -

  • TopRight

    • -

  • TopRightRight

    • -

  • Right

    • -

  • BottomRightRight

    • -

  • BottomRight

    • -

  • BottomRightBottom

    • -

  • Bottom

    • -

  • BottomLeftBottom

    • -

  • BottomLeft

    • -

  • BottomLeftLeft

    • -

  • Left

    • -

  • TopLeftLeft

    • -

-
isActive

a character either 'true' or 'false'

-
label

a character

-
numberOfReroutingAttempts

an integer

-
offlineImage

a character

-
onlineImage

a character

-
optionsCustomRoutingIsEnabled

a character either 'true' or 'false'

-
optionsHasChasitorIdleTimeout

a character either 'true' or 'false'

-
optionsHasInviteAfterAccept

a character either 'true' or 'false'

-
optionsHasInviteAfterReject

a character either 'true' or 'false'

-
optionsHasRerouteDeclinedRequest

a character either 'true' or 'false'

-
optionsIsAutoAccept

a character either 'true' or 'false'

-
optionsIsInviteAutoRemove

a character either 'true' or 'false'

-
overallQueueLength

an integer

-
perAgentQueueLength

an integer

-
postChatPage

a character

-
postChatUrl

a character

-
preChatFormPage

a character

-
preChatFormUrl

a character

-
pushTimeOut

an integer

-
routingType

a LiveChatButtonRoutingType - which is a character taking one of the following values: -

    -

  • Choice

    • -

  • LeastActive

    • -

  • MostAvailable

    • -

-
site

a character

-
skills

a LiveChatButtonSkills

-
timeToRemoveInvite

an integer

-
type

a LiveChatButtonType - which is a character taking one of the following values: -

    +
+ + +

LiveChatButtonDeployments

+
deployment
+

a character

+ + +

LiveChatButtonSkills

+
skill
+

a character

+ + +

LiveChatDeployment

+
fullName
+

a character (inherited from Metadata)

+ +
brandingImage
+

a character

+ +
connectionTimeoutDuration
+

an integer

+ +
connectionWarningDuration
+

an integer

+ +
displayQueuePosition
+

a character either 'true' or 'false'

+ +
domainWhiteList
+

a LiveChatDeploymentDomainWhitelist

+ +
enablePrechatApi
+

a character either 'true' or 'false'

+ +
enableTranscriptSave
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
mobileBrandingImage
+

a character

+ +
site
+

a character

+ +
windowTitle
+

a character

+ + +

LiveChatDeploymentDomainWhitelist

+
domain
+

a character

+ + +

LiveChatSensitiveDataRule

+
fullName
+

a character (inherited from Metadata)

+ +
actionType
+

a SensitiveDataActionType - which is a character taking one of the following values:

  • Remove

    • +

  • Replace

    • +
+ +
description
+

a character

+ +
enforceOn
+

an integer

+ +
isEnabled
+

a character either 'true' or 'false'

+ +
pattern
+

a character

+ +
replacement
+

a character

+ + +

LiveMessageSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableLiveMessage
+

a character either 'true' or 'false'

+ + +

LogInfo

+
category
+

a LogCategory - which is a character taking one of the following values:

  • Db

    • +

  • Workflow

    • +

  • Validation

    • +

  • Callout

    • +

  • Apex_code

    • +

  • Apex_profiling

    • +

  • Visualforce

    • +

  • System

    • +

  • Wave

    • +

  • All

    • +
+ +
level
+

a LogCategoryLevel - which is a character taking one of the following values:

  • None

    • +

  • Finest

    • +

  • Finer

    • +

  • Fine

    • +

  • Debug

    • +

  • Info

    • +

  • Warn

    • +

  • Error

    • +
+ + +

LookupFilter

+
active
+

a character either 'true' or 'false'

+ +
booleanFilter
+

a character

+ +
description
+

a character

+ +
errorMessage
+

a character

+ +
filterItems
+

a FilterItem

+ +
infoMessage
+

a character

+ +
isOptional
+

a character either 'true' or 'false'

+ + +

LookupFilterTranslation

+
errorMessage
+

a character

+ +
informationalMessage
+

a character

+ + +

MacroSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableAdvancedSearch
+

a character either 'true' or 'false'

+ + +

ManagedTopic

+
fullName
+

a character (inherited from Metadata)

+ +
managedTopicType
+

a character

+ +
name
+

a character

+ +
parentName
+

a character

+ +
position
+

an integer

+ +
topicDescription
+

a character

+ + +

ManagedTopics

+
fullName
+

a character (inherited from Metadata)

+ +
managedTopic
+

a ManagedTopic

+ + +

MarketingActionSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableMarketingAction
+

a character either 'true' or 'false'

+ + +

MarketingResourceType

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
masterLabel
+

a character

+ +
object
+

a character

+ +
provider
+

a character

+ + +

MatchingRule

+
fullName
+

a character (inherited from Metadata)

+ +
booleanFilter
+

a character

+ +
description
+

a character

+ +
label
+

a character

+ +
matchingRuleItems
+

a MatchingRuleItem

+ +
ruleStatus
+

a MatchingRuleStatus - which is a character taking one of the following values:

  • Inactive

    • +

  • DeactivationFailed

    • +

  • Activating

    • +

  • Deactivating

    • +

  • Active

    • +

  • ActivationFailed

    • +
+ + +

MatchingRuleItem

+
blankValueBehavior
+

a BlankValueBehavior - which is a character taking one of the following values:

  • MatchBlanks

    • +

  • NullNotAllowed

    • +
+ +
fieldName
+

a character

+ +
matchingMethod
+

a MatchingMethod - which is a character taking one of the following values:

  • Exact

    • +

  • FirstName

    • +

  • LastName

    • +

  • CompanyName

    • +

  • Phone

    • +

  • City

    • +

  • Street

    • +

  • Zip

    • +

  • Title

    • +
+ + +

MatchingRules

+
fullName
+

a character (inherited from Metadata)

+ +
matchingRules
+

a MatchingRule

+ + +

Metadata

+
fullName
+

a character

+ + +

MetadataWithContent

+
fullName
+

a character (inherited from Metadata)

+ +
content
+

a character formed using base64encode

+ + +

MilestoneType

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
recurrenceType
+

a MilestoneTypeRecurrenceType - which is a character taking one of the following values:

  • none

    • +

  • recursIndependently

    • +

  • recursChained

    • +
+ + +

MiniLayout

+
fields
+

a character

+ +
relatedLists
+

a RelatedListItem

+ + +

MobileSettings

+
fullName
+

a character (inherited from Metadata)

+ +
chatterMobile
+

a ChatterMobileSettings

+ +
dashboardMobile
+

a DashboardMobileSettings

+ +
salesforceMobile
+

a SFDCMobileSettings

+ +
touchMobile
+

a TouchMobileSettings

+ + +

ModeratedEntityField

+
entityName
+

a character

+ +
fieldName
+

a character

+ +
keywordList
+

a character

+ + +

ModerationRule

+
fullName
+

a character (inherited from Metadata)

+ +
action
+

a ModerationRuleAction - which is a character taking one of the following values:

  • Block

    • +

  • FreezeAndNotify

    • +

  • Review

    • +

  • Replace

    • +

  • Flag

    • +
+ +
actionLimit
+

an integer

+ +
active
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
entitiesAndFields
+

a ModeratedEntityField

+ +
masterLabel
+

a character

+ +
notifyLimit
+

an integer

+ +
timePeriod
+

a RateLimitTimePeriod - which is a character taking one of the following values:

  • Short

    • +

  • Medium

    • +
+ +
type
+

a ModerationRuleType - which is a character taking one of the following values:

  • Content

    • +

  • Rate

    • +
+ +
userCriteria
+

a character

+ +
userMessage
+

a character

+ + +

NamedCredential

+
fullName
+

a character (inherited from Metadata)

+ +
allowMergeFieldsInBody
+

a character either 'true' or 'false'

+ +
allowMergeFieldsInHeader
+

a character either 'true' or 'false'

+ +
authProvider
+

a character

+ +
certificate
+

a character

+ +
endpoint
+

a character

+ +
generateAuthorizationHeader
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
oauthRefreshToken
+

a character

+ +
oauthScope
+

a character

+ +
oauthToken
+

a character

+ +
password
+

a character

+ +
principalType
+

a ExternalPrincipalType - which is a character taking one of the following values:

  • Anonymous

    • +

  • PerUser

    • +

  • NamedUser

    • +
+ +
protocol
+

a AuthenticationProtocol - which is a character taking one of the following values:

  • NoAuthentication

    • +

  • Oauth

    • +

  • Password

    • +
+ +
username
+

a character

+ + +

NameSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableMiddleName
+

a character either 'true' or 'false'

+ +
enableNameSuffix
+

a character either 'true' or 'false'

+ + +

NavigationLinkSet

+
navigationMenuItem
+

a NavigationMenuItem

+ + +

NavigationMenuItem

+
defaultListViewId
+

a character

+ +
label
+

a character

+ +
position
+

an integer

+ +
publiclyAvailable
+

a character either 'true' or 'false'

+ +
subMenu
+

a NavigationSubMenu

+ +
target
+

a character

+ +
targetPreference
+

a character

+ +
type
+

a character

+ + +

NavigationSubMenu

+
navigationMenuItem
+

a NavigationMenuItem

+ + +

Network

+
fullName
+

a character (inherited from Metadata)

+ +
allowInternalUserLogin
+

a character either 'true' or 'false'

+ +
allowMembersToFlag
+

a character either 'true' or 'false'

+ +
allowedExtensions
+

a character

+ +
caseCommentEmailTemplate
+

a character

+ +
changePasswordTemplate
+

a character

+ +
communityRoles
+

a CommunityRoles

+ +
description
+

a character

+ +
disableReputationRecordConversations
+

a character either 'true' or 'false'

+ +
emailFooterLogo
+

a character

+ +
emailFooterText
+

a character

+ +
emailSenderAddress
+

a character

+ +
emailSenderName
+

a character

+ +
enableCustomVFErrorPageOverrides
+

a character either 'true' or 'false'

+ +
enableDirectMessages
+

a character either 'true' or 'false'

+ +
enableGuestChatter
+

a character either 'true' or 'false'

+ +
enableGuestFileAccess
+

a character either 'true' or 'false'

+ +
enableInvitation
+

a character either 'true' or 'false'

+ +
enableKnowledgeable
+

a character either 'true' or 'false'

+ +
enableNicknameDisplay
+

a character either 'true' or 'false'

+ +
enablePrivateMessages
+

a character either 'true' or 'false'

+ +
enableReputation
+

a character either 'true' or 'false'

+ +
enableShowAllNetworkSettings
+

a character either 'true' or 'false'

+ +
enableSiteAsContainer
+

a character either 'true' or 'false'

+ +
enableTalkingAboutStats
+

a character either 'true' or 'false'

+ +
enableTopicAssignmentRules
+

a character either 'true' or 'false'

+ +
enableTopicSuggestions
+

a character either 'true' or 'false'

+ +
enableUpDownVote
+

a character either 'true' or 'false'

+ +
feedChannel
+

a character

+ +
forgotPasswordTemplate
+

a character

+ +
gatherCustomerSentimentData
+

a character either 'true' or 'false'

+ +
logoutUrl
+

a character

+ +
maxFileSizeKb
+

an integer

+ +
navigationLinkSet
+

a NavigationLinkSet

+ +
networkMemberGroups
+

a NetworkMemberGroup

+ +
networkPageOverrides
+

a NetworkPageOverride

+ +
newSenderAddress
+

a character

+ +
picassoSite
+

a character

+ +
recommendationAudience
+

a RecommendationAudience

+ +
recommendationDefinition
+

a RecommendationDefinition

+ +
reputationLevels
+

a ReputationLevelDefinitions

+ +
reputationPointsRules
+

a ReputationPointsRules

+ +
selfRegProfile
+

a character

+ +
selfRegistration
+

a character either 'true' or 'false'

+ +
sendWelcomeEmail
+

a character either 'true' or 'false'

+ +
site
+

a character

+ +
status
+

a NetworkStatus - which is a character taking one of the following values:

  • UnderConstruction

    • +

  • Live

    • +

  • DownForMaintenance

    • +
+ +
tabs
+

a NetworkTabSet

+ +
urlPathPrefix
+

a character

+ +
welcomeTemplate
+

a character

+ + +

NetworkAccess

+
ipRanges
+

a IpRange

+ + +

NetworkBranding

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
loginFooterText
+

a character

+ +
loginLogo
+

a character

+ +
loginLogoName
+

a character

+ +
loginPrimaryColor
+

a character

+ +
loginQuaternaryColor
+

a character

+ +
loginRightFrameUrl
+

a character

+ +
network
+

a character

+ +
pageFooter
+

a character

+ +
pageHeader
+

a character

+ +
primaryColor
+

a character

+ +
primaryComplementColor
+

a character

+ +
quaternaryColor
+

a character

+ +
quaternaryComplementColor
+

a character

+ +
secondaryColor
+

a character

+ +
staticLogoImageUrl
+

a character

+ +
tertiaryColor
+

a character

+ +
tertiaryComplementColor
+

a character

+ +
zeronaryColor
+

a character

+ +
zeronaryComplementColor
+

a character

+ + +

NetworkMemberGroup

+
permissionSet
+

a character

+ +
profile
+

a character

+ + +

NetworkPageOverride

+
changePasswordPageOverrideSetting
+

a NetworkPageOverrideSetting - which is a character taking one of the following values:

  • Designer

    • +

  • VisualForce

    • +

  • Standard

    • +
+ +
forgotPasswordPageOverrideSetting
+

a NetworkPageOverrideSetting - which is a character taking one of the following values:

  • Designer

    • +

  • VisualForce

    • +

  • Standard

    • +
+ +
homePageOverrideSetting
+

a NetworkPageOverrideSetting - which is a character taking one of the following values:

  • Designer

    • +

  • VisualForce

    • +

  • Standard

    • +
+ +
loginPageOverrideSetting
+

a NetworkPageOverrideSetting - which is a character taking one of the following values:

  • Designer

    • +

  • VisualForce

    • +

  • Standard

    • +
+ +
selfRegProfilePageOverrideSetting
+

a NetworkPageOverrideSetting - which is a character taking one of the following values:

  • Designer

    • +

  • VisualForce

    • +

  • Standard

    • +
+ + +

NetworkTabSet

+
customTab
+

a character

+ +
defaultTab
+

a character

+ +
standardTab
+

a character

+ + +

NextAutomatedApprover

+
useApproverFieldOfRecordOwner
+

a character either 'true' or 'false'

+ +
userHierarchyField
+

a character

+ + +

ObjectMapping

+
inputObject
+

a character

+ +
mappingFields
+

a ObjectMappingField

+ +
outputObject
+

a character

+ + +

ObjectMappingField

+
inputField
+

a character

+ +
outputField
+

a character

+ + +

ObjectNameCaseValue

+
article
+

a Article - which is a character taking one of the following values:

  • None

    • +

  • Indefinite

    • +

  • Definite

    • +
+ +
caseType
+

a CaseType - which is a character taking one of the following values:

  • Nominative

    • +

  • Accusative

    • +

  • Genitive

    • +

  • Dative

    • +

  • Inessive

    • +

  • Elative

    • +

  • Illative

    • +

  • Adessive

    • +

  • Ablative

    • +

  • Allative

    • +

  • Essive

    • +

  • Translative

    • +

  • Partitive

    • +

  • Objective

    • +

  • Subjective

    • +

  • Instrumental

    • +

  • Prepositional

    • +

  • Locative

    • +

  • Vocative

    • +

  • Sublative

    • +

  • Superessive

    • +

  • Delative

    • +

  • Causalfinal

    • +

  • Essiveformal

    • +

  • Termanative

    • +

  • Distributive

    • +

  • Ergative

    • +

  • Adverbial

    • +

  • Abessive

    • +

  • Comitative

    • +
+ +
plural
+

a character either 'true' or 'false'

+ +
possessive
+

a Possessive - which is a character taking one of the following values:

  • None

    • +

  • First

    • +

  • Second

    • +
+ +
value
+

a character

+ + +

ObjectRelationship

+
join
+

a ObjectRelationship

+ +
outerJoin
+

a character either 'true' or 'false'

+ +
relationship
+

a character

+ + +

ObjectSearchSetting

+
enhancedLookupEnabled
+

a character either 'true' or 'false'

+ +
lookupAutoCompleteEnabled
+

a character either 'true' or 'false'

+ +
name
+

a character

+ +
resultsPerPageCount
+

an integer

+ + +

ObjectUsage

+
object
+

a character

+ + +

OpportunityListFieldsLabelMapping

+
field
+

a character

+ +
label
+

a character

+ + +

OpportunityListFieldsSelectedSettings

+
field
+

a character

+ + +

OpportunityListFieldsUnselectedSettings

+
field
+

a character

+ + +

OpportunitySettings

+
fullName
+

a character (inherited from Metadata)

+ +
autoActivateNewReminders
+

a character either 'true' or 'false'

+ +
enableFindSimilarOpportunities
+

a character either 'true' or 'false'

+ +
enableOpportunityTeam
+

a character either 'true' or 'false'

+ +
enableUpdateReminders
+

a character either 'true' or 'false'

+ +
findSimilarOppFilter
+

a FindSimilarOppFilter

+ +
promptToAddProducts
+

a character either 'true' or 'false'

+ + +

Orchestration

+
content
+

a character formed using base64encode (inherited from MetadataWithContent)

+ +
context
+

a character

+ +
masterLabel
+

a character

+ + +

OrchestrationContext

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
events
+

a OrchestrationContextEvent

+ +
masterLabel
+

a character

+ +
runtimeType
+

a character

+ +
salesforceObject
+

a character

+ +
salesforceObjectPrimaryKey
+

a character

+ + +

OrchestrationContextEvent

+
eventType
+

a character

+ +
orchestrationEvent
+

a character

+ +
platformEvent
+

a character

+ +
platformEventPrimaryKey
+

a character

+ + +

OrderSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableNegativeQuantity
+

a character either 'true' or 'false'

+ +
enableOrders
+

a character either 'true' or 'false'

+ +
enableReductionOrders
+

a character either 'true' or 'false'

+ +
enableZeroQuantity
+

a character either 'true' or 'false'

+ + +

OrganizationSettingsDetail

+
settingName
+

a character

+ +
settingValue
+

a character either 'true' or 'false'

+ + +

OrgPreferenceSettings

+
fullName
+

a character (inherited from Metadata)

+ +
preferences
+

a OrganizationSettingsDetail

+ + +

Package

+
fullName
+

a character (inherited from Metadata)

+ +
apiAccessLevel
+

a APIAccessLevel - which is a character taking one of the following values:

  • Unrestricted

    • +

  • Restricted

    • +
+ +
description
+

a character

+ +
namespacePrefix
+

a character

+ +
objectPermissions
+

a ProfileObjectPermissions

+ +
packageType
+

a character

+ +
postInstallClass
+

a character

+ +
setupWeblink
+

a character

+ +
types
+

a PackageTypeMembers

+ +
uninstallClass
+

a character

+ +
version
+

a character

+ + +

PackageTypeMembers

+
members
+

a character

+ +
name
+

a character

+ + +

PackageVersion

+
majorNumber
+

an integer

+ +
minorNumber
+

an integer

+ +
namespace
+

a character

+ + +

PasswordPolicies

+
apiOnlyUserHomePageURL
+

a character

+ +
complexity
+

a Complexity - which is a character taking one of the following values:

  • NoRestriction

    • +

  • AlphaNumeric

    • +

  • SpecialCharacters

    • +

  • UpperLowerCaseNumeric

    • +

  • UpperLowerCaseNumericSpecialCharacters

    • +
+ +
expiration
+

a Expiration - which is a character taking one of the following values:

  • ThirtyDays

    • +

  • SixtyDays

    • +

  • NinetyDays

    • +

  • SixMonths

    • +

  • OneYear

    • +

  • Never

    • +
+ +
historyRestriction
+

a character

+ +
lockoutInterval
+

a LockoutInterval - which is a character taking one of the following values:

  • FifteenMinutes

    • +

  • ThirtyMinutes

    • +

  • SixtyMinutes

    • +

  • Forever

    • +
+ +
maxLoginAttempts
+

a MaxLoginAttempts - which is a character taking one of the following values:

  • ThreeAttempts

    • +

  • FiveAttempts

    • +

  • TenAttempts

    • +

  • NoLimit

    • +
+ +
minimumPasswordLength
+

a character

+ +
minimumPasswordLifetime
+

a character either 'true' or 'false'

+ +
obscureSecretAnswer
+

a character either 'true' or 'false'

+ +
passwordAssistanceMessage
+

a character

+ +
passwordAssistanceURL
+

a character

+ +
questionRestriction
+

a QuestionRestriction - which is a character taking one of the following values:

  • None

    • +

  • DoesNotContainPassword

    • +
+ + +

PathAssistant

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
entityName
+

a character

+ +
fieldName
+

a character

+ +
masterLabel
+

a character

+ +
pathAssistantSteps
+

a PathAssistantStep

+ +
recordTypeName
+

a character

+ + +

PathAssistantSettings

+
fullName
+

a character (inherited from Metadata)

+ +
pathAssistantEnabled
+

a character either 'true' or 'false'

+ + +

PathAssistantStep

+
fieldNames
+

a character

+ +
info
+

a character

+ +
picklistValueName
+

a character

+ + +

PermissionSet

+
fullName
+

a character (inherited from Metadata)

+ +
applicationVisibilities
+

a PermissionSetApplicationVisibility

+ +
classAccesses
+

a PermissionSetApexClassAccess

+ +
customPermissions
+

a PermissionSetCustomPermissions

+ +
description
+

a character

+ +
externalDataSourceAccesses
+

a PermissionSetExternalDataSourceAccess

+ +
fieldPermissions
+

a PermissionSetFieldPermissions

+ +
hasActivationRequired
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
license
+

a character

+ +
objectPermissions
+

a PermissionSetObjectPermissions

+ +
pageAccesses
+

a PermissionSetApexPageAccess

+ +
recordTypeVisibilities
+

a PermissionSetRecordTypeVisibility

+ +
tabSettings
+

a PermissionSetTabSetting

+ +
userPermissions
+

a PermissionSetUserPermission

+ + +

PermissionSetApexClassAccess

+
apexClass
+

a character

+ +
enabled
+

a character either 'true' or 'false'

+ + +

PermissionSetApexPageAccess

+
apexPage
+

a character

+ +
enabled
+

a character either 'true' or 'false'

+ + +

PermissionSetApplicationVisibility

+
application
+

a character

+ +
visible
+

a character either 'true' or 'false'

+ + +

PermissionSetCustomPermissions

+
enabled
+

a character either 'true' or 'false'

+ +
name
+

a character

+ + +

PermissionSetExternalDataSourceAccess

+
enabled
+

a character either 'true' or 'false'

+ +
externalDataSource
+

a character

+ + +

PermissionSetFieldPermissions

+
editable
+

a character either 'true' or 'false'

+ +
field
+

a character

+ +
readable
+

a character either 'true' or 'false'

+ + +

PermissionSetGroup

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
isCalculatingChanges
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
permissionSets
+

a character

+ + +

PermissionSetObjectPermissions

+
allowCreate
+

a character either 'true' or 'false'

+ +
allowDelete
+

a character either 'true' or 'false'

+ +
allowEdit
+

a character either 'true' or 'false'

+ +
allowRead
+

a character either 'true' or 'false'

+ +
modifyAllRecords
+

a character either 'true' or 'false'

+ +
object
+

a character

+ +
viewAllRecords
+

a character either 'true' or 'false'

+ + +

PermissionSetRecordTypeVisibility

+
recordType
+

a character

+ +
visible
+

a character either 'true' or 'false'

+ + +

PermissionSetTabSetting

+
tab
+

a character

+ +
visibility
+

a PermissionSetTabVisibility - which is a character taking one of the following values:

  • None

    • +

  • Available

    • +

  • Visible

    • +
+ + +

PermissionSetUserPermission

+
enabled
+

a character either 'true' or 'false'

+ +
name
+

a character

+ + +

PersonalJourneySettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableExactTargetForSalesforceApps
+

a character either 'true' or 'false'

+ + +

PersonListSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enablePersonList
+

a character either 'true' or 'false'

+ + +

PicklistEntry

+
active
+

a character either 'true' or 'false'

+ +
defaultValue
+

a character either 'true' or 'false'

+ +
label
+

a character

+ +
validFor
+

a character

+ +
value
+

a character

+ + +

PicklistValue

+
color
+

a character (inherited from GlobalPicklistValue)

+ +
default
+

a character either 'true' or 'false' (inherited from GlobalPicklistValue)

+ +
description
+

a character (inherited from GlobalPicklistValue)

+ +
isActive
+

a character either 'true' or 'false' (inherited from GlobalPicklistValue)

+ +
allowEmail
+

a character either 'true' or 'false'

+ +
closed
+

a character either 'true' or 'false'

+ +
controllingFieldValues
+

a character

+ +
converted
+

a character either 'true' or 'false'

+ +
cssExposed
+

a character either 'true' or 'false'

+ +
forecastCategory
+

a ForecastCategories - which is a character taking one of the following values:

  • Omitted

    • +

  • Pipeline

    • +

  • BestCase

    • +

  • Forecast

    • +

  • Closed

    • +
+ +
highPriority
+

a character either 'true' or 'false'

+ +
probability
+

an integer

+ +
reverseRole
+

a character

+ +
reviewed
+

a character either 'true' or 'false'

+ +
won
+

a character either 'true' or 'false'

+ + +

PicklistValueTranslation

+
masterLabel
+

a character

+ +
translation
+

a character

+ + +

PlatformActionList

+
fullName
+

a character (inherited from Metadata)

+ +
actionListContext
+

a PlatformActionListContext - which is a character taking one of the following values:

  • ListView

    • +

  • RelatedList

    • +

  • ListViewRecord

    • +

  • RelatedListRecord

    • +

  • Record

    • +

  • FeedElement

    • +

  • Chatter

    • +

  • Global

    • +

  • Flexipage

    • +

  • MruList

    • +

  • MruRow

    • +

  • RecordEdit

    • +

  • Photo

    • +

  • BannerPhoto

    • +

  • ObjectHomeChart

    • +

  • ListViewDefinition

    • +

  • Dockable

    • +

  • Lookup

    • +

  • Assistant

    • +
+ +
platformActionListItems
+

a PlatformActionListItem

+ +
relatedSourceEntity
+

a character

+ + +

PlatformActionListItem

+
actionName
+

a character

+ +
actionType
+

a PlatformActionType - which is a character taking one of the following values:

  • QuickAction

    • +

  • StandardButton

    • +

  • CustomButton

    • +

  • ProductivityAction

    • +

  • ActionLink

    • +

  • InvocableAction

    • +
+ +
sortOrder
+

an integer

+ +
subtype
+

a character

+ + +

PlatformCachePartition

+
fullName
+

a character (inherited from Metadata)

+ +
description
+

a character

+ +
isDefaultPartition
+

a character either 'true' or 'false'

+ +
masterLabel
+

a character

+ +
platformCachePartitionTypes
+

a PlatformCachePartitionType

+ + +

PlatformCachePartitionType

+
allocatedCapacity
+

an integer

+ +
allocatedPurchasedCapacity
+

an integer

+ +
allocatedTrialCapacity
+

an integer

+ +
cacheType
+

a PlatformCacheType - which is a character taking one of the following values:

  • Session

    • +

  • Organization

    • +
+ + +

Portal

+
fullName
+

a character (inherited from Metadata)

+ +
active
+

a character either 'true' or 'false'

+ +
admin
+

a character

+ +
defaultLanguage
+

a character

+ +
description
+

a character

+ +
emailSenderAddress
+

a character

+ +
emailSenderName
+

a character

+ +
enableSelfCloseCase
+

a character either 'true' or 'false'

+ +
footerDocument
+

a character

+ +
forgotPassTemplate
+

a character

+ +
headerDocument
+

a character

+ +
isSelfRegistrationActivated
+

a character either 'true' or 'false'

+ +
loginHeaderDocument
+

a character

+ +
logoDocument
+

a character

+ +
logoutUrl
+

a character

+ +
newCommentTemplate
+

a character

+ +
newPassTemplate
+

a character

+ +
newUserTemplate
+

a character

+ +
ownerNotifyTemplate
+

a character

+ +
selfRegNewUserUrl
+

a character

+ +
selfRegUserDefaultProfile
+

a character

+ +
selfRegUserDefaultRole
+

a PortalRoles - which is a character taking one of the following values:

  • Executive

    • +

  • Manager

    • +

  • Worker

    • +

  • PersonAccount

    • +
+ +
selfRegUserTemplate
+

a character

+ +
showActionConfirmation
+

a character either 'true' or 'false'

+ +
stylesheetDocument
+

a character

+ +
type
+

a PortalType - which is a character taking one of the following values:

  • CustomerSuccess

    • +

  • Partner

    • +

  • Network

    • +
+ + +

PostTemplate

+
fullName
+

a character (inherited from Metadata)

+ +
default
+

a character either 'true' or 'false'

+ +
description
+

a character

+ +
fields
+

a character

+ +
label
+

a character

+ + +

PrimaryTabComponents

+
containers
+

a Container

+ + +

ProductSettings

+
fullName
+

a character (inherited from Metadata)

+ +
enableCascadeActivateToRelatedPrices
+

a character either 'true' or 'false'

+ +
enableQuantitySchedule
+

a character either 'true' or 'false'

+ +
enableRevenueSchedule
+

a character either 'true' or 'false'

+ + +

Profile

+
fullName
+

a character (inherited from Metadata)

+ +
applicationVisibilities
+

a ProfileApplicationVisibility

+ +
categoryGroupVisibilities
+

a ProfileCategoryGroupVisibility

+ +
classAccesses
+

a ProfileApexClassAccess

+ +
custom
+

a character either 'true' or 'false'

+ +
customPermissions
+

a ProfileCustomPermissions

+ +
description
+

a character

+ +
externalDataSourceAccesses
+

a ProfileExternalDataSourceAccess

+ +
fieldPermissions
+

a ProfileFieldLevelSecurity

+ +
layoutAssignments
+

a ProfileLayoutAssignment

+ +
loginHours
+

a ProfileLoginHours

+ +
loginIpRanges
+

a ProfileLoginIpRange

+ +
objectPermissions
+

a ProfileObjectPermissions

+ +
pageAccesses
+

a ProfileApexPageAccess

+ +
profileActionOverrides
+

a ProfileActionOverride

+ +
recordTypeVisibilities
+

a ProfileRecordTypeVisibility

+ +
tabVisibilities
+

a ProfileTabVisibility

+ +
userLicense
+

a character

+ +
userPermissions
+

a ProfileUserPermission

+ + +

ProfileActionOverride

+
actionName
+

a character

+ +
content
+

a character

+ +
formFactor
+

a FormFactor - which is a character taking one of the following values:

  • Small

    • +

  • Medium

    • +

  • Large

    • +
+ +
pageOrSobjectType
+

a character

+ +
recordType
+

a character

+ +
type
+

a ActionOverrideType - which is a character taking one of the following values:

  • Default

  • Standard

    • -

  • Invite

    • -

-
windowLanguage

a Language - which is a character taking one of the following values: -

    -

  • en_US

    • -

  • de

    • -

  • es

    • -

  • fr

    • -

  • it

    • -

  • ja

    • -

  • sv

    • -

  • ko

    • -

  • zh_TW

    • -

  • zh_CN

    • -

  • pt_BR

    • -

  • nl_NL

    • -

  • da

    • -

  • th

    • -

  • fi

    • -

  • ru

    • -

  • es_MX

    • -

  • no

    • -

  • hu

    • -

  • pl

    • -

  • cs

    • -

  • tr

    • -

  • in

    • -

  • ro

    • -

  • vi

    • -

  • uk

    • -

  • iw

    • -

  • el

    • -

  • bg

    • -

  • en_GB

    • -

  • ar

    • -

  • sk

    • -

  • pt_PT

    • -

  • hr

    • -

  • sl

    • -

  • fr_CA

    • -

  • ka

    • -

  • sr

    • -

  • sh

    • -

  • en_AU

    • -

  • en_MY

    • -

  • en_IN

    • -

  • en_PH

    • -

  • en_CA

    • -

  • ro_MD

    • -

  • bs

    • -

  • mk

    • -

  • lv

    • -

  • lt

    • -

  • et

    • -

  • sq

    • -

  • sh_ME

    • -

  • mt

    • -

  • ga

    • -

  • eu

    • -

  • cy

    • -

  • is

    • -

  • ms

    • -

  • tl

    • -

  • lb

    • -

  • rm

    • -

  • hy

    • -

  • hi

    • -

  • ur

    • -

  • bn

    • -

  • de_AT

    • -

  • de_CH

    • -

  • ta

    • -

  • ar_DZ

    • -

  • ar_BH

    • -

  • ar_EG

    • -

  • ar_IQ

    • -

  • ar_JO

    • -

  • ar_KW

    • -

  • ar_LB

    • -

  • ar_LY

    • -

  • ar_MA

    • -

  • ar_OM

    • -

  • ar_QA

    • -

  • ar_SA

    • -

  • ar_SD

    • -

  • ar_SY

    • -

  • ar_TN

    • -

  • ar_AE

    • -

  • ar_YE

    • -

  • zh_SG

    • -

  • zh_HK

    • -

  • en_HK

    • -

  • en_IE

    • -

  • en_SG

    • -

  • en_ZA

    • -

  • fr_BE

    • -

  • fr_LU

    • -

  • fr_CH

    • -

  • de_BE

    • -

  • de_LU

    • -

  • it_CH

    • -

  • nl_BE

    • -

  • es_AR

    • -

  • es_BO

    • -

  • es_CL

    • -

  • es_CO

    • -

  • es_CR

    • -

  • es_DO

    • -

  • es_EC

    • -

  • es_SV

    • -

  • es_GT

    • -

  • es_HN

    • -

  • es_NI

    • -

  • es_PA

    • -

  • es_PY

    • -

  • es_PE

    • -

  • es_PR

    • -

  • es_US

    • -

  • es_UY

    • -

  • es_VE

    • -

  • ca

    • -

  • eo

    • -

  • iw_EO

    • -

- -
- -

LiveChatButtonDeployments

-
-
deployment

a character

- -
- -

LiveChatButtonSkills

-
-
skill

a character

- -
- -

LiveChatDeployment

-
-
fullName

a character (inherited from Metadata)

-
brandingImage

a character

-
connectionTimeoutDuration

an integer

-
connectionWarningDuration

an integer

-
displayQueuePosition

a character either 'true' or 'false'

-
domainWhiteList

a LiveChatDeploymentDomainWhitelist

-
enablePrechatApi

a character either 'true' or 'false'

-
enableTranscriptSave

a character either 'true' or 'false'

-
label

a character

-
mobileBrandingImage

a character

-
site

a character

-
windowTitle

a character

- -
- -

LiveChatDeploymentDomainWhitelist

-
-
domain

a character

- -
- -

LiveChatSensitiveDataRule

-
-
fullName

a character (inherited from Metadata)

-
actionType

a SensitiveDataActionType - which is a character taking one of the following values: -

    -

  • Remove

    • -

  • Replace

    • -

-
description

a character

-
enforceOn

an integer

-
isEnabled

a character either 'true' or 'false'

-
pattern

a character

-
replacement

a character

- -
- -

LiveMessageSettings

-
-
fullName

a character (inherited from Metadata)

-
enableLiveMessage

a character either 'true' or 'false'

- -
- -

LogInfo

-
-
category

a LogCategory - which is a character taking one of the following values: -

    -

  • Db

    • -

  • Workflow

    • -

  • Validation

    • -

  • Callout

    • -

  • Apex_code

    • -

  • Apex_profiling

    • +

  • Scontrol

  • Visualforce

    • -

  • System

    • -

  • Wave

    • -

  • All

    • -

-
level

a LogCategoryLevel - which is a character taking one of the following values: -

    -

  • None

    • -

  • Finest

    • -

  • Finer

    • -

  • Fine

    • -

  • Debug

    • -

  • Info

    • -

  • Warn

    • -

  • Error

    • -

- -
- -

LookupFilter

-
-
active

a character either 'true' or 'false'

-
booleanFilter

a character

-
description

a character

-
errorMessage

a character

-
filterItems

a FilterItem

-
infoMessage

a character

-
isOptional

a character either 'true' or 'false'

- -
- -

LookupFilterTranslation

-
-
errorMessage

a character

-
informationalMessage

a character

- -
- -

MacroSettings

-
-
fullName

a character (inherited from Metadata)

-
enableAdvancedSearch

a character either 'true' or 'false'

- -
- -

ManagedTopic

-
-
fullName

a character (inherited from Metadata)

-
managedTopicType

a character

-
name

a character

-
parentName

a character

-
position

an integer

-
topicDescription

a character

- -
- -

ManagedTopics

-
-
fullName

a character (inherited from Metadata)

-
managedTopic

a ManagedTopic

- -
- -

MarketingActionSettings

-
-
fullName

a character (inherited from Metadata)

-
enableMarketingAction

a character either 'true' or 'false'

- -
- -

MarketingResourceType

-
-
fullName

a character (inherited from Metadata)

-
description

a character

-
masterLabel

a character

-
object

a character

-
provider

a character

- -
- -

MatchingRule

-
-
fullName

a character (inherited from Metadata)

-
booleanFilter

a character

-
description

a character

-
label

a character

-
matchingRuleItems

a MatchingRuleItem

-
ruleStatus

a MatchingRuleStatus - which is a character taking one of the following values: -

    -

  • Inactive

    • -

  • DeactivationFailed

    • -

  • Activating

    • -

  • Deactivating

    • -

  • Active

    • -

  • ActivationFailed

    • -

+

  • Flexipage

    • +

  • LightningComponent

    • + + + +

    ProfileApexClassAccess

    +
    apexClass
    +

    a character

    + +
    enabled
    +

    a character either 'true' or 'false'

    + + +

    ProfileApexPageAccess

    +
    apexPage
    +

    a character

    + +
    enabled
    +

    a character either 'true' or 'false'

    + + +

    ProfileApplicationVisibility

    +
    application
    +

    a character

    + +
    default
    +

    a character either 'true' or 'false'

    + +
    visible
    +

    a character either 'true' or 'false'

    + + +

    ProfileCategoryGroupVisibility

    +
    dataCategories
    +

    a character

    + +
    dataCategoryGroup
    +

    a character

    + +
    visibility
    +

    a CategoryGroupVisibility - which is a character taking one of the following values:

    • ALL

      • +

    • NONE

      • +

    • CUSTOM

      • +
    + + +

    ProfileCustomPermissions

    +
    enabled
    +

    a character either 'true' or 'false'

    + +
    name
    +

    a character

    + + +

    ProfileExternalDataSourceAccess

    +
    enabled
    +

    a character either 'true' or 'false'

    + +
    externalDataSource
    +

    a character

    + + +

    ProfileFieldLevelSecurity

    +
    editable
    +

    a character either 'true' or 'false'

    + +
    field
    +

    a character

    + +
    readable
    +

    a character either 'true' or 'false'

    + + +

    ProfileLayoutAssignment

    +
    layout
    +

    a character

    + +
    recordType
    +

    a character

    + + +

    ProfileLoginHours

    +
    fridayEnd
    +

    a character

    + +
    fridayStart
    +

    a character

    + +
    mondayEnd
    +

    a character

    + +
    mondayStart
    +

    a character

    + +
    saturdayEnd
    +

    a character

    + +
    saturdayStart
    +

    a character

    + +
    sundayEnd
    +

    a character

    + +
    sundayStart
    +

    a character

    + +
    thursdayEnd
    +

    a character

    + +
    thursdayStart
    +

    a character

    + +
    tuesdayEnd
    +

    a character

    + +
    tuesdayStart
    +

    a character

    + +
    wednesdayEnd
    +

    a character

    + +
    wednesdayStart
    +

    a character

    + + +

    ProfileLoginIpRange

    +
    description
    +

    a character

    + +
    endAddress
    +

    a character

    + +
    startAddress
    +

    a character

    + + +

    ProfileObjectPermissions

    +
    allowCreate
    +

    a character either 'true' or 'false'

    + +
    allowDelete
    +

    a character either 'true' or 'false'

    + +
    allowEdit
    +

    a character either 'true' or 'false'

    + +
    allowRead
    +

    a character either 'true' or 'false'

    + +
    modifyAllRecords
    +

    a character either 'true' or 'false'

    + +
    object
    +

    a character

    + +
    viewAllRecords
    +

    a character either 'true' or 'false'

    + + +

    ProfilePasswordPolicy

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    lockoutInterval
    +

    an integer

    + +
    maxLoginAttempts
    +

    an integer

    + +
    minimumPasswordLength
    +

    an integer

    + +
    minimumPasswordLifetime
    +

    a character either 'true' or 'false'

    + +
    obscure
    +

    a character either 'true' or 'false'

    + +
    passwordComplexity
    +

    an integer

    + +
    passwordExpiration
    +

    an integer

    + +
    passwordHistory
    +

    an integer

    + +
    passwordQuestion
    +

    an integer

    + +
    profile
    +

    a character

    + + +

    ProfileRecordTypeVisibility

    +
    default
    +

    a character either 'true' or 'false'

    + +
    personAccountDefault
    +

    a character either 'true' or 'false'

    + +
    recordType
    +

    a character

    + +
    visible
    +

    a character either 'true' or 'false'

    + + +

    ProfileSessionSetting

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    externalCommunityUserIdentityVerif
    +

    a character either 'true' or 'false'

    + +
    forceLogout
    +

    a character either 'true' or 'false'

    -
    +
    profile
    +

    a character

    -

    MatchingRuleItem

    -
    -
    blankValueBehavior

    a BlankValueBehavior - which is a character taking one of the following values: -

      -

    • MatchBlanks

      • -

    • NullNotAllowed

      • -

    -
    fieldName

    a character

    -
    matchingMethod

    a MatchingMethod - which is a character taking one of the following values: -

      -

    • Exact

      • -

    • FirstName

      • -

    • LastName

      • -

    • CompanyName

      • -

    • Phone

      • -

    • City

      • -

    • Street

      • -

    • Zip

      • -

    • Title

      • -

    +
    requiredSessionLevel
    +

    a SessionSecurityLevel - which is a character taking one of the following values:

    • LOW

      • +

    • STANDARD

      • +

    • HIGH_ASSURANCE

      • +
    -
    +
    sessionPersistence
    +

    a character either 'true' or 'false'

    -

    MatchingRules

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    matchingRules

    a MatchingRule

    +
    sessionTimeout
    +

    an integer

    -
    +
    sessionTimeoutWarning
    +

    a character either 'true' or 'false'

    -

    Metadata

    -
    -
    fullName

    a character

    -
    +

    ProfileTabVisibility

    +
    tab
    +

    a character

    -

    MetadataWithContent

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    content

    a character formed using base64encode

    +
    visibility
    +

    a TabVisibility - which is a character taking one of the following values:

    • Hidden

      • +

    • DefaultOff

      • +

    • DefaultOn

      • +
    -
    -

    MilestoneType

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    recurrenceType

    a MilestoneTypeRecurrenceType - which is a character taking one of the following values: -

      -

    • none

      • -

    • recursIndependently

      • -

    • recursChained

      • -

    +

    ProfileUserPermission

    +
    enabled
    +

    a character either 'true' or 'false'

    -
    +
    name
    +

    a character

    -

    MiniLayout

    -
    -
    fields

    a character

    -
    relatedLists

    a RelatedListItem

    -
    +

    PublicGroups

    +
    publicGroup
    +

    a character

    -

    MobileSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    chatterMobile

    a ChatterMobileSettings

    -
    dashboardMobile

    a DashboardMobileSettings

    -
    salesforceMobile

    a SFDCMobileSettings

    -
    touchMobile

    a TouchMobileSettings

    -
    +

    PushNotification

    +
    fieldNames
    +

    a character

    -

    ModeratedEntityField

    -
    -
    entityName

    a character

    -
    fieldName

    a character

    -
    keywordList

    a character

    +
    objectName
    +

    a character

    -
    -

    ModerationRule

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    action

    a ModerationRuleAction - which is a character taking one of the following values: -

      -

    • Block

      • -

    • FreezeAndNotify

      • -

    • Review

      • -

    • Replace

      • -

    • Flag

      • -

    -
    actionLimit

    an integer

    -
    active

    a character either 'true' or 'false'

    -
    description

    a character

    -
    entitiesAndFields

    a ModeratedEntityField

    -
    masterLabel

    a character

    -
    notifyLimit

    an integer

    -
    timePeriod

    a RateLimitTimePeriod - which is a character taking one of the following values: -

      -

    • Short

      • -

    • Medium

      • -

    -
    type

    a ModerationRuleType - which is a character taking one of the following values: -

      -

    • Content

      • -

    • Rate

      • -

    -
    userCriteria

    a character

    -
    userMessage

    a character

    - -
    - -

    NamedCredential

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    allowMergeFieldsInBody

    a character either 'true' or 'false'

    -
    allowMergeFieldsInHeader

    a character either 'true' or 'false'

    -
    authProvider

    a character

    -
    certificate

    a character

    -
    endpoint

    a character

    -
    generateAuthorizationHeader

    a character either 'true' or 'false'

    -
    label

    a character

    -
    oauthRefreshToken

    a character

    -
    oauthScope

    a character

    -
    oauthToken

    a character

    -
    password

    a character

    -
    principalType

    a ExternalPrincipalType - which is a character taking one of the following values: -

      -

    • Anonymous

      • -

    • PerUser

      • -

    • NamedUser

      • -

    -
    protocol

    a AuthenticationProtocol - which is a character taking one of the following values: -

      -

    • NoAuthentication

      • -

    • Oauth

      • -

    • Password

      • -

    -
    username

    a character

    - -
    - -

    NameSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enableMiddleName

    a character either 'true' or 'false'

    -
    enableNameSuffix

    a character either 'true' or 'false'

    - -
    - -

    NavigationLinkSet

    -
    -
    navigationMenuItem

    a NavigationMenuItem

    - -
    - -

    NavigationMenuItem

    -
    -
    defaultListViewId

    a character

    -
    label

    a character

    -
    position

    an integer

    -
    publiclyAvailable

    a character either 'true' or 'false'

    -
    subMenu

    a NavigationSubMenu

    -
    target

    a character

    -
    targetPreference

    a character

    -
    type

    a character

    - -
    - -

    NavigationSubMenu

    -
    -
    navigationMenuItem

    a NavigationMenuItem

    - -
    - -

    Network

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    allowInternalUserLogin

    a character either 'true' or 'false'

    -
    allowMembersToFlag

    a character either 'true' or 'false'

    -
    allowedExtensions

    a character

    -
    caseCommentEmailTemplate

    a character

    -
    changePasswordTemplate

    a character

    -
    communityRoles

    a CommunityRoles

    -
    description

    a character

    -
    disableReputationRecordConversations

    a character either 'true' or 'false'

    -
    emailFooterLogo

    a character

    -
    emailFooterText

    a character

    -
    emailSenderAddress

    a character

    -
    emailSenderName

    a character

    -
    enableCustomVFErrorPageOverrides

    a character either 'true' or 'false'

    -
    enableDirectMessages

    a character either 'true' or 'false'

    -
    enableGuestChatter

    a character either 'true' or 'false'

    -
    enableGuestFileAccess

    a character either 'true' or 'false'

    -
    enableInvitation

    a character either 'true' or 'false'

    -
    enableKnowledgeable

    a character either 'true' or 'false'

    -
    enableNicknameDisplay

    a character either 'true' or 'false'

    -
    enablePrivateMessages

    a character either 'true' or 'false'

    -
    enableReputation

    a character either 'true' or 'false'

    -
    enableShowAllNetworkSettings

    a character either 'true' or 'false'

    -
    enableSiteAsContainer

    a character either 'true' or 'false'

    -
    enableTalkingAboutStats

    a character either 'true' or 'false'

    -
    enableTopicAssignmentRules

    a character either 'true' or 'false'

    -
    enableTopicSuggestions

    a character either 'true' or 'false'

    -
    enableUpDownVote

    a character either 'true' or 'false'

    -
    feedChannel

    a character

    -
    forgotPasswordTemplate

    a character

    -
    gatherCustomerSentimentData

    a character either 'true' or 'false'

    -
    logoutUrl

    a character

    -
    maxFileSizeKb

    an integer

    -
    navigationLinkSet

    a NavigationLinkSet

    -
    networkMemberGroups

    a NetworkMemberGroup

    -
    networkPageOverrides

    a NetworkPageOverride

    -
    newSenderAddress

    a character

    -
    picassoSite

    a character

    -
    recommendationAudience

    a RecommendationAudience

    -
    recommendationDefinition

    a RecommendationDefinition

    -
    reputationLevels

    a ReputationLevelDefinitions

    -
    reputationPointsRules

    a ReputationPointsRules

    -
    selfRegProfile

    a character

    -
    selfRegistration

    a character either 'true' or 'false'

    -
    sendWelcomeEmail

    a character either 'true' or 'false'

    -
    site

    a character

    -
    status

    a NetworkStatus - which is a character taking one of the following values: -

      -

    • UnderConstruction

      • -

    • Live

      • -

    • DownForMaintenance

      • -

    -
    tabs

    a NetworkTabSet

    -
    urlPathPrefix

    a character

    -
    welcomeTemplate

    a character

    - -
    - -

    NetworkAccess

    -
    -
    ipRanges

    a IpRange

    - -
    - -

    NetworkBranding

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    loginFooterText

    a character

    -
    loginLogo

    a character

    -
    loginLogoName

    a character

    -
    loginPrimaryColor

    a character

    -
    loginQuaternaryColor

    a character

    -
    loginRightFrameUrl

    a character

    -
    network

    a character

    -
    pageFooter

    a character

    -
    pageHeader

    a character

    -
    primaryColor

    a character

    -
    primaryComplementColor

    a character

    -
    quaternaryColor

    a character

    -
    quaternaryComplementColor

    a character

    -
    secondaryColor

    a character

    -
    staticLogoImageUrl

    a character

    -
    tertiaryColor

    a character

    -
    tertiaryComplementColor

    a character

    -
    zeronaryColor

    a character

    -
    zeronaryComplementColor

    a character

    - -
    - -

    NetworkMemberGroup

    -
    -
    permissionSet

    a character

    -
    profile

    a character

    - -
    - -

    NetworkPageOverride

    -
    -
    changePasswordPageOverrideSetting

    a NetworkPageOverrideSetting - which is a character taking one of the following values: -

      -

    • Designer

      • -

    • VisualForce

      • -

    • Standard

      • -

    -
    forgotPasswordPageOverrideSetting

    a NetworkPageOverrideSetting - which is a character taking one of the following values: -

      -

    • Designer

      • -

    • VisualForce

      • -

    • Standard

      • -

    -
    homePageOverrideSetting

    a NetworkPageOverrideSetting - which is a character taking one of the following values: -

      -

    • Designer

      • -

    • VisualForce

      • -

    • Standard

      • -

    -
    loginPageOverrideSetting

    a NetworkPageOverrideSetting - which is a character taking one of the following values: -

      -

    • Designer

      • -

    • VisualForce

      • -

    • Standard

      • -

    -
    selfRegProfilePageOverrideSetting

    a NetworkPageOverrideSetting - which is a character taking one of the following values: -

      -

    • Designer

      • -

    • VisualForce

      • -

    • Standard

      • -

    +

    Queue

    +
    fullName
    +

    a character (inherited from Metadata)

    -
    +
    doesSendEmailToMembers
    +

    a character either 'true' or 'false'

    -

    NetworkTabSet

    -
    -
    customTab

    a character

    -
    defaultTab

    a character

    -
    standardTab

    a character

    +
    email
    +

    a character

    -
    +
    name
    +

    a character

    -

    NextAutomatedApprover

    -
    -
    useApproverFieldOfRecordOwner

    a character either 'true' or 'false'

    -
    userHierarchyField

    a character

    +
    queueMembers
    +

    a QueueMembers

    -
    +
    queueRoutingConfig
    +

    a character

    -

    ObjectMapping

    -
    -
    inputObject

    a character

    -
    mappingFields

    a ObjectMappingField

    -
    outputObject

    a character

    +
    queueSobject
    +

    a QueueSobject

    -
    -

    ObjectMappingField

    -
    -
    inputField

    a character

    -
    outputField

    a character

    +

    QueueMembers

    +
    publicGroups
    +

    a PublicGroups

    -
    +
    roleAndSubordinates
    +

    a RoleAndSubordinates

    -

    ObjectNameCaseValue

    -
    -
    article

    a Article - which is a character taking one of the following values: -

      -

    • None

      • -

    • Indefinite

      • -

    • Definite

      • -

    -
    caseType

    a CaseType - which is a character taking one of the following values: -

      -

    • Nominative

      • -

    • Accusative

      • -

    • Genitive

      • -

    • Dative

      • -

    • Inessive

      • -

    • Elative

      • -

    • Illative

      • -

    • Adessive

      • -

    • Ablative

      • -

    • Allative

      • -

    • Essive

      • -

    • Translative

      • -

    • Partitive

      • -

    • Objective

      • -

    • Subjective

      • -

    • Instrumental

      • -

    • Prepositional

      • -

    • Locative

      • -

    • Vocative

      • -

    • Sublative

      • -

    • Superessive

      • -

    • Delative

      • -

    • Causalfinal

      • -

    • Essiveformal

      • -

    • Termanative

      • -

    • Distributive

      • -

    • Ergative

      • -

    • Adverbial

      • -

    • Abessive

      • -

    • Comitative

      • -

    -
    plural

    a character either 'true' or 'false'

    -
    possessive

    a Possessive - which is a character taking one of the following values: -

      -

    • None

      • -

    • First

      • -

    • Second

      • -

    -
    value

    a character

    +
    roleAndSubordinatesInternal
    +

    a RoleAndSubordinatesInternal

    -
    +
    roles
    +

    a Roles

    -

    ObjectRelationship

    -
    -
    join

    a ObjectRelationship

    -
    outerJoin

    a character either 'true' or 'false'

    -
    relationship

    a character

    +
    users
    +

    a Users

    -
    -

    ObjectSearchSetting

    -
    -
    enhancedLookupEnabled

    a character either 'true' or 'false'

    -
    lookupAutoCompleteEnabled

    a character either 'true' or 'false'

    -
    name

    a character

    -
    resultsPerPageCount

    an integer

    - -
    - -

    ObjectUsage

    -
    -
    object

    a character

    - -
    - -

    OpportunityListFieldsLabelMapping

    -
    -
    field

    a character

    -
    label

    a character

    - -
    - -

    OpportunityListFieldsSelectedSettings

    -
    -
    field

    a character

    - -
    - -

    OpportunityListFieldsUnselectedSettings

    -
    -
    field

    a character

    - -
    - -

    OpportunitySettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    autoActivateNewReminders

    a character either 'true' or 'false'

    -
    enableFindSimilarOpportunities

    a character either 'true' or 'false'

    -
    enableOpportunityTeam

    a character either 'true' or 'false'

    -
    enableUpdateReminders

    a character either 'true' or 'false'

    -
    findSimilarOppFilter

    a FindSimilarOppFilter

    -
    promptToAddProducts

    a character either 'true' or 'false'

    - -
    - -

    Orchestration

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    context

    a character

    -
    masterLabel

    a character

    - -
    - -

    OrchestrationContext

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    events

    a OrchestrationContextEvent

    -
    masterLabel

    a character

    -
    runtimeType

    a character

    -
    salesforceObject

    a character

    -
    salesforceObjectPrimaryKey

    a character

    - -
    - -

    OrchestrationContextEvent

    -
    -
    eventType

    a character

    -
    orchestrationEvent

    a character

    -
    platformEvent

    a character

    -
    platformEventPrimaryKey

    a character

    - -
    - -

    OrderSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enableNegativeQuantity

    a character either 'true' or 'false'

    -
    enableOrders

    a character either 'true' or 'false'

    -
    enableReductionOrders

    a character either 'true' or 'false'

    -
    enableZeroQuantity

    a character either 'true' or 'false'

    - -
    - -

    OrganizationSettingsDetail

    -
    -
    settingName

    a character

    -
    settingValue

    a character either 'true' or 'false'

    - -
    - -

    OrgPreferenceSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    preferences

    a OrganizationSettingsDetail

    - -
    - -

    Package

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    apiAccessLevel

    a APIAccessLevel - which is a character taking one of the following values: -

      -

    • Unrestricted

      • -

    • Restricted

      • -

    -
    description

    a character

    -
    namespacePrefix

    a character

    -
    objectPermissions

    a ProfileObjectPermissions

    -
    packageType

    a character

    -
    postInstallClass

    a character

    -
    setupWeblink

    a character

    -
    types

    a PackageTypeMembers

    -
    uninstallClass

    a character

    -
    version

    a character

    - -
    - -

    PackageTypeMembers

    -
    -
    members

    a character

    -
    name

    a character

    - -
    - -

    PackageVersion

    -
    -
    majorNumber

    an integer

    -
    minorNumber

    an integer

    -
    namespace

    a character

    - -
    - -

    PasswordPolicies

    -
    -
    apiOnlyUserHomePageURL

    a character

    -
    complexity

    a Complexity - which is a character taking one of the following values: -

      -

    • NoRestriction

      • -

    • AlphaNumeric

      • -

    • SpecialCharacters

      • -

    • UpperLowerCaseNumeric

      • -

    • UpperLowerCaseNumericSpecialCharacters

      • -

    -
    expiration

    a Expiration - which is a character taking one of the following values: -

      -

    • ThirtyDays

      • -

    • SixtyDays

      • -

    • NinetyDays

      • -

    • SixMonths

      • -

    • OneYear

      • -

    • Never

      • -

    -
    historyRestriction

    a character

    -
    lockoutInterval

    a LockoutInterval - which is a character taking one of the following values: -

      -

    • FifteenMinutes

      • -

    • ThirtyMinutes

      • -

    • SixtyMinutes

      • -

    • Forever

      • -

    -
    maxLoginAttempts

    a MaxLoginAttempts - which is a character taking one of the following values: -

      -

    • ThreeAttempts

      • -

    • FiveAttempts

      • -

    • TenAttempts

      • -

    • NoLimit

      • -

    -
    minimumPasswordLength

    a character

    -
    minimumPasswordLifetime

    a character either 'true' or 'false'

    -
    obscureSecretAnswer

    a character either 'true' or 'false'

    -
    passwordAssistanceMessage

    a character

    -
    passwordAssistanceURL

    a character

    -
    questionRestriction

    a QuestionRestriction - which is a character taking one of the following values: -

      -

    • None

      • -

    • DoesNotContainPassword

      • -

    - -
    - -

    PathAssistant

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    active

    a character either 'true' or 'false'

    -
    entityName

    a character

    -
    fieldName

    a character

    -
    masterLabel

    a character

    -
    pathAssistantSteps

    a PathAssistantStep

    -
    recordTypeName

    a character

    - -
    - -

    PathAssistantSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    pathAssistantEnabled

    a character either 'true' or 'false'

    - -
    - -

    PathAssistantStep

    -
    -
    fieldNames

    a character

    -
    info

    a character

    -
    picklistValueName

    a character

    - -
    - -

    PermissionSet

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    applicationVisibilities

    a PermissionSetApplicationVisibility

    -
    classAccesses

    a PermissionSetApexClassAccess

    -
    customPermissions

    a PermissionSetCustomPermissions

    -
    description

    a character

    -
    externalDataSourceAccesses

    a PermissionSetExternalDataSourceAccess

    -
    fieldPermissions

    a PermissionSetFieldPermissions

    -
    hasActivationRequired

    a character either 'true' or 'false'

    -
    label

    a character

    -
    license

    a character

    -
    objectPermissions

    a PermissionSetObjectPermissions

    -
    pageAccesses

    a PermissionSetApexPageAccess

    -
    recordTypeVisibilities

    a PermissionSetRecordTypeVisibility

    -
    tabSettings

    a PermissionSetTabSetting

    -
    userPermissions

    a PermissionSetUserPermission

    - -
    - -

    PermissionSetApexClassAccess

    -
    -
    apexClass

    a character

    -
    enabled

    a character either 'true' or 'false'

    - -
    - -

    PermissionSetApexPageAccess

    -
    -
    apexPage

    a character

    -
    enabled

    a character either 'true' or 'false'

    - -
    - -

    PermissionSetApplicationVisibility

    -
    -
    application

    a character

    -
    visible

    a character either 'true' or 'false'

    - -
    - -

    PermissionSetCustomPermissions

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    name

    a character

    - -
    - -

    PermissionSetExternalDataSourceAccess

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    externalDataSource

    a character

    - -
    - -

    PermissionSetFieldPermissions

    -
    -
    editable

    a character either 'true' or 'false'

    -
    field

    a character

    -
    readable

    a character either 'true' or 'false'

    - -
    - -

    PermissionSetGroup

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    isCalculatingChanges

    a character either 'true' or 'false'

    -
    label

    a character

    -
    permissionSets

    a character

    - -
    - -

    PermissionSetObjectPermissions

    -
    -
    allowCreate

    a character either 'true' or 'false'

    -
    allowDelete

    a character either 'true' or 'false'

    -
    allowEdit

    a character either 'true' or 'false'

    -
    allowRead

    a character either 'true' or 'false'

    -
    modifyAllRecords

    a character either 'true' or 'false'

    -
    object

    a character

    -
    viewAllRecords

    a character either 'true' or 'false'

    - -
    - -

    PermissionSetRecordTypeVisibility

    -
    -
    recordType

    a character

    -
    visible

    a character either 'true' or 'false'

    - -
    - -

    PermissionSetTabSetting

    -
    -
    tab

    a character

    -
    visibility

    a PermissionSetTabVisibility - which is a character taking one of the following values: -

      -

    • None

      • -

    • Available

      • -

    • Visible

      • -

    - -
    - -

    PermissionSetUserPermission

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    name

    a character

    - -
    - -

    PersonalJourneySettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enableExactTargetForSalesforceApps

    a character either 'true' or 'false'

    - -
    - -

    PersonListSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enablePersonList

    a character either 'true' or 'false'

    - -
    - -

    PicklistEntry

    -
    -
    active

    a character either 'true' or 'false'

    -
    defaultValue

    a character either 'true' or 'false'

    -
    label

    a character

    -
    validFor

    a character

    -
    value

    a character

    - -
    - -

    PicklistValue

    -
    -
    color

    a character (inherited from GlobalPicklistValue)

    -
    default

    a character either 'true' or 'false' (inherited from GlobalPicklistValue)

    -
    description

    a character (inherited from GlobalPicklistValue)

    -
    isActive

    a character either 'true' or 'false' (inherited from GlobalPicklistValue)

    -
    allowEmail

    a character either 'true' or 'false'

    -
    closed

    a character either 'true' or 'false'

    -
    controllingFieldValues

    a character

    -
    converted

    a character either 'true' or 'false'

    -
    cssExposed

    a character either 'true' or 'false'

    -
    forecastCategory

    a ForecastCategories - which is a character taking one of the following values: -

      -

    • Omitted

      • -

    • Pipeline

      • -

    • BestCase

      • -

    • Forecast

      • -

    • Closed

      • -

    -
    highPriority

    a character either 'true' or 'false'

    -
    probability

    an integer

    -
    reverseRole

    a character

    -
    reviewed

    a character either 'true' or 'false'

    -
    won

    a character either 'true' or 'false'

    - -
    - -

    PicklistValueTranslation

    -
    -
    masterLabel

    a character

    -
    translation

    a character

    - -
    - -

    PlatformActionList

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    actionListContext

    a PlatformActionListContext - which is a character taking one of the following values: -

      -

    • ListView

      • -

    • RelatedList

      • -

    • ListViewRecord

      • -

    • RelatedListRecord

      • -

    • Record

      • -

    • FeedElement

      • -

    • Chatter

      • -

    • Global

      • -

    • Flexipage

      • -

    • MruList

      • -

    • MruRow

      • -

    • RecordEdit

      • -

    • Photo

      • -

    • BannerPhoto

      • -

    • ObjectHomeChart

      • -

    • ListViewDefinition

      • -

    • Dockable

      • -

    • Lookup

      • -

    • Assistant

      • -

    -
    platformActionListItems

    a PlatformActionListItem

    -
    relatedSourceEntity

    a character

    - -
    - -

    PlatformActionListItem

    -
    -
    actionName

    a character

    -
    actionType

    a PlatformActionType - which is a character taking one of the following values: -

      -

    • QuickAction

      • -

    • StandardButton

      • -

    • CustomButton

      • -

    • ProductivityAction

      • -

    • ActionLink

      • -

    • InvocableAction

      • -

    -
    sortOrder

    an integer

    -
    subtype

    a character

    - -
    - -

    PlatformCachePartition

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    isDefaultPartition

    a character either 'true' or 'false'

    -
    masterLabel

    a character

    -
    platformCachePartitionTypes

    a PlatformCachePartitionType

    - -
    - -

    PlatformCachePartitionType

    -
    -
    allocatedCapacity

    an integer

    -
    allocatedPurchasedCapacity

    an integer

    -
    allocatedTrialCapacity

    an integer

    -
    cacheType

    a PlatformCacheType - which is a character taking one of the following values: -

      -

    • Session

      • -

    • Organization

      • -

    - -
    - -

    Portal

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    active

    a character either 'true' or 'false'

    -
    admin

    a character

    -
    defaultLanguage

    a character

    -
    description

    a character

    -
    emailSenderAddress

    a character

    -
    emailSenderName

    a character

    -
    enableSelfCloseCase

    a character either 'true' or 'false'

    -
    footerDocument

    a character

    -
    forgotPassTemplate

    a character

    -
    headerDocument

    a character

    -
    isSelfRegistrationActivated

    a character either 'true' or 'false'

    -
    loginHeaderDocument

    a character

    -
    logoDocument

    a character

    -
    logoutUrl

    a character

    -
    newCommentTemplate

    a character

    -
    newPassTemplate

    a character

    -
    newUserTemplate

    a character

    -
    ownerNotifyTemplate

    a character

    -
    selfRegNewUserUrl

    a character

    -
    selfRegUserDefaultProfile

    a character

    -
    selfRegUserDefaultRole

    a PortalRoles - which is a character taking one of the following values: -

      -

    • Executive

      • -

    • Manager

      • -

    • Worker

      • -

    • PersonAccount

      • -

    -
    selfRegUserTemplate

    a character

    -
    showActionConfirmation

    a character either 'true' or 'false'

    -
    stylesheetDocument

    a character

    -
    type

    a PortalType - which is a character taking one of the following values: -

      -

    • CustomerSuccess

      • -

    • Partner

      • -

    • Network

      • -

    - -
    - -

    PostTemplate

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    default

    a character either 'true' or 'false'

    -
    description

    a character

    -
    fields

    a character

    -
    label

    a character

    - -
    - -

    PrimaryTabComponents

    -
    -
    containers

    a Container

    - -
    - -

    ProductSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enableCascadeActivateToRelatedPrices

    a character either 'true' or 'false'

    -
    enableQuantitySchedule

    a character either 'true' or 'false'

    -
    enableRevenueSchedule

    a character either 'true' or 'false'

    - -
    - -

    Profile

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    applicationVisibilities

    a ProfileApplicationVisibility

    -
    categoryGroupVisibilities

    a ProfileCategoryGroupVisibility

    -
    classAccesses

    a ProfileApexClassAccess

    -
    custom

    a character either 'true' or 'false'

    -
    customPermissions

    a ProfileCustomPermissions

    -
    description

    a character

    -
    externalDataSourceAccesses

    a ProfileExternalDataSourceAccess

    -
    fieldPermissions

    a ProfileFieldLevelSecurity

    -
    layoutAssignments

    a ProfileLayoutAssignment

    -
    loginHours

    a ProfileLoginHours

    -
    loginIpRanges

    a ProfileLoginIpRange

    -
    objectPermissions

    a ProfileObjectPermissions

    -
    pageAccesses

    a ProfileApexPageAccess

    -
    profileActionOverrides

    a ProfileActionOverride

    -
    recordTypeVisibilities

    a ProfileRecordTypeVisibility

    -
    tabVisibilities

    a ProfileTabVisibility

    -
    userLicense

    a character

    -
    userPermissions

    a ProfileUserPermission

    - -
    - -

    ProfileActionOverride

    -
    -
    actionName

    a character

    -
    content

    a character

    -
    formFactor

    a FormFactor - which is a character taking one of the following values: -

      -

    • Small

      • -

    • Medium

      • -

    • Large

      • -

    -
    pageOrSobjectType

    a character

    -
    recordType

    a character

    -
    type

    a ActionOverrideType - which is a character taking one of the following values: -

      -

    • Default

      • -

    • Standard

      • -

    • Scontrol

      • -

    • Visualforce

      • -

    • Flexipage

      • +

    QueueSobject

    +
    sobjectType
    +

    a character

    + + +

    QuickAction

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    canvas
    +

    a character

    + +
    description
    +

    a character

    + +
    fieldOverrides
    +

    a FieldOverride

    + +
    flowDefinition
    +

    a character

    + +
    height
    +

    an integer

    + +
    icon
    +

    a character

    + +
    isProtected
    +

    a character either 'true' or 'false'

    + +
    label
    +

    a character

    + +
    lightningComponent
    +

    a character

    + +
    optionsCreateFeedItem
    +

    a character either 'true' or 'false'

    + +
    page
    +

    a character

    + +
    quickActionLayout
    +

    a QuickActionLayout

    + +
    quickActionSendEmailOptions
    +

    a QuickActionSendEmailOptions

    + +
    standardLabel
    +

    a QuickActionLabel - which is a character taking one of the following values:

    • LogACall

      • +

    • LogANote

      • +

    • New

      • +

    • NewRecordType

      • +

    • Update

      • +

    • NewChild

      • +

    • NewChildRecordType

      • +

    • CreateNew

      • +

    • CreateNewRecordType

      • +

    • SendEmail

      • +

    • QuickRecordType

      • +

    • Quick

      • +

    • EditDescription

      • +

    • Defer

      • +

    • ChangeDueDate

      • +

    • ChangePriority

      • +

    • ChangeStatus

      • +

    • SocialPost

      • +

    • Escalate

      • +

    • EscalateToRecord

      • +

    • OfferFeedback

      • +

    • RequestFeedback

      • +

    • AddRecord

      • +

    • AddMember

      • +

    • Reply

      • +

    • ReplyAll

      • +

    • Forward

      • +
    + +
    successMessage
    +

    a character

    + +
    targetObject
    +

    a character

    + +
    targetParentField
    +

    a character

    + +
    targetRecordType
    +

    a character

    + +
    type
    +

    a QuickActionType - which is a character taking one of the following values:

    • Create

      • +

    • VisualforcePage

      • +

    • Post

      • +

    • SendEmail

      • +

    • LogACall

      • +

    • SocialPost

      • +

    • Canvas

      • +

    • Update

    • LightningComponent

      • -

    +

  • Flow

    • + + +
    width
    +

    an integer

    + + +

    QuickActionLayout

    +
    layoutSectionStyle
    +

    a LayoutSectionStyle - which is a character taking one of the following values:

    • TwoColumnsTopToBottom

      • +

    • TwoColumnsLeftToRight

      • +

    • OneColumn

      • +

    • CustomLinks

      • +
    + +
    quickActionLayoutColumns
    +

    a QuickActionLayoutColumn

    + + +

    QuickActionLayoutColumn

    +
    quickActionLayoutItems
    +

    a QuickActionLayoutItem

    + + +

    QuickActionLayoutItem

    +
    emptySpace
    +

    a character either 'true' or 'false'

    + +
    field
    +

    a character

    + +
    uiBehavior
    +

    a UiBehavior - which is a character taking one of the following values:

    • Edit

      • +

    • Required

      • +

    • Readonly

      • +
    + + +

    QuickActionList

    +
    quickActionListItems
    +

    a QuickActionListItem

    + + +

    QuickActionListItem

    +
    quickActionName
    +

    a character

    + + +

    QuickActionSendEmailOptions

    +
    defaultEmailTemplateName
    +

    a character

    + +
    ignoreDefaultEmailTemplateSubject
    +

    a character either 'true' or 'false'

    + + +

    QuickActionTranslation

    +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    QuotasSettings

    +
    showQuotas
    +

    a character either 'true' or 'false'

    + + +

    QuoteSettings

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    enableQuote
    +

    a character either 'true' or 'false'

    + + +

    RecommendationAudience

    +
    recommendationAudienceDetails
    +

    a RecommendationAudienceDetail

    + + +

    RecommendationAudienceDetail

    +
    audienceCriteriaType
    +

    a AudienceCriteriaType - which is a character taking one of the following values:

    • CustomList

      • +

    • MaxDaysInCommunity

      • +
    + +
    audienceCriteriaValue
    +

    a character

    + +
    setupName
    +

    a character

    + + +

    RecommendationDefinition

    +
    recommendationDefinitionDetails
    +

    a RecommendationDefinitionDetail

    + + +

    RecommendationDefinitionDetail

    +
    actionUrl
    +

    a character

    + +
    description
    +

    a character

    + +
    linkText
    +

    a character

    + +
    scheduledRecommendations
    +

    a ScheduledRecommendation

    + +
    setupName
    +

    a character

    + +
    title
    +

    a character

    + + +

    RecommendationStrategy

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    description
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    recommendationStrategyName
    +

    a character

    + +
    strategyNode
    +

    a StrategyNode

    + + +

    RecordType

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    active
    +

    a character either 'true' or 'false'

    + +
    businessProcess
    +

    a character

    + +
    compactLayoutAssignment
    +

    a character

    + +
    description
    +

    a character

    + +
    label
    +

    a character

    + +
    picklistValues
    +

    a RecordTypePicklistValue

    + + +

    RecordTypePicklistValue

    +
    picklist
    +

    a character

    + +
    values
    +

    a PicklistValue

    + -
    +

    RecordTypeTranslation

    +
    description
    +

    a character

    -

    ProfileApexClassAccess

    -
    -
    apexClass

    a character

    -
    enabled

    a character either 'true' or 'false'

    +
    label
    +

    a character

    -
    +
    name
    +

    a character

    -

    ProfileApexPageAccess

    -
    -
    apexPage

    a character

    -
    enabled

    a character either 'true' or 'false'

    -
    +

    RelatedContent

    +
    relatedContentItems
    +

    a RelatedContentItem

    -

    ProfileApplicationVisibility

    -
    -
    application

    a character

    -
    default

    a character either 'true' or 'false'

    -
    visible

    a character either 'true' or 'false'

    -
    +

    RelatedContentItem

    +
    layoutItem
    +

    a LayoutItem

    -

    ProfileCategoryGroupVisibility

    -
    -
    dataCategories

    a character

    -
    dataCategoryGroup

    a character

    -
    visibility

    a CategoryGroupVisibility - which is a character taking one of the following values: -

      -

    • ALL

      • -

    • NONE

      • -

    • CUSTOM

      • -

    - -
    - -

    ProfileCustomPermissions

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    name

    a character

    - -
    - -

    ProfileExternalDataSourceAccess

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    externalDataSource

    a character

    - -
    - -

    ProfileFieldLevelSecurity

    -
    -
    editable

    a character either 'true' or 'false'

    -
    field

    a character

    -
    readable

    a character either 'true' or 'false'

    - -
    - -

    ProfileLayoutAssignment

    -
    -
    layout

    a character

    -
    recordType

    a character

    - -
    - -

    ProfileLoginHours

    -
    -
    fridayEnd

    a character

    -
    fridayStart

    a character

    -
    mondayEnd

    a character

    -
    mondayStart

    a character

    -
    saturdayEnd

    a character

    -
    saturdayStart

    a character

    -
    sundayEnd

    a character

    -
    sundayStart

    a character

    -
    thursdayEnd

    a character

    -
    thursdayStart

    a character

    -
    tuesdayEnd

    a character

    -
    tuesdayStart

    a character

    -
    wednesdayEnd

    a character

    -
    wednesdayStart

    a character

    - -
    - -

    ProfileLoginIpRange

    -
    -
    description

    a character

    -
    endAddress

    a character

    -
    startAddress

    a character

    - -
    - -

    ProfileObjectPermissions

    -
    -
    allowCreate

    a character either 'true' or 'false'

    -
    allowDelete

    a character either 'true' or 'false'

    -
    allowEdit

    a character either 'true' or 'false'

    -
    allowRead

    a character either 'true' or 'false'

    -
    modifyAllRecords

    a character either 'true' or 'false'

    -
    object

    a character

    -
    viewAllRecords

    a character either 'true' or 'false'

    - -
    - -

    ProfilePasswordPolicy

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    lockoutInterval

    an integer

    -
    maxLoginAttempts

    an integer

    -
    minimumPasswordLength

    an integer

    -
    minimumPasswordLifetime

    a character either 'true' or 'false'

    -
    obscure

    a character either 'true' or 'false'

    -
    passwordComplexity

    an integer

    -
    passwordExpiration

    an integer

    -
    passwordHistory

    an integer

    -
    passwordQuestion

    an integer

    -
    profile

    a character

    - -
    - -

    ProfileRecordTypeVisibility

    -
    -
    default

    a character either 'true' or 'false'

    -
    personAccountDefault

    a character either 'true' or 'false'

    -
    recordType

    a character

    -
    visible

    a character either 'true' or 'false'

    - -
    - -

    ProfileSessionSetting

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    externalCommunityUserIdentityVerif

    a character either 'true' or 'false'

    -
    forceLogout

    a character either 'true' or 'false'

    -
    profile

    a character

    -
    requiredSessionLevel

    a SessionSecurityLevel - which is a character taking one of the following values: -

      -

    • LOW

      • -

    • STANDARD

      • -

    • HIGH_ASSURANCE

      • -

    -
    sessionPersistence

    a character either 'true' or 'false'

    -
    sessionTimeout

    an integer

    -
    sessionTimeoutWarning

    a character either 'true' or 'false'

    - -
    - -

    ProfileTabVisibility

    -
    -
    tab

    a character

    -
    visibility

    a TabVisibility - which is a character taking one of the following values: -

      -

    • Hidden

      • -

    • DefaultOff

      • -

    • DefaultOn

      • -

    - -
    - -

    ProfileUserPermission

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    name

    a character

    - -
    - -

    PublicGroups

    -
    -
    publicGroup

    a character

    - -
    - -

    PushNotification

    -
    -
    fieldNames

    a character

    -
    objectName

    a character

    - -
    - -

    Queue

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    doesSendEmailToMembers

    a character either 'true' or 'false'

    -
    email

    a character

    -
    name

    a character

    -
    queueMembers

    a QueueMembers

    -
    queueRoutingConfig

    a character

    -
    queueSobject

    a QueueSobject

    - -
    - -

    QueueMembers

    -
    -
    publicGroups

    a PublicGroups

    -
    roleAndSubordinates

    a RoleAndSubordinates

    -
    roleAndSubordinatesInternal

    a RoleAndSubordinatesInternal

    -
    roles

    a Roles

    -
    users

    a Users

    - -
    - -

    QueueSobject

    -
    -
    sobjectType

    a character

    - -
    - -

    QuickAction

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    canvas

    a character

    -
    description

    a character

    -
    fieldOverrides

    a FieldOverride

    -
    flowDefinition

    a character

    -
    height

    an integer

    -
    icon

    a character

    -
    isProtected

    a character either 'true' or 'false'

    -
    label

    a character

    -
    lightningComponent

    a character

    -
    optionsCreateFeedItem

    a character either 'true' or 'false'

    -
    page

    a character

    -
    quickActionLayout

    a QuickActionLayout

    -
    quickActionSendEmailOptions

    a QuickActionSendEmailOptions

    -
    standardLabel

    a QuickActionLabel - which is a character taking one of the following values: -

      -

    • LogACall

      • -

    • LogANote

      • -

    • New

      • -

    • NewRecordType

      • -

    • Update

      • -

    • NewChild

      • -

    • NewChildRecordType

      • -

    • CreateNew

      • -

    • CreateNewRecordType

      • -

    • SendEmail

      • -

    • QuickRecordType

      • -

    • Quick

      • -

    • EditDescription

      • -

    • Defer

      • -

    • ChangeDueDate

      • -

    • ChangePriority

      • -

    • ChangeStatus

      • -

    • SocialPost

      • -

    • Escalate

      • -

    • EscalateToRecord

      • -

    • OfferFeedback

      • -

    • RequestFeedback

      • -

    • AddRecord

      • -

    • AddMember

      • -

    • Reply

      • -

    • ReplyAll

      • -

    • Forward

      • -

    -
    successMessage

    a character

    -
    targetObject

    a character

    -
    targetParentField

    a character

    -
    targetRecordType

    a character

    -
    type

    a QuickActionType - which is a character taking one of the following values: -

      -

    • Create

      • -

    • VisualforcePage

      • -

    • Post

      • -

    • SendEmail

      • -

    • LogACall

      • -

    • SocialPost

      • -

    • Canvas

      • -

    • Update

      • -

    • LightningComponent

      • -

    • Flow

      • -

    -
    width

    an integer

    -
    +

    RelatedList

    +
    hideOnDetail
    +

    a character either 'true' or 'false'

    -

    QuickActionLayout

    -
    -
    layoutSectionStyle

    a LayoutSectionStyle - which is a character taking one of the following values: -

      -

    • TwoColumnsTopToBottom

      • -

    • TwoColumnsLeftToRight

      • -

    • OneColumn

      • -

    • CustomLinks

      • -

    -
    quickActionLayoutColumns

    a QuickActionLayoutColumn

    +
    name
    +

    a character

    -
    -

    QuickActionLayoutColumn

    -
    -
    quickActionLayoutItems

    a QuickActionLayoutItem

    +

    RelatedListItem

    +
    customButtons
    +

    a character

    -
    +
    excludeButtons
    +

    a character

    -

    QuickActionLayoutItem

    -
    -
    emptySpace

    a character either 'true' or 'false'

    -
    field

    a character

    -
    uiBehavior

    a UiBehavior - which is a character taking one of the following values: -

      -

    • Edit

      • -

    • Required

      • -

    • Readonly

      • -

    +
    fields
    +

    a character

    -
    +
    relatedList
    +

    a character

    -

    QuickActionList

    -
    -
    quickActionListItems

    a QuickActionListItem

    +
    sortField
    +

    a character

    -
    +
    sortOrder
    +

    a SortOrder - which is a character taking one of the following values:

    • Asc

      • +

    • Desc

      • +
    -

    QuickActionListItem

    -
    -
    quickActionName

    a character

    -
    +

    RemoteSiteSetting

    +
    fullName
    +

    a character (inherited from Metadata)

    -

    QuickActionSendEmailOptions

    -
    -
    defaultEmailTemplateName

    a character

    -
    ignoreDefaultEmailTemplateSubject

    a character either 'true' or 'false'

    +
    description
    +

    a character

    -
    +
    disableProtocolSecurity
    +

    a character either 'true' or 'false'

    -

    QuickActionTranslation

    -
    -
    label

    a character

    -
    name

    a character

    +
    isActive
    +

    a character either 'true' or 'false'

    -
    +
    url
    +

    a character

    -

    QuotasSettings

    -
    -
    showQuotas

    a character either 'true' or 'false'

    -
    +

    Report

    +
    fullName
    +

    a character (inherited from Metadata)

    -

    QuoteSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enableQuote

    a character either 'true' or 'false'

    +
    aggregates
    +

    a ReportAggregate

    -
    +
    block
    +

    a Report

    -

    RecommendationAudience

    -
    -
    recommendationAudienceDetails

    a RecommendationAudienceDetail

    +
    blockInfo
    +

    a ReportBlockInfo

    -
    +
    buckets
    +

    a ReportBucketField

    -

    RecommendationAudienceDetail

    -
    -
    audienceCriteriaType

    a AudienceCriteriaType - which is a character taking one of the following values: -

      -

    • CustomList

      • -

    • MaxDaysInCommunity

      • -

    -
    audienceCriteriaValue

    a character

    -
    setupName

    a character

    - -
    - -

    RecommendationDefinition

    -
    -
    recommendationDefinitionDetails

    a RecommendationDefinitionDetail

    - -
    - -

    RecommendationDefinitionDetail

    -
    -
    actionUrl

    a character

    -
    description

    a character

    -
    linkText

    a character

    -
    scheduledRecommendations

    a ScheduledRecommendation

    -
    setupName

    a character

    -
    title

    a character

    - -
    - -

    RecommendationStrategy

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    masterLabel

    a character

    -
    recommendationStrategyName

    a character

    -
    strategyNode

    a StrategyNode

    - -
    - -

    RecordType

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    active

    a character either 'true' or 'false'

    -
    businessProcess

    a character

    -
    compactLayoutAssignment

    a character

    -
    description

    a character

    -
    label

    a character

    -
    picklistValues

    a RecordTypePicklistValue

    - -
    - -

    RecordTypePicklistValue

    -
    -
    picklist

    a character

    -
    values

    a PicklistValue

    - -
    - -

    RecordTypeTranslation

    -
    -
    description

    a character

    -
    label

    a character

    -
    name

    a character

    - -
    - -

    RelatedContent

    -
    -
    relatedContentItems

    a RelatedContentItem

    - -
    - -

    RelatedContentItem

    -
    -
    layoutItem

    a LayoutItem

    - -
    - -

    RelatedList

    -
    -
    hideOnDetail

    a character either 'true' or 'false'

    -
    name

    a character

    - -
    - -

    RelatedListItem

    -
    -
    customButtons

    a character

    -
    excludeButtons

    a character

    -
    fields

    a character

    -
    relatedList

    a character

    -
    sortField

    a character

    -
    sortOrder

    a SortOrder - which is a character taking one of the following values: -

      -

    • Asc

      • -

    • Desc

      • -

    - -
    - -

    RemoteSiteSetting

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    disableProtocolSecurity

    a character either 'true' or 'false'

    -
    isActive

    a character either 'true' or 'false'

    -
    url

    a character

    - -
    - -

    Report

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    aggregates

    a ReportAggregate

    -
    block

    a Report

    -
    blockInfo

    a ReportBlockInfo

    -
    buckets

    a ReportBucketField

    -
    chart

    a ReportChart

    -
    colorRanges

    a ReportColorRange

    -
    columns

    a ReportColumn

    -
    crossFilters

    a ReportCrossFilter

    -
    currency

    a CurrencyIsoCode - which is a character taking one of the following values: -

      -

    • ADP

      • +
      chart
      +

      a ReportChart

      + +
      colorRanges
      +

      a ReportColorRange

      + +
      columns
      +

      a ReportColumn

      + +
      crossFilters
      +

      a ReportCrossFilter

      + +
      currency
      +

      a CurrencyIsoCode - which is a character taking one of the following values:

      • ADP

      • AED

      • AFA

      • AFN

        • @@ -8094,129 +11697,206 @@

        Details

      • ZMW

      • ZWD

      • ZWL

        • -

      -
      dataCategoryFilters

      a ReportDataCategoryFilter

      -
      description

      a character

      -
      division

      a character

      -
      filter

      a ReportFilter

      -
      folderName

      a character

      -
      format

      a ReportFormat - which is a character taking one of the following values: -

        -

      • MultiBlock

        • +
      + +
      dataCategoryFilters
      +

      a ReportDataCategoryFilter

      + +
      description
      +

      a character

      + +
      division
      +

      a character

      + +
      filter
      +

      a ReportFilter

      + +
      folderName
      +

      a character

      + +
      format
      +

      a ReportFormat - which is a character taking one of the following values:

      • MultiBlock

      • Matrix

      • Summary

      • Tabular

        • -

      -
      groupingsAcross

      a ReportGrouping

      -
      groupingsDown

      a ReportGrouping

      -
      historicalSelector

      a ReportHistoricalSelector

      -
      name

      a character

      -
      numSubscriptions

      an integer

      -
      params

      a ReportParam

      -
      reportType

      a character

      -
      roleHierarchyFilter

      a character

      -
      rowLimit

      an integer

      -
      scope

      a character

      -
      showCurrentDate

      a character either 'true' or 'false'

      -
      showDetails

      a character either 'true' or 'false'

      -
      sortColumn

      a character

      -
      sortOrder

      a SortOrder - which is a character taking one of the following values: -

        -

      • Asc

        • +
      + +
      groupingsAcross
      +

      a ReportGrouping

      + +
      groupingsDown
      +

      a ReportGrouping

      + +
      historicalSelector
      +

      a ReportHistoricalSelector

      + +
      name
      +

      a character

      + +
      numSubscriptions
      +

      an integer

      + +
      params
      +

      a ReportParam

      + +
      reportType
      +

      a character

      + +
      roleHierarchyFilter
      +

      a character

      + +
      rowLimit
      +

      an integer

      + +
      scope
      +

      a character

      + +
      showCurrentDate
      +

      a character either 'true' or 'false'

      + +
      showDetails
      +

      a character either 'true' or 'false'

      + +
      sortColumn
      +

      a character

      + +
      sortOrder
      +

      a SortOrder - which is a character taking one of the following values:

      • Asc

      • Desc

        • -

      -
      territoryHierarchyFilter

      a character

      -
      timeFrameFilter

      a ReportTimeFrameFilter

      -
      userFilter

      a character

      - -
    - -

    ReportAggregate

    -
    -
    acrossGroupingContext

    a character

    -
    calculatedFormula

    a character

    -
    datatype

    a ReportAggregateDatatype - which is a character taking one of the following values: -

      -

    • currency

      • +
    + +
    territoryHierarchyFilter
    +

    a character

    + +
    timeFrameFilter
    +

    a ReportTimeFrameFilter

    + +
    userFilter
    +

    a character

    + + +

    ReportAggregate

    +
    acrossGroupingContext
    +

    a character

    + +
    calculatedFormula
    +

    a character

    + +
    datatype
    +

    a ReportAggregateDatatype - which is a character taking one of the following values:

    • currency

    • percent

    • number

      • -

    -
    description

    a character

    -
    developerName

    a character

    -
    downGroupingContext

    a character

    -
    isActive

    a character either 'true' or 'false'

    -
    isCrossBlock

    a character either 'true' or 'false'

    -
    masterLabel

    a character

    -
    reportType

    a character

    -
    scale

    an integer

    - -
    - -

    ReportAggregateReference

    -
    -
    aggregate

    a character

    - -
    - -

    ReportBlockInfo

    -
    -
    aggregateReferences

    a ReportAggregateReference

    -
    blockId

    a character

    -
    joinTable

    a character

    - -
    - -

    ReportBucketField

    -
    -
    bucketType

    a ReportBucketFieldType - which is a character taking one of the following values: -

      -

    • text

      • +
    + +
    description
    +

    a character

    + +
    developerName
    +

    a character

    + +
    downGroupingContext
    +

    a character

    + +
    isActive
    +

    a character either 'true' or 'false'

    + +
    isCrossBlock
    +

    a character either 'true' or 'false'

    + +
    masterLabel
    +

    a character

    + +
    reportType
    +

    a character

    + +
    scale
    +

    an integer

    + + +

    ReportAggregateReference

    +
    aggregate
    +

    a character

    + + +

    ReportBlockInfo

    +
    aggregateReferences
    +

    a ReportAggregateReference

    + +
    blockId
    +

    a character

    + +
    joinTable
    +

    a character

    + + +

    ReportBucketField

    +
    bucketType
    +

    a ReportBucketFieldType - which is a character taking one of the following values:

    • text

    • number

    • picklist

      • -

    -
    developerName

    a character

    -
    masterLabel

    a character

    -
    nullTreatment

    a ReportFormulaNullTreatment - which is a character taking one of the following values: -

      -

    • n

      • +
    + +
    developerName
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    nullTreatment
    +

    a ReportFormulaNullTreatment - which is a character taking one of the following values:

    • n

    • z

      • -

    -
    otherBucketLabel

    a character

    -
    sourceColumnName

    a character

    -
    useOther

    a character either 'true' or 'false'

    -
    values

    a ReportBucketFieldValue

    - -
    - -

    ReportBucketFieldSourceValue

    -
    -
    from

    a character

    -
    sourceValue

    a character

    -
    to

    a character

    - -
    - -

    ReportBucketFieldValue

    -
    -
    sourceValues

    a ReportBucketFieldSourceValue

    -
    value

    a character

    - -
    - -

    ReportChart

    -
    -
    backgroundColor1

    a character

    -
    backgroundColor2

    a character

    -
    backgroundFadeDir

    a ChartBackgroundDirection - which is a character taking one of the following values: -

      -

    • TopToBottom

      • +
    + +
    otherBucketLabel
    +

    a character

    + +
    sourceColumnName
    +

    a character

    + +
    useOther
    +

    a character either 'true' or 'false'

    + +
    values
    +

    a ReportBucketFieldValue

    + + +

    ReportBucketFieldSourceValue

    +
    from
    +

    a character

    + +
    sourceValue
    +

    a character

    + +
    to
    +

    a character

    + + +

    ReportBucketFieldValue

    +
    sourceValues
    +

    a ReportBucketFieldSourceValue

    + +
    value
    +

    a character

    + + +

    ReportChart

    +
    backgroundColor1
    +

    a character

    + +
    backgroundColor2
    +

    a character

    + +
    backgroundFadeDir
    +

    a ChartBackgroundDirection - which is a character taking one of the following values:

    • TopToBottom

    • LeftToRight

    • Diagonal

      • -

    -
    chartSummaries

    a ChartSummary

    -
    chartType

    a ChartType - which is a character taking one of the following values: -

      -

    • None

      • +
    + +
    chartSummaries
    +

    a ChartSummary

    + +
    chartType
    +

    a ChartType - which is a character taking one of the following values:

    • None

    • Scatter

    • ScatterGrouped

    • Bubble

      • @@ -8240,137 +11920,197 @@

      Details

    • VerticalColumnGroupedLine

    • VerticalColumnStackedLine

    • Plugin

      • -

    -
    enableHoverLabels

    a character either 'true' or 'false'

    -
    expandOthers

    a character either 'true' or 'false'

    -
    groupingColumn

    a character

    -
    legendPosition

    a ChartLegendPosition - which is a character taking one of the following values: -

      -

    • Right

      • +
    + +
    enableHoverLabels
    +

    a character either 'true' or 'false'

    + +
    expandOthers
    +

    a character either 'true' or 'false'

    + +
    groupingColumn
    +

    a character

    + +
    legendPosition
    +

    a ChartLegendPosition - which is a character taking one of the following values:

    • Right

    • Bottom

    • OnChart

      • -

    -
    location

    a ChartPosition - which is a character taking one of the following values: -

      -

    • CHART_TOP

      • +
    + +
    location
    +

    a ChartPosition - which is a character taking one of the following values:

    • CHART_TOP

    • CHART_BOTTOM

      • -

    -
    secondaryGroupingColumn

    a character

    -
    showAxisLabels

    a character either 'true' or 'false'

    -
    showPercentage

    a character either 'true' or 'false'

    -
    showTotal

    a character either 'true' or 'false'

    -
    showValues

    a character either 'true' or 'false'

    -
    size

    a ReportChartSize - which is a character taking one of the following values: -

      -

    • Tiny

      • +
    + +
    secondaryGroupingColumn
    +

    a character

    + +
    showAxisLabels
    +

    a character either 'true' or 'false'

    + +
    showPercentage
    +

    a character either 'true' or 'false'

    + +
    showTotal
    +

    a character either 'true' or 'false'

    + +
    showValues
    +

    a character either 'true' or 'false'

    + +
    size
    +

    a ReportChartSize - which is a character taking one of the following values:

    • Tiny

    • Small

    • Medium

    • Large

    • Huge

      • -

    -
    summaryAxisManualRangeEnd

    a numeric

    -
    summaryAxisManualRangeStart

    a numeric

    -
    summaryAxisRange

    a ChartRangeType - which is a character taking one of the following values: -

      -

    • Auto

      • +
    + +
    summaryAxisManualRangeEnd
    +

    a numeric

    + +
    summaryAxisManualRangeStart
    +

    a numeric

    + +
    summaryAxisRange
    +

    a ChartRangeType - which is a character taking one of the following values:

    • Auto

    • Manual

      • -

    -
    textColor

    a character

    -
    textSize

    an integer

    -
    title

    a character

    -
    titleColor

    a character

    -
    titleSize

    an integer

    - -
    - -

    ReportChartComponentLayoutItem

    -
    -
    cacheData

    a character either 'true' or 'false'

    -
    contextFilterableField

    a character

    -
    error

    a character

    -
    hideOnError

    a character either 'true' or 'false'

    -
    includeContext

    a character either 'true' or 'false'

    -
    reportName

    a character

    -
    showTitle

    a character either 'true' or 'false'

    -
    size

    a ReportChartComponentSize - which is a character taking one of the following values: -

      -

    • SMALL

      • +
    + +
    textColor
    +

    a character

    + +
    textSize
    +

    an integer

    + +
    title
    +

    a character

    + +
    titleColor
    +

    a character

    + +
    titleSize
    +

    an integer

    + + +

    ReportChartComponentLayoutItem

    +
    cacheData
    +

    a character either 'true' or 'false'

    + +
    contextFilterableField
    +

    a character

    + +
    error
    +

    a character

    + +
    hideOnError
    +

    a character either 'true' or 'false'

    + +
    includeContext
    +

    a character either 'true' or 'false'

    + +
    reportName
    +

    a character

    + +
    showTitle
    +

    a character either 'true' or 'false'

    + +
    size
    +

    a ReportChartComponentSize - which is a character taking one of the following values:

    • SMALL

    • MEDIUM

    • LARGE

      • -

    + -
    -

    ReportColorRange

    -
    -
    aggregate

    a ReportSummaryType - which is a character taking one of the following values: -

      -

    • Sum

      • +

    ReportColorRange

    +
    aggregate
    +

    a ReportSummaryType - which is a character taking one of the following values:

    • Sum

    • Average

    • Maximum

    • Minimum

    • None

      • -

    -
    columnName

    a character

    -
    highBreakpoint

    a numeric

    -
    highColor

    a character

    -
    lowBreakpoint

    a numeric

    -
    lowColor

    a character

    -
    midColor

    a character

    - -
    - -

    ReportColumn

    -
    -
    aggregateTypes

    a ReportSummaryType - which is a character taking one of the following values: -

      -

    • Sum

      • +
    + +
    columnName
    +

    a character

    + +
    highBreakpoint
    +

    a numeric

    + +
    highColor
    +

    a character

    + +
    lowBreakpoint
    +

    a numeric

    + +
    lowColor
    +

    a character

    + +
    midColor
    +

    a character

    + + +

    ReportColumn

    +
    aggregateTypes
    +

    a ReportSummaryType - which is a character taking one of the following values:

    • Sum

    • Average

    • Maximum

    • Minimum

    • None

      • -

    -
    field

    a character

    -
    reverseColors

    a character either 'true' or 'false'

    -
    showChanges

    a character either 'true' or 'false'

    - -
    - -

    ReportCrossFilter

    -
    -
    criteriaItems

    a ReportFilterItem

    -
    operation

    a ObjectFilterOperator - which is a character taking one of the following values: -

      -

    • with

      • +
    + +
    field
    +

    a character

    + +
    reverseColors
    +

    a character either 'true' or 'false'

    + +
    showChanges
    +

    a character either 'true' or 'false'

    + + +

    ReportCrossFilter

    +
    criteriaItems
    +

    a ReportFilterItem

    + +
    operation
    +

    a ObjectFilterOperator - which is a character taking one of the following values:

    • with

    • without

      • -

    -
    primaryTableColumn

    a character

    -
    relatedTable

    a character

    -
    relatedTableJoinColumn

    a character

    - -
    - -

    ReportDataCategoryFilter

    -
    -
    dataCategory

    a character

    -
    dataCategoryGroup

    a character

    -
    operator

    a DataCategoryFilterOperation - which is a character taking one of the following values: -

      -

    • above

      • +
    + +
    primaryTableColumn
    +

    a character

    + +
    relatedTable
    +

    a character

    + +
    relatedTableJoinColumn
    +

    a character

    + + +

    ReportDataCategoryFilter

    +
    dataCategory
    +

    a character

    + +
    dataCategoryGroup
    +

    a character

    + +
    operator
    +

    a DataCategoryFilterOperation - which is a character taking one of the following values:

    • above

    • below

    • at

    • aboveOrBelow

      • -

    + + + +

    ReportFilter

    +
    booleanFilter
    +

    a character

    -
    +
    criteriaItems
    +

    a ReportFilterItem

    -

    ReportFilter

    -
    -
    booleanFilter

    a character

    -
    criteriaItems

    a ReportFilterItem

    -
    language

    a Language - which is a character taking one of the following values: -

      -

    • en_US

      • +
      language
      +

      a Language - which is a character taking one of the following values:

      • en_US

      • de

      • es

      • fr

        • @@ -8489,18 +12229,21 @@

        Details

      • ca

      • eo

      • iw_EO

        • -

      - -
    - -

    ReportFilterItem

    -
    -
    column

    a character

    -
    columnToColumn

    a character either 'true' or 'false'

    -
    isUnlocked

    a character either 'true' or 'false'

    -
    operator

    a FilterOperation - which is a character taking one of the following values: -

      -

    • equals

      • +
    + + +

    ReportFilterItem

    +
    column
    +

    a character

    + +
    columnToColumn
    +

    a character either 'true' or 'false'

    + +
    isUnlocked
    +

    a character either 'true' or 'false'

    + +
    operator
    +

    a FilterOperation - which is a character taking one of the following values:

    • equals

    • notEqual

    • lessThan

    • greaterThan

      • @@ -8512,35 +12255,43 @@

      Details

    • includes

    • excludes

    • within

      • -

    -
    snapshot

    a character

    -
    value

    a character

    - -
    - -

    ReportFolder

    -
    -
    accessType

    a FolderAccessTypes (inherited from Folder)

    -
    folderShares

    a FolderShare (inherited from Folder)

    -
    name

    a character (inherited from Folder)

    -
    publicFolderAccess

    a PublicFolderAccess (inherited from Folder)

    -
    sharedTo

    a SharedTo (inherited from Folder)

    - -
    - -

    ReportGrouping

    -
    -
    aggregateType

    a ReportAggrType - which is a character taking one of the following values: -

      -

    • Sum

      • +
    + +
    snapshot
    +

    a character

    + +
    value
    +

    a character

    + + +

    ReportFolder

    +
    accessType
    +

    a FolderAccessTypes (inherited from Folder)

    + +
    folderShares
    +

    a FolderShare (inherited from Folder)

    + +
    name
    +

    a character (inherited from Folder)

    + +
    publicFolderAccess
    +

    a PublicFolderAccess (inherited from Folder)

    + +
    sharedTo
    +

    a SharedTo (inherited from Folder)

    + + +

    ReportGrouping

    +
    aggregateType
    +

    a ReportAggrType - which is a character taking one of the following values:

    • Sum

    • Average

    • Maximum

    • Minimum

    • RowCount

      • -

    -
    dateGranularity

    a UserDateGranularity - which is a character taking one of the following values: -

      -

    • None

      • +
    + +
    dateGranularity
    +

    a UserDateGranularity - which is a character taking one of the following values:

    • None

    • Day

    • Week

    • Month

      • @@ -8552,50 +12303,56 @@

      Details

    • DayInMonth

    • FiscalPeriod

    • FiscalWeek

      • -

    -
    field

    a character

    -
    sortByName

    a character

    -
    sortOrder

    a SortOrder - which is a character taking one of the following values: -

      -

    • Asc

      • +
    + +
    field
    +

    a character

    + +
    sortByName
    +

    a character

    + +
    sortOrder
    +

    a SortOrder - which is a character taking one of the following values:

    • Asc

    • Desc

      • -

    -
    sortType

    a ReportSortType - which is a character taking one of the following values: -

      -

    • Column

      • +
    + +
    sortType
    +

    a ReportSortType - which is a character taking one of the following values:

    • Column

    • Aggregate

    • CustomSummaryFormula

      • -

    + + + +

    ReportHistoricalSelector

    +
    snapshot
    +

    a character

    -
    -

    ReportHistoricalSelector

    -
    -
    snapshot

    a character

    +

    ReportLayoutSection

    +
    columns
    +

    a ReportTypeColumn

    -
    +
    masterLabel
    +

    a character

    -

    ReportLayoutSection

    -
    -
    columns

    a ReportTypeColumn

    -
    masterLabel

    a character

    -
    +

    ReportParam

    +
    name
    +

    a character

    -

    ReportParam

    -
    -
    name

    a character

    -
    value

    a character

    +
    value
    +

    a character

    -
    -

    ReportTimeFrameFilter

    -
    -
    dateColumn

    a character

    -
    endDate

    a character formatted as 'yyyy-mm-dd'

    -
    interval

    a UserDateInterval - which is a character taking one of the following values: -

      -

    • INTERVAL_CURRENT

      • +

    ReportTimeFrameFilter

    +
    dateColumn
    +

    a character

    + +
    endDate
    +

    a character formatted as 'yyyy-mm-dd'

    + +
    interval
    +

    a UserDateInterval - which is a character taking one of the following values:

    • INTERVAL_CURRENT

    • INTERVAL_CURNEXT1

    • INTERVAL_CURPREV1

    • INTERVAL_NEXT1

      • @@ -8659,19 +12416,24 @@

      Details

    • TWO_ENTITLEMENT_PERIODS_AGO

    • CURRENT_AND_PREVIOUS_ENTITLEMENT_PERIOD

    • CURRENT_AND_PREVIOUS_TWO_ENTITLEMENT_PERIODS

      • -

    -
    startDate

    a character formatted as 'yyyy-mm-dd'

    - -
    - -

    ReportType

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    autogenerated

    a character either 'true' or 'false'

    -
    baseObject

    a character

    -
    category

    a ReportTypeCategory - which is a character taking one of the following values: -

      -

    • accounts

      • +
    + +
    startDate
    +

    a character formatted as 'yyyy-mm-dd'

    + + +

    ReportType

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    autogenerated
    +

    a character either 'true' or 'false'

    + +
    baseObject
    +

    a character

    + +
    category
    +

    a ReportTypeCategory - which is a character taking one of the following values:

    • accounts

    • opportunities

    • forecasts

    • cases

      • @@ -8688,257 +12450,374 @@

      Details

    • wdc

    • calibration

    • territory2

      • -

    -
    deployed

    a character either 'true' or 'false'

    -
    description

    a character

    -
    join

    a ObjectRelationship

    -
    label

    a character

    -
    sections

    a ReportLayoutSection

    + + +
    deployed
    +

    a character either 'true' or 'false'

    + +
    description
    +

    a character

    + +
    join
    +

    a ObjectRelationship

    + +
    label
    +

    a character

    + +
    sections
    +

    a ReportLayoutSection

    + + +

    ReportTypeColumn

    +
    checkedByDefault
    +

    a character either 'true' or 'false'

    + +
    displayNameOverride
    +

    a character

    + +
    field
    +

    a character

    + +
    table
    +

    a character

    + + +

    ReportTypeColumnTranslation

    +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    ReportTypeSectionTranslation

    +
    columns
    +

    a ReportTypeColumnTranslation

    + +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    ReportTypeTranslation

    +
    description
    +

    a character

    + +
    label
    +

    a character

    + +
    name
    +

    a character

    + +
    sections
    +

    a ReportTypeSectionTranslation

    + + +

    ReputationBranding

    +
    smallImage
    +

    a character

    + + +

    ReputationLevel

    +
    branding
    +

    a ReputationBranding

    + +
    label
    +

    a character

    + +
    lowerThreshold
    +

    a numeric

    + + +

    ReputationLevelDefinitions

    +
    level
    +

    a ReputationLevel

    + + +

    ReputationLevels

    +
    chatterAnswersReputationLevels
    +

    a ChatterAnswersReputationLevel

    + +
    ideaReputationLevels
    +

    a IdeaReputationLevel

    + + +

    ReputationPointsRule

    +
    eventType
    +

    a character

    + +
    points
    +

    an integer

    + + +

    ReputationPointsRules

    +
    pointsRule
    +

    a ReputationPointsRule

    + + +

    RetrieveRequest

    +
    apiVersion
    +

    a numeric

    + +
    packageNames
    +

    a character

    + +
    singlePackage
    +

    a character either 'true' or 'false'

    + +
    specificFiles
    +

    a character

    + +
    unpackaged
    +

    a Package

    + + +

    Role

    +
    caseAccessLevel
    +

    a character (inherited from RoleOrTerritory)

    + +
    contactAccessLevel
    +

    a character (inherited from RoleOrTerritory)

    + +
    description
    +

    a character (inherited from RoleOrTerritory)

    + +
    mayForecastManagerShare
    +

    a character either 'true' or 'false' (inherited from RoleOrTerritory)

    + +
    name
    +

    a character (inherited from RoleOrTerritory)

    + +
    opportunityAccessLevel
    +

    a character (inherited from RoleOrTerritory)

    + +
    parentRole
    +

    a character

    -
    -

    ReportTypeColumn

    -
    -
    checkedByDefault

    a character either 'true' or 'false'

    -
    displayNameOverride

    a character

    -
    field

    a character

    -
    table

    a character

    +

    RoleAndSubordinates

    +
    roleAndSubordinate
    +

    a character

    -
    -

    ReportTypeColumnTranslation

    -
    -
    label

    a character

    -
    name

    a character

    +

    RoleAndSubordinatesInternal

    +
    roleAndSubordinateInternal
    +

    a character

    -
    - -

    ReportTypeSectionTranslation

    -
    -
    columns

    a ReportTypeColumnTranslation

    -
    label

    a character

    -
    name

    a character

    -
    +

    RoleOrTerritory

    +
    fullName
    +

    a character (inherited from Metadata)

    -

    ReportTypeTranslation

    -
    -
    description

    a character

    -
    label

    a character

    -
    name

    a character

    -
    sections

    a ReportTypeSectionTranslation

    +
    caseAccessLevel
    +

    a character

    -
    +
    contactAccessLevel
    +

    a character

    -

    ReputationBranding

    -
    -
    smallImage

    a character

    +
    description
    +

    a character

    -
    +
    mayForecastManagerShare
    +

    a character either 'true' or 'false'

    -

    ReputationLevel

    -
    -
    branding

    a ReputationBranding

    -
    label

    a character

    -
    lowerThreshold

    a numeric

    +
    name
    +

    a character

    -
    +
    opportunityAccessLevel
    +

    a character

    -

    ReputationLevelDefinitions

    -
    -
    level

    a ReputationLevel

    -
    +

    Roles

    +
    role
    +

    a character

    -

    ReputationLevels

    -
    -
    chatterAnswersReputationLevels

    a ChatterAnswersReputationLevel

    -
    ideaReputationLevels

    a IdeaReputationLevel

    -
    +

    RuleEntry

    +
    assignedTo
    +

    a character

    -

    ReputationPointsRule

    -
    -
    eventType

    a character

    -
    points

    an integer

    +
    assignedToType
    +

    a AssignToLookupValueType - which is a character taking one of the following values:

    • User

      • +

    • Queue

      • +
    -
    +
    booleanFilter
    +

    a character

    -

    ReputationPointsRules

    -
    -
    pointsRule

    a ReputationPointsRule

    +
    businessHours
    +

    a character

    -
    +
    businessHoursSource
    +

    a BusinessHoursSourceType - which is a character taking one of the following values:

    • None

      • +

    • Case

      • +

    • Static

      • +
    -

    RetrieveRequest

    -
    -
    apiVersion

    a numeric

    -
    packageNames

    a character

    -
    singlePackage

    a character either 'true' or 'false'

    -
    specificFiles

    a character

    -
    unpackaged

    a Package

    +
    criteriaItems
    +

    a FilterItem

    -
    +
    disableEscalationWhenModified
    +

    a character either 'true' or 'false'

    -

    Role

    -
    -
    caseAccessLevel

    a character (inherited from RoleOrTerritory)

    -
    contactAccessLevel

    a character (inherited from RoleOrTerritory)

    -
    description

    a character (inherited from RoleOrTerritory)

    -
    mayForecastManagerShare

    a character either 'true' or 'false' (inherited from RoleOrTerritory)

    -
    name

    a character (inherited from RoleOrTerritory)

    -
    opportunityAccessLevel

    a character (inherited from RoleOrTerritory)

    -
    parentRole

    a character

    +
    escalationAction
    +

    a EscalationAction

    -
    +
    escalationStartTime
    +

    a EscalationStartTimeType - which is a character taking one of the following values:

    • CaseCreation

      • +

    • CaseLastModified

      • +
    -

    RoleAndSubordinates

    -
    -
    roleAndSubordinate

    a character

    +
    formula
    +

    a character

    -
    +
    notifyCcRecipients
    +

    a character either 'true' or 'false'

    -

    RoleAndSubordinatesInternal

    -
    -
    roleAndSubordinateInternal

    a character

    +
    overrideExistingTeams
    +

    a character either 'true' or 'false'

    -
    +
    replyToEmail
    +

    a character

    -

    RoleOrTerritory

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    caseAccessLevel

    a character

    -
    contactAccessLevel

    a character

    -
    description

    a character

    -
    mayForecastManagerShare

    a character either 'true' or 'false'

    -
    name

    a character

    -
    opportunityAccessLevel

    a character

    +
    senderEmail
    +

    a character

    -
    +
    senderName
    +

    a character

    -

    Roles

    -
    -
    role

    a character

    +
    team
    +

    a character

    -
    +
    template
    +

    a character

    -

    RuleEntry

    -
    -
    assignedTo

    a character

    -
    assignedToType

    a AssignToLookupValueType - which is a character taking one of the following values: -

      -

    • User

      • -

    • Queue

      • -

    -
    booleanFilter

    a character

    -
    businessHours

    a character

    -
    businessHoursSource

    a BusinessHoursSourceType - which is a character taking one of the following values: -

      -

    • None

      • -

    • Case

      • -

    • Static

      • -

    -
    criteriaItems

    a FilterItem

    -
    disableEscalationWhenModified

    a character either 'true' or 'false'

    -
    escalationAction

    a EscalationAction

    -
    escalationStartTime

    a EscalationStartTimeType - which is a character taking one of the following values: -

      -

    • CaseCreation

      • -

    • CaseLastModified

      • -

    -
    formula

    a character

    -
    notifyCcRecipients

    a character either 'true' or 'false'

    -
    overrideExistingTeams

    a character either 'true' or 'false'

    -
    replyToEmail

    a character

    -
    senderEmail

    a character

    -
    senderName

    a character

    -
    team

    a character

    -
    template

    a character

    - -
    - -

    SamlSsoConfig

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    attributeName

    a character

    -
    attributeNameIdFormat

    a character

    -
    decryptionCertificate

    a character

    -
    errorUrl

    a character

    -
    executionUserId

    a character

    -
    identityLocation

    a SamlIdentityLocationType - which is a character taking one of the following values: -

      -

    • SubjectNameId

      • + +

    SamlSsoConfig

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    attributeName
    +

    a character

    + +
    attributeNameIdFormat
    +

    a character

    + +
    decryptionCertificate
    +

    a character

    + +
    errorUrl
    +

    a character

    + +
    executionUserId
    +

    a character

    + +
    identityLocation
    +

    a SamlIdentityLocationType - which is a character taking one of the following values:

    • SubjectNameId

    • Attribute

      • -

    -
    identityMapping

    a SamlIdentityType - which is a character taking one of the following values: -

      -

    • Username

      • +
    + +
    identityMapping
    +

    a SamlIdentityType - which is a character taking one of the following values:

    • Username

    • FederationId

    • UserId

      • -

    -
    issuer

    a character

    -
    loginUrl

    a character

    -
    logoutUrl

    a character

    -
    name

    a character

    -
    oauthTokenEndpoint

    a character

    -
    redirectBinding

    a character either 'true' or 'false'

    -
    requestSignatureMethod

    a character

    -
    requestSigningCertId

    a character

    -
    salesforceLoginUrl

    a character

    -
    samlEntityId

    a character

    -
    samlJitHandlerId

    a character

    -
    samlVersion

    a SamlType - which is a character taking one of the following values: -

      -

    • SAML1_1

      • +
    + +
    issuer
    +

    a character

    + +
    loginUrl
    +

    a character

    + +
    logoutUrl
    +

    a character

    + +
    name
    +

    a character

    + +
    oauthTokenEndpoint
    +

    a character

    + +
    redirectBinding
    +

    a character either 'true' or 'false'

    + +
    requestSignatureMethod
    +

    a character

    + +
    requestSigningCertId
    +

    a character

    + +
    salesforceLoginUrl
    +

    a character

    + +
    samlEntityId
    +

    a character

    + +
    samlJitHandlerId
    +

    a character

    + +
    samlVersion
    +

    a SamlType - which is a character taking one of the following values:

    • SAML1_1

    • SAML2_0

      • -

    -
    singleLogoutBinding

    a SamlSpSLOBinding - which is a character taking one of the following values: -

      -

    • RedirectBinding

      • +
    + +
    singleLogoutBinding
    +

    a SamlSpSLOBinding - which is a character taking one of the following values:

    • RedirectBinding

    • PostBinding

      • -

    -
    singleLogoutUrl

    a character

    -
    userProvisioning

    a character either 'true' or 'false'

    -
    validationCert

    a character

    + + +
    singleLogoutUrl
    +

    a character

    -
    +
    userProvisioning
    +

    a character either 'true' or 'false'

    -

    ScheduledRecommendation

    -
    -
    scheduledRecommendationDetails

    a ScheduledRecommendationDetail

    +
    validationCert
    +

    a character

    -
    -

    ScheduledRecommendationDetail

    -
    -
    channel

    a RecommendationChannel - which is a character taking one of the following values: -

      -

    • DefaultChannel

      • +

    ScheduledRecommendation

    +
    scheduledRecommendationDetails
    +

    a ScheduledRecommendationDetail

    + + +

    ScheduledRecommendationDetail

    +
    channel
    +

    a RecommendationChannel - which is a character taking one of the following values:

    • DefaultChannel

    • CustomChannel1

    • CustomChannel2

    • CustomChannel3

    • CustomChannel4

    • CustomChannel5

      • -

    -
    enabled

    a character either 'true' or 'false'

    -
    rank

    an integer

    -
    recommendationAudience

    a character

    - -
    - -

    Scontrol

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    contentSource

    a SControlContentSource - which is a character taking one of the following values: -

      -

    • HTML

      • +
    + +
    enabled
    +

    a character either 'true' or 'false'

    + +
    rank
    +

    an integer

    + +
    recommendationAudience
    +

    a character

    + + +

    Scontrol

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    contentSource
    +

    a SControlContentSource - which is a character taking one of the following values:

    • HTML

    • URL

    • Snippet

      • -

    -
    description

    a character

    -
    encodingKey

    a Encoding - which is a character taking one of the following values: -

      -

    • UTF-8

      • +
    + +
    description
    +

    a character

    + +
    encodingKey
    +

    a Encoding - which is a character taking one of the following values:

    • UTF-8

    • ISO-8859-1

    • Shift_JIS

    • ISO-2022-JP

      • @@ -8948,115 +12827,234 @@

      Details

    • GB2312

    • Big5-HKSCS

    • x-SJIS_0213

      • -

    -
    fileContent

    a character formed using base64encode

    -
    fileName

    a character

    -
    name

    a character

    -
    supportsCaching

    a character either 'true' or 'false'

    - -
    - -

    ScontrolTranslation

    -
    -
    label

    a character

    -
    name

    a character

    - -
    - -

    SearchLayouts

    -
    -
    customTabListAdditionalFields

    a character

    -
    excludedStandardButtons

    a character

    -
    listViewButtons

    a character

    -
    lookupDialogsAdditionalFields

    a character

    -
    lookupFilterFields

    a character

    -
    lookupPhoneDialogsAdditionalFields

    a character

    -
    searchFilterFields

    a character

    -
    searchResultsAdditionalFields

    a character

    -
    searchResultsCustomButtons

    a character

    - -
    - -

    SearchSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    documentContentSearchEnabled

    a character either 'true' or 'false'

    -
    optimizeSearchForCJKEnabled

    a character either 'true' or 'false'

    -
    recentlyViewedUsersForBlankLookupEnabled

    a character either 'true' or 'false'

    -
    searchSettingsByObject

    a SearchSettingsByObject

    -
    sidebarAutoCompleteEnabled

    a character either 'true' or 'false'

    -
    sidebarDropDownListEnabled

    a character either 'true' or 'false'

    -
    sidebarLimitToItemsIOwnCheckboxEnabled

    a character either 'true' or 'false'

    -
    singleSearchResultShortcutEnabled

    a character either 'true' or 'false'

    -
    spellCorrectKnowledgeSearchEnabled

    a character either 'true' or 'false'

    - -
    - -

    SearchSettingsByObject

    -
    -
    searchSettingsByObject

    a ObjectSearchSetting

    - -
    - -

    SecuritySettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    networkAccess

    a NetworkAccess

    -
    passwordPolicies

    a PasswordPolicies

    -
    sessionSettings

    a SessionSettings

    - -
    - -

    ServiceCloudConsoleConfig

    -
    -
    componentList

    a AppComponentList

    -
    detailPageRefreshMethod

    a character

    -
    footerColor

    a character

    -
    headerColor

    a character

    -
    keyboardShortcuts

    a KeyboardShortcuts

    -
    listPlacement

    a ListPlacement

    -
    listRefreshMethod

    a character

    -
    liveAgentConfig

    a LiveAgentConfig

    -
    primaryTabColor

    a character

    -
    pushNotifications

    a PushNotification

    -
    tabLimitConfig

    a TabLimitConfig

    -
    whitelistedDomains

    a character

    - -
    - -

    SessionSettings

    -
    -
    disableTimeoutWarning

    a character either 'true' or 'false'

    -
    enableCSPOnEmail

    a character either 'true' or 'false'

    -
    enableCSRFOnGet

    a character either 'true' or 'false'

    -
    enableCSRFOnPost

    a character either 'true' or 'false'

    -
    enableCacheAndAutocomplete

    a character either 'true' or 'false'

    -
    enableClickjackNonsetupSFDC

    a character either 'true' or 'false'

    -
    enableClickjackNonsetupUser

    a character either 'true' or 'false'

    -
    enableClickjackNonsetupUserHeaderless

    a character either 'true' or 'false'

    -
    enableClickjackSetup

    a character either 'true' or 'false'

    -
    enableContentSniffingProtection

    a character either 'true' or 'false'

    -
    enablePostForSessions

    a character either 'true' or 'false'

    -
    enableSMSIdentity

    a character either 'true' or 'false'

    -
    enableUpgradeInsecureRequests

    a character either 'true' or 'false'

    -
    enableXssProtection

    a character either 'true' or 'false'

    -
    enforceIpRangesEveryRequest

    a character either 'true' or 'false'

    -
    forceLogoutOnSessionTimeout

    a character either 'true' or 'false'

    -
    forceRelogin

    a character either 'true' or 'false'

    -
    hstsOnForcecomSites

    a character either 'true' or 'false'

    -
    identityConfirmationOnEmailChange

    a character either 'true' or 'false'

    -
    identityConfirmationOnTwoFactorRegistrationEnabled

    a character either 'true' or 'false'

    -
    lockSessionsToDomain

    a character either 'true' or 'false'

    -
    lockSessionsToIp

    a character either 'true' or 'false'

    -
    logoutURL

    a character

    -
    redirectionWarning

    a character either 'true' or 'false'

    -
    referrerPolicy

    a character either 'true' or 'false'

    -
    requireHttpOnly

    a character either 'true' or 'false'

    -
    requireHttps

    a character either 'true' or 'false'

    -
    securityCentralKillSession

    a character either 'true' or 'false'

    -
    sessionTimeout

    a SessionTimeout - which is a character taking one of the following values: -

      -

    • TwentyFourHours

      • +
    + +
    fileContent
    +

    a character formed using base64encode

    + +
    fileName
    +

    a character

    + +
    name
    +

    a character

    + +
    supportsCaching
    +

    a character either 'true' or 'false'

    + + +

    ScontrolTranslation

    +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    SearchLayouts

    +
    customTabListAdditionalFields
    +

    a character

    + +
    excludedStandardButtons
    +

    a character

    + +
    listViewButtons
    +

    a character

    + +
    lookupDialogsAdditionalFields
    +

    a character

    + +
    lookupFilterFields
    +

    a character

    + +
    lookupPhoneDialogsAdditionalFields
    +

    a character

    + +
    searchFilterFields
    +

    a character

    + +
    searchResultsAdditionalFields
    +

    a character

    + +
    searchResultsCustomButtons
    +

    a character

    + + +

    SearchSettings

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    documentContentSearchEnabled
    +

    a character either 'true' or 'false'

    + +
    optimizeSearchForCJKEnabled
    +

    a character either 'true' or 'false'

    + +
    recentlyViewedUsersForBlankLookupEnabled
    +

    a character either 'true' or 'false'

    + +
    searchSettingsByObject
    +

    a SearchSettingsByObject

    + +
    sidebarAutoCompleteEnabled
    +

    a character either 'true' or 'false'

    + +
    sidebarDropDownListEnabled
    +

    a character either 'true' or 'false'

    + +
    sidebarLimitToItemsIOwnCheckboxEnabled
    +

    a character either 'true' or 'false'

    + +
    singleSearchResultShortcutEnabled
    +

    a character either 'true' or 'false'

    + +
    spellCorrectKnowledgeSearchEnabled
    +

    a character either 'true' or 'false'

    + + +

    SearchSettingsByObject

    +
    searchSettingsByObject
    +

    a ObjectSearchSetting

    + + +

    SecuritySettings

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    networkAccess
    +

    a NetworkAccess

    + +
    passwordPolicies
    +

    a PasswordPolicies

    + +
    sessionSettings
    +

    a SessionSettings

    + + +

    ServiceCloudConsoleConfig

    +
    componentList
    +

    a AppComponentList

    + +
    detailPageRefreshMethod
    +

    a character

    + +
    footerColor
    +

    a character

    + +
    headerColor
    +

    a character

    + +
    keyboardShortcuts
    +

    a KeyboardShortcuts

    + +
    listPlacement
    +

    a ListPlacement

    + +
    listRefreshMethod
    +

    a character

    + +
    liveAgentConfig
    +

    a LiveAgentConfig

    + +
    primaryTabColor
    +

    a character

    + +
    pushNotifications
    +

    a PushNotification

    + +
    tabLimitConfig
    +

    a TabLimitConfig

    + +
    whitelistedDomains
    +

    a character

    + + +

    SessionSettings

    +
    disableTimeoutWarning
    +

    a character either 'true' or 'false'

    + +
    enableCSPOnEmail
    +

    a character either 'true' or 'false'

    + +
    enableCSRFOnGet
    +

    a character either 'true' or 'false'

    + +
    enableCSRFOnPost
    +

    a character either 'true' or 'false'

    + +
    enableCacheAndAutocomplete
    +

    a character either 'true' or 'false'

    + +
    enableClickjackNonsetupSFDC
    +

    a character either 'true' or 'false'

    + +
    enableClickjackNonsetupUser
    +

    a character either 'true' or 'false'

    + +
    enableClickjackNonsetupUserHeaderless
    +

    a character either 'true' or 'false'

    + +
    enableClickjackSetup
    +

    a character either 'true' or 'false'

    + +
    enableContentSniffingProtection
    +

    a character either 'true' or 'false'

    + +
    enablePostForSessions
    +

    a character either 'true' or 'false'

    + +
    enableSMSIdentity
    +

    a character either 'true' or 'false'

    + +
    enableUpgradeInsecureRequests
    +

    a character either 'true' or 'false'

    + +
    enableXssProtection
    +

    a character either 'true' or 'false'

    + +
    enforceIpRangesEveryRequest
    +

    a character either 'true' or 'false'

    + +
    forceLogoutOnSessionTimeout
    +

    a character either 'true' or 'false'

    + +
    forceRelogin
    +

    a character either 'true' or 'false'

    + +
    hstsOnForcecomSites
    +

    a character either 'true' or 'false'

    + +
    identityConfirmationOnEmailChange
    +

    a character either 'true' or 'false'

    + +
    identityConfirmationOnTwoFactorRegistrationEnabled
    +

    a character either 'true' or 'false'

    + +
    lockSessionsToDomain
    +

    a character either 'true' or 'false'

    + +
    lockSessionsToIp
    +

    a character either 'true' or 'false'

    + +
    logoutURL
    +

    a character

    + +
    redirectionWarning
    +

    a character either 'true' or 'false'

    + +
    referrerPolicy
    +

    a character either 'true' or 'false'

    + +
    requireHttpOnly
    +

    a character either 'true' or 'false'

    + +
    requireHttps
    +

    a character either 'true' or 'false'

    + +
    securityCentralKillSession
    +

    a character either 'true' or 'false'

    + +
    sessionTimeout
    +

    a SessionTimeout - which is a character taking one of the following values:

    • TwentyFourHours

    • TwelveHours

    • EightHours

    • FourHours

      • @@ -9064,313 +13062,482 @@

      Details

    • SixtyMinutes

    • ThirtyMinutes

    • FifteenMinutes

      • -

    - -
    - -

    SFDCMobileSettings

    -
    -
    enableMobileLite

    a character either 'true' or 'false'

    -
    enableUserToDeviceLinking

    a character either 'true' or 'false'

    - -
    - -

    SharedTo

    -
    -
    allCustomerPortalUsers

    a character

    -
    allInternalUsers

    a character

    -
    allPartnerUsers

    a character

    -
    channelProgramGroup

    a character

    -
    channelProgramGroups

    a character

    -
    group

    a character

    -
    groups

    a character

    -
    managerSubordinates

    a character

    -
    managers

    a character

    -
    portalRole

    a character

    -
    portalRoleAndSubordinates

    a character

    -
    queue

    a character

    -
    role

    a character

    -
    roleAndSubordinates

    a character

    -
    roleAndSubordinatesInternal

    a character

    -
    roles

    a character

    -
    rolesAndSubordinates

    a character

    -
    territories

    a character

    -
    territoriesAndSubordinates

    a character

    -
    territory

    a character

    -
    territoryAndSubordinates

    a character

    - -
    - -

    SharingBaseRule

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    accessLevel

    a character

    -
    accountSettings

    a AccountSharingRuleSettings

    -
    description

    a character

    -
    label

    a character

    -
    sharedTo

    a SharedTo

    - -
    - -

    SharingCriteriaRule

    -
    -
    accessLevel

    a character (inherited from SharingBaseRule)

    -
    accountSettings

    a AccountSharingRuleSettings (inherited from SharingBaseRule)

    -
    description

    a character (inherited from SharingBaseRule)

    -
    label

    a character (inherited from SharingBaseRule)

    -
    sharedTo

    a SharedTo (inherited from SharingBaseRule)

    -
    booleanFilter

    a character

    -
    criteriaItems

    a FilterItem

    - -
    - -

    SharingOwnerRule

    -
    -
    accessLevel

    a character (inherited from SharingBaseRule)

    -
    accountSettings

    a AccountSharingRuleSettings (inherited from SharingBaseRule)

    -
    description

    a character (inherited from SharingBaseRule)

    -
    label

    a character (inherited from SharingBaseRule)

    -
    sharedTo

    a SharedTo (inherited from SharingBaseRule)

    -
    sharedFrom

    a SharedTo

    - -
    - -

    SharingReason

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    label

    a character

    - -
    - -

    SharingReasonTranslation

    -
    -
    label

    a character

    -
    name

    a character

    - -
    - -

    SharingRecalculation

    -
    -
    className

    a character

    - -
    - -

    SharingRules

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    sharingCriteriaRules

    a SharingCriteriaRule

    -
    sharingOwnerRules

    a SharingOwnerRule

    -
    sharingTerritoryRules

    a SharingTerritoryRule

    - -
    - -

    SharingSet

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    accessMappings

    a AccessMapping

    -
    description

    a character

    -
    name

    a character

    -
    profiles

    a character

    - -
    - -

    SharingTerritoryRule

    -
    -
    sharedFrom

    a SharedTo (inherited from SharingOwnerRule)

    - -
    - -

    SidebarComponent

    -
    -
    componentType

    a character

    -
    createAction

    a character

    -
    enableLinking

    a character either 'true' or 'false'

    -
    height

    an integer

    -
    label

    a character

    -
    lookup

    a character

    -
    page

    a character

    -
    relatedLists

    a RelatedList

    -
    unit

    a character

    -
    updateAction

    a character

    -
    width

    an integer

    - -
    - -

    SiteDotCom

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    label

    a character

    -
    siteType

    a SiteType - which is a character taking one of the following values: -

      -

    • Siteforce

      • +
    + + +

    SFDCMobileSettings

    +
    enableMobileLite
    +

    a character either 'true' or 'false'

    + +
    enableUserToDeviceLinking
    +

    a character either 'true' or 'false'

    + + +

    SharedTo

    +
    allCustomerPortalUsers
    +

    a character

    + +
    allInternalUsers
    +

    a character

    + +
    allPartnerUsers
    +

    a character

    + +
    channelProgramGroup
    +

    a character

    + +
    channelProgramGroups
    +

    a character

    + +
    group
    +

    a character

    + +
    groups
    +

    a character

    + +
    managerSubordinates
    +

    a character

    + +
    managers
    +

    a character

    + +
    portalRole
    +

    a character

    + +
    portalRoleAndSubordinates
    +

    a character

    + +
    queue
    +

    a character

    + +
    role
    +

    a character

    + +
    roleAndSubordinates
    +

    a character

    + +
    roleAndSubordinatesInternal
    +

    a character

    + +
    roles
    +

    a character

    + +
    rolesAndSubordinates
    +

    a character

    + +
    territories
    +

    a character

    + +
    territoriesAndSubordinates
    +

    a character

    + +
    territory
    +

    a character

    + +
    territoryAndSubordinates
    +

    a character

    + + +

    SharingBaseRule

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    accessLevel
    +

    a character

    + +
    accountSettings
    +

    a AccountSharingRuleSettings

    + +
    description
    +

    a character

    + +
    label
    +

    a character

    + +
    sharedTo
    +

    a SharedTo

    + + +

    SharingCriteriaRule

    +
    accessLevel
    +

    a character (inherited from SharingBaseRule)

    + +
    accountSettings
    +

    a AccountSharingRuleSettings (inherited from SharingBaseRule)

    + +
    description
    +

    a character (inherited from SharingBaseRule)

    + +
    label
    +

    a character (inherited from SharingBaseRule)

    + +
    sharedTo
    +

    a SharedTo (inherited from SharingBaseRule)

    + +
    booleanFilter
    +

    a character

    + +
    criteriaItems
    +

    a FilterItem

    + + +

    SharingOwnerRule

    +
    accessLevel
    +

    a character (inherited from SharingBaseRule)

    + +
    accountSettings
    +

    a AccountSharingRuleSettings (inherited from SharingBaseRule)

    + +
    description
    +

    a character (inherited from SharingBaseRule)

    + +
    label
    +

    a character (inherited from SharingBaseRule)

    + +
    sharedTo
    +

    a SharedTo (inherited from SharingBaseRule)

    + +
    sharedFrom
    +

    a SharedTo

    + + +

    SharingReason

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    label
    +

    a character

    + + +

    SharingReasonTranslation

    +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    SharingRecalculation

    +
    className
    +

    a character

    + + +

    SharingRules

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    sharingCriteriaRules
    +

    a SharingCriteriaRule

    + +
    sharingOwnerRules
    +

    a SharingOwnerRule

    + +
    sharingTerritoryRules
    +

    a SharingTerritoryRule

    + + +

    SharingSet

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    accessMappings
    +

    a AccessMapping

    + +
    description
    +

    a character

    + +
    name
    +

    a character

    + +
    profiles
    +

    a character

    + + +

    SharingTerritoryRule

    +
    sharedFrom
    +

    a SharedTo (inherited from SharingOwnerRule)

    + + +

    SidebarComponent

    +
    componentType
    +

    a character

    + +
    createAction
    +

    a character

    + +
    enableLinking
    +

    a character either 'true' or 'false'

    + +
    height
    +

    an integer

    + +
    label
    +

    a character

    + +
    lookup
    +

    a character

    + +
    page
    +

    a character

    + +
    relatedLists
    +

    a RelatedList

    + +
    unit
    +

    a character

    + +
    updateAction
    +

    a character

    + +
    width
    +

    an integer

    + + +

    SiteDotCom

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    label
    +

    a character

    + +
    siteType
    +

    a SiteType - which is a character taking one of the following values:

    • Siteforce

    • Visualforce

    • User

      • -

    + + + +

    SiteRedirectMapping

    +
    action
    +

    a SiteRedirect - which is a character taking one of the following values:

    • Permanent

      • +

    • Temporary

      • +
    + +
    isActive
    +

    a character either 'true' or 'false'

    + +
    source
    +

    a character

    + +
    target
    +

    a character

    + + +

    SiteWebAddress

    +
    certificate
    +

    a character

    + +
    domainName
    +

    a character

    + +
    primary
    +

    a character either 'true' or 'false'

    + + +

    Skill

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    assignments
    +

    a SkillAssignments

    + +
    description
    +

    a character

    + +
    label
    +

    a character

    + + +

    SkillAssignments

    +
    profiles
    +

    a SkillProfileAssignments

    + +
    users
    +

    a SkillUserAssignments

    + + +

    SkillProfileAssignments

    +
    profile
    +

    a character

    + + +

    SkillUserAssignments

    +
    user
    +

    a character

    + + +

    SocialCustomerServiceSettings

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    caseSubjectOption
    +

    a CaseSubjectOption - which is a character taking one of the following values:

    • SocialPostSource

      • +

    • SocialPostContent

      • +

    • BuildCustom

      • +
    + + +

    StandardFieldTranslation

    +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    StandardValue

    +
    color
    +

    a character (inherited from CustomValue)

    + +
    default
    +

    a character either 'true' or 'false' (inherited from CustomValue)

    + +
    description
    +

    a character (inherited from CustomValue)

    + +
    isActive
    +

    a character either 'true' or 'false' (inherited from CustomValue)

    + +
    label
    +

    a character (inherited from CustomValue)

    + +
    allowEmail
    +

    a character either 'true' or 'false'

    + +
    closed
    +

    a character either 'true' or 'false'

    + +
    converted
    +

    a character either 'true' or 'false'

    + +
    cssExposed
    +

    a character either 'true' or 'false'

    + +
    forecastCategory
    +

    a ForecastCategories - which is a character taking one of the following values:

    • Omitted

      • +

    • Pipeline

      • +

    • BestCase

      • +

    • Forecast

      • +

    • Closed

      • +
    + +
    groupingString
    +

    a character

    + +
    highPriority
    +

    a character either 'true' or 'false'

    + +
    probability
    +

    an integer

    + +
    reverseRole
    +

    a character

    + +
    reviewed
    +

    a character either 'true' or 'false'

    + +
    won
    +

    a character either 'true' or 'false'

    -
    -

    SiteRedirectMapping

    -
    -
    action

    a SiteRedirect - which is a character taking one of the following values: -

      -

    • Permanent

      • -

    • Temporary

      • -

    -
    isActive

    a character either 'true' or 'false'

    -
    source

    a character

    -
    target

    a character

    +

    StandardValueSet

    +
    fullName
    +

    a character (inherited from Metadata)

    -
    +
    groupingStringEnum
    +

    a character

    -

    SiteWebAddress

    -
    -
    certificate

    a character

    -
    domainName

    a character

    -
    primary

    a character either 'true' or 'false'

    +
    sorted
    +

    a character either 'true' or 'false'

    -
    +
    standardValue
    +

    a StandardValue

    -

    Skill

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    assignments

    a SkillAssignments

    -
    description

    a character

    -
    label

    a character

    -
    +

    StandardValueSetTranslation

    +
    fullName
    +

    a character (inherited from Metadata)

    -

    SkillAssignments

    -
    -
    profiles

    a SkillProfileAssignments

    -
    users

    a SkillUserAssignments

    +
    valueTranslation
    +

    a ValueTranslation

    -
    -

    SkillProfileAssignments

    -
    -
    profile

    a character

    +

    State

    +
    active
    +

    a character either 'true' or 'false'

    -
    +
    integrationValue
    +

    a character

    -

    SkillUserAssignments

    -
    -
    user

    a character

    +
    isoCode
    +

    a character

    -
    +
    label
    +

    a character

    -

    SocialCustomerServiceSettings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    caseSubjectOption

    a CaseSubjectOption - which is a character taking one of the following values: -

      -

    • SocialPostSource

      • -

    • SocialPostContent

      • -

    • BuildCustom

      • -

    - -
    - -

    StandardFieldTranslation

    -
    -
    label

    a character

    -
    name

    a character

    - -
    - -

    StandardValue

    -
    -
    color

    a character (inherited from CustomValue)

    -
    default

    a character either 'true' or 'false' (inherited from CustomValue)

    -
    description

    a character (inherited from CustomValue)

    -
    isActive

    a character either 'true' or 'false' (inherited from CustomValue)

    -
    label

    a character (inherited from CustomValue)

    -
    allowEmail

    a character either 'true' or 'false'

    -
    closed

    a character either 'true' or 'false'

    -
    converted

    a character either 'true' or 'false'

    -
    cssExposed

    a character either 'true' or 'false'

    -
    forecastCategory

    a ForecastCategories - which is a character taking one of the following values: -

      -

    • Omitted

      • -

    • Pipeline

      • -

    • BestCase

      • -

    • Forecast

      • -

    • Closed

      • -

    -
    groupingString

    a character

    -
    highPriority

    a character either 'true' or 'false'

    -
    probability

    an integer

    -
    reverseRole

    a character

    -
    reviewed

    a character either 'true' or 'false'

    -
    won

    a character either 'true' or 'false'

    - -
    - -

    StandardValueSet

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    groupingStringEnum

    a character

    -
    sorted

    a character either 'true' or 'false'

    -
    standardValue

    a StandardValue

    - -
    - -

    StandardValueSetTranslation

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    valueTranslation

    a ValueTranslation

    - -
    - -

    State

    -
    -
    active

    a character either 'true' or 'false'

    -
    integrationValue

    a character

    -
    isoCode

    a character

    -
    label

    a character

    -
    standard

    a character either 'true' or 'false'

    -
    visible

    a character either 'true' or 'false'

    - -
    - -

    StaticResource

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    cacheControl

    a StaticResourceCacheControl - which is a character taking one of the following values: -

      -

    • Private

      • +
      standard
      +

      a character either 'true' or 'false'

      + +
      visible
      +

      a character either 'true' or 'false'

      + + +

    StaticResource

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    cacheControl
    +

    a StaticResourceCacheControl - which is a character taking one of the following values:

    • Private

    • Public

      • -

    -
    contentType

    a character

    -
    description

    a character

    - -
    - -

    StrategyNode

    -
    -
    definition

    a character

    -
    description

    a character

    -
    name

    a character

    -
    parentNode

    a character

    -
    type

    an integer

    - -
    - -

    SubtabComponents

    -
    -
    containers

    a Container

    - -
    - -

    SummaryLayout

    -
    -
    masterLabel

    a character

    -
    sizeX

    an integer

    -
    sizeY

    an integer

    -
    sizeZ

    an integer

    -
    summaryLayoutItems

    a SummaryLayoutItem

    -
    summaryLayoutStyle

    a SummaryLayoutStyle - which is a character taking one of the following values: -

      -

    • Default

      • +
    + +
    contentType
    +

    a character

    + +
    description
    +

    a character

    + + +

    StrategyNode

    +
    definition
    +

    a character

    + +
    description
    +

    a character

    + +
    name
    +

    a character

    + +
    parentNode
    +

    a character

    + +
    type
    +

    an integer

    + + +

    SubtabComponents

    +
    containers
    +

    a Container

    + + +

    SummaryLayout

    +
    masterLabel
    +

    a character

    + +
    sizeX
    +

    an integer

    + +
    sizeY
    +

    an integer

    + +
    sizeZ
    +

    an integer

    + +
    summaryLayoutItems
    +

    a SummaryLayoutItem

    + +
    summaryLayoutStyle
    +

    a SummaryLayoutStyle - which is a character taking one of the following values:

    • Default

    • QuoteTemplate

    • DefaultQuoteTemplate

    • ServiceReportTemplate

      • @@ -9380,40 +13547,48 @@

      Details

    • QuickActionLayoutLeftRight

    • QuickActionLayoutTopDown

    • PathAssistant

      • -

    + + + +

    SummaryLayoutItem

    +
    customLink
    +

    a character

    + +
    field
    +

    a character

    + +
    posX
    +

    an integer

    -
    +
    posY
    +

    an integer

    -

    SummaryLayoutItem

    -
    -
    customLink

    a character

    -
    field

    a character

    -
    posX

    an integer

    -
    posY

    an integer

    -
    posZ

    an integer

    +
    posZ
    +

    an integer

    -
    -

    SupervisorAgentConfigSkills

    -
    -
    skill

    a character

    +

    SupervisorAgentConfigSkills

    +
    skill
    +

    a character

    -
    -

    SynonymDictionary

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    groups

    a SynonymGroup

    -
    isProtected

    a character either 'true' or 'false'

    -
    label

    a character

    +

    SynonymDictionary

    +
    fullName
    +

    a character (inherited from Metadata)

    -
    +
    groups
    +

    a SynonymGroup

    -

    SynonymGroup

    -
    -
    languages

    a Language - which is a character taking one of the following values: -

      -

    • en_US

      • +
      isProtected
      +

      a character either 'true' or 'false'

      + +
      label
      +

      a character

      + + +

    SynonymGroup

    +
    languages
    +

    a Language - which is a character taking one of the following values:

    • en_US

    • de

    • es

    • fr

      • @@ -9532,80 +13707,129 @@

      Details

    • ca

    • eo

    • iw_EO

      • -

    -
    terms

    a character

    - -
    - -

    TabLimitConfig

    -
    -
    maxNumberOfPrimaryTabs

    a character

    -
    maxNumberOfSubTabs

    a character

    - -
    - -

    Territory

    -
    -
    caseAccessLevel

    a character (inherited from RoleOrTerritory)

    -
    contactAccessLevel

    a character (inherited from RoleOrTerritory)

    -
    description

    a character (inherited from RoleOrTerritory)

    -
    mayForecastManagerShare

    a character either 'true' or 'false' (inherited from RoleOrTerritory)

    -
    name

    a character (inherited from RoleOrTerritory)

    -
    opportunityAccessLevel

    a character (inherited from RoleOrTerritory)

    -
    accountAccessLevel

    a character

    -
    parentTerritory

    a character

    - -
    - -

    Territory2

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    accountAccessLevel

    a character

    -
    caseAccessLevel

    a character

    -
    contactAccessLevel

    a character

    -
    customFields

    a FieldValue

    -
    description

    a character

    -
    name

    a character

    -
    opportunityAccessLevel

    a character

    -
    parentTerritory

    a character

    -
    ruleAssociations

    a Territory2RuleAssociation

    -
    territory2Type

    a character

    - -
    - -

    Territory2Model

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    customFields

    a FieldValue

    -
    description

    a character

    -
    name

    a character

    - -
    - -

    Territory2Rule

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    active

    a character either 'true' or 'false'

    -
    booleanFilter

    a character

    -
    name

    a character

    -
    objectType

    a character

    -
    ruleItems

    a Territory2RuleItem

    - -
    - -

    Territory2RuleAssociation

    -
    -
    inherited

    a character either 'true' or 'false'

    -
    ruleName

    a character

    - -
    - -

    Territory2RuleItem

    -
    -
    field

    a character

    -
    operation

    a FilterOperation - which is a character taking one of the following values: -

      -

    • equals

      • +
    + +
    terms
    +

    a character

    + + +

    TabLimitConfig

    +
    maxNumberOfPrimaryTabs
    +

    a character

    + +
    maxNumberOfSubTabs
    +

    a character

    + + +

    Territory

    +
    caseAccessLevel
    +

    a character (inherited from RoleOrTerritory)

    + +
    contactAccessLevel
    +

    a character (inherited from RoleOrTerritory)

    + +
    description
    +

    a character (inherited from RoleOrTerritory)

    + +
    mayForecastManagerShare
    +

    a character either 'true' or 'false' (inherited from RoleOrTerritory)

    + +
    name
    +

    a character (inherited from RoleOrTerritory)

    + +
    opportunityAccessLevel
    +

    a character (inherited from RoleOrTerritory)

    + +
    accountAccessLevel
    +

    a character

    + +
    parentTerritory
    +

    a character

    + + +

    Territory2

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    accountAccessLevel
    +

    a character

    + +
    caseAccessLevel
    +

    a character

    + +
    contactAccessLevel
    +

    a character

    + +
    customFields
    +

    a FieldValue

    + +
    description
    +

    a character

    + +
    name
    +

    a character

    + +
    opportunityAccessLevel
    +

    a character

    + +
    parentTerritory
    +

    a character

    + +
    ruleAssociations
    +

    a Territory2RuleAssociation

    + +
    territory2Type
    +

    a character

    + + +

    Territory2Model

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    customFields
    +

    a FieldValue

    + +
    description
    +

    a character

    + +
    name
    +

    a character

    + + +

    Territory2Rule

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    active
    +

    a character either 'true' or 'false'

    + +
    booleanFilter
    +

    a character

    + +
    name
    +

    a character

    + +
    objectType
    +

    a character

    + +
    ruleItems
    +

    a Territory2RuleItem

    + + +

    Territory2RuleAssociation

    +
    inherited
    +

    a character either 'true' or 'false'

    + +
    ruleName
    +

    a character

    + + +

    Territory2RuleItem

    +
    field
    +

    a character

    + +
    operation
    +

    a FilterOperation - which is a character taking one of the following values:

    • equals

    • notEqual

    • lessThan

    • greaterThan

      • @@ -9617,508 +13841,887 @@

      Details

    • includes

    • excludes

    • within

      • -

    -
    value

    a character

    - -
    - -

    Territory2Settings

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    defaultAccountAccessLevel

    a character

    -
    defaultCaseAccessLevel

    a character

    -
    defaultContactAccessLevel

    a character

    -
    defaultOpportunityAccessLevel

    a character

    -
    opportunityFilterSettings

    a Territory2SettingsOpportunityFilter

    - -
    - -

    Territory2SettingsOpportunityFilter

    -
    -
    apexClassName

    a character

    -
    enableFilter

    a character either 'true' or 'false'

    -
    runOnCreate

    a character either 'true' or 'false'

    - -
    - -

    Territory2Type

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    name

    a character

    -
    priority

    an integer

    - -
    - -

    TopicsForObjects

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    enableTopics

    a character either 'true' or 'false'

    -
    entityApiName

    a character

    - -
    - -

    TouchMobileSettings

    -
    -
    enableTouchAppIPad

    a character either 'true' or 'false'

    -
    enableTouchAppIPhone

    a character either 'true' or 'false'

    -
    enableTouchBrowserIPad

    a character either 'true' or 'false'

    -
    enableTouchIosPhone

    a character either 'true' or 'false'

    -
    enableVisualforceInTouch

    a character either 'true' or 'false'

    - -
    - -

    TransactionSecurityAction

    -
    -
    block

    a character either 'true' or 'false'

    -
    endSession

    a character either 'true' or 'false'

    -
    freezeUser

    a character either 'true' or 'false'

    -
    notifications

    a TransactionSecurityNotification

    -
    twoFactorAuthentication

    a character either 'true' or 'false'

    - -
    - -

    TransactionSecurityNotification

    -
    -
    inApp

    a character either 'true' or 'false'

    -
    sendEmail

    a character either 'true' or 'false'

    -
    user

    a character

    - -
    - -

    TransactionSecurityPolicy

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    action

    a TransactionSecurityAction

    -
    active

    a character either 'true' or 'false'

    -
    apexClass

    a character

    -
    description

    a character

    -
    developerName

    a character

    -
    eventName

    a TransactionSecurityEventName - which is a character taking one of the following values: -

      -

    • ReportEvent

      • +
    + +
    value
    +

    a character

    + + +

    Territory2Settings

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    defaultAccountAccessLevel
    +

    a character

    + +
    defaultCaseAccessLevel
    +

    a character

    + +
    defaultContactAccessLevel
    +

    a character

    + +
    defaultOpportunityAccessLevel
    +

    a character

    + +
    opportunityFilterSettings
    +

    a Territory2SettingsOpportunityFilter

    + + +

    Territory2SettingsOpportunityFilter

    +
    apexClassName
    +

    a character

    + +
    enableFilter
    +

    a character either 'true' or 'false'

    + +
    runOnCreate
    +

    a character either 'true' or 'false'

    + + +

    Territory2Type

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    description
    +

    a character

    + +
    name
    +

    a character

    + +
    priority
    +

    an integer

    + + +

    TopicsForObjects

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    enableTopics
    +

    a character either 'true' or 'false'

    + +
    entityApiName
    +

    a character

    + + +

    TouchMobileSettings

    +
    enableTouchAppIPad
    +

    a character either 'true' or 'false'

    + +
    enableTouchAppIPhone
    +

    a character either 'true' or 'false'

    + +
    enableTouchBrowserIPad
    +

    a character either 'true' or 'false'

    + +
    enableTouchIosPhone
    +

    a character either 'true' or 'false'

    + +
    enableVisualforceInTouch
    +

    a character either 'true' or 'false'

    + + +

    TransactionSecurityAction

    +
    block
    +

    a character either 'true' or 'false'

    + +
    endSession
    +

    a character either 'true' or 'false'

    + +
    freezeUser
    +

    a character either 'true' or 'false'

    + +
    notifications
    +

    a TransactionSecurityNotification

    + +
    twoFactorAuthentication
    +

    a character either 'true' or 'false'

    + + +

    TransactionSecurityNotification

    +
    inApp
    +

    a character either 'true' or 'false'

    + +
    sendEmail
    +

    a character either 'true' or 'false'

    + +
    user
    +

    a character

    + + +

    TransactionSecurityPolicy

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    action
    +

    a TransactionSecurityAction

    + +
    active
    +

    a character either 'true' or 'false'

    + +
    apexClass
    +

    a character

    + +
    description
    +

    a character

    + +
    developerName
    +

    a character

    + +
    eventName
    +

    a TransactionSecurityEventName - which is a character taking one of the following values:

    • ReportEvent

    • ApiEvent

    • AdminSetupEvent

    • LoginEvent

      • -

    -
    eventType

    a MonitoredEvents - which is a character taking one of the following values: -

      -

    • AuditTrail

      • +
    + +
    eventType
    +

    a MonitoredEvents - which is a character taking one of the following values:

    • AuditTrail

    • Login

    • Entity

    • DataExport

    • AccessResource

      • -

    -
    executionUser

    a character

    -
    flow

    a character

    -
    masterLabel

    a character

    -
    resourceName

    a character

    -
    type

    a TxnSecurityPolicyType - which is a character taking one of the following values: -

      -

    • CustomApexPolicy

      • +
    + +
    executionUser
    +

    a character

    + +
    flow
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    resourceName
    +

    a character

    + +
    type
    +

    a TxnSecurityPolicyType - which is a character taking one of the following values:

    • CustomApexPolicy

    • CustomConditionBuilderPolicy

      • -

    - -
    - -

    Translations

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    customApplications

    a CustomApplicationTranslation

    -
    customDataTypeTranslations

    a CustomDataTypeTranslation

    -
    customLabels

    a CustomLabelTranslation

    -
    customPageWebLinks

    a CustomPageWebLinkTranslation

    -
    customTabs

    a CustomTabTranslation

    -
    flowDefinitions

    a FlowDefinitionTranslation

    -
    quickActions

    a GlobalQuickActionTranslation

    -
    reportTypes

    a ReportTypeTranslation

    -
    scontrols

    a ScontrolTranslation

    - -
    - -

    UiFormulaCriterion

    -
    -
    leftValue

    a character

    -
    operator

    a character

    -
    rightValue

    a character

    - -
    - -

    UiFormulaRule

    -
    -
    booleanFilter

    a character

    -
    criteria

    a UiFormulaCriterion

    - -
    - -

    UiPlugin

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    description

    a character

    -
    extensionPointIdentifier

    a character

    -
    isEnabled

    a character either 'true' or 'false'

    -
    language

    a character

    -
    masterLabel

    a character

    - -
    - -

    UserCriteria

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    creationAgeInSeconds

    an integer

    -
    description

    a character

    -
    lastChatterActivityAgeInSeconds

    an integer

    -
    masterLabel

    a character

    -
    profiles

    a character

    -
    userTypes

    a NetworkUserType - which is a character taking one of the following values: -

      -

    • Internal

      • +
    + + +

    Translations

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    customApplications
    +

    a CustomApplicationTranslation

    + +
    customDataTypeTranslations
    +

    a CustomDataTypeTranslation

    + +
    customLabels
    +

    a CustomLabelTranslation

    + +
    customPageWebLinks
    +

    a CustomPageWebLinkTranslation

    + +
    customTabs
    +

    a CustomTabTranslation

    + +
    flowDefinitions
    +

    a FlowDefinitionTranslation

    + +
    quickActions
    +

    a GlobalQuickActionTranslation

    + +
    reportTypes
    +

    a ReportTypeTranslation

    + +
    scontrols
    +

    a ScontrolTranslation

    + + +

    UiFormulaCriterion

    +
    leftValue
    +

    a character

    + +
    operator
    +

    a character

    + +
    rightValue
    +

    a character

    + + +

    UiFormulaRule

    +
    booleanFilter
    +

    a character

    + +
    criteria
    +

    a UiFormulaCriterion

    + + +

    UiPlugin

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    description
    +

    a character

    + +
    extensionPointIdentifier
    +

    a character

    + +
    isEnabled
    +

    a character either 'true' or 'false'

    + +
    language
    +

    a character

    + +
    masterLabel
    +

    a character

    + + +

    UserCriteria

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    creationAgeInSeconds
    +

    an integer

    + +
    description
    +

    a character

    + +
    lastChatterActivityAgeInSeconds
    +

    an integer

    + +
    masterLabel
    +

    a character

    + +
    profiles
    +

    a character

    + +
    userTypes
    +

    a NetworkUserType - which is a character taking one of the following values:

    • Internal

    • Customer

    • Partner

      • -

    - -
    - -

    Users

    -
    -
    user

    a character

    - -
    - -

    ValidationRule

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    active

    a character either 'true' or 'false'

    -
    description

    a character

    -
    errorConditionFormula

    a character

    -
    errorDisplayField

    a character

    -
    errorMessage

    a character

    - -
    - -

    ValidationRuleTranslation

    -
    -
    errorMessage

    a character

    -
    name

    a character

    - -
    - -

    ValueSet

    -
    -
    controllingField

    a character

    -
    restricted

    a character either 'true' or 'false'

    -
    valueSetDefinition

    a ValueSetValuesDefinition

    -
    valueSetName

    a character

    -
    valueSettings

    a ValueSettings

    - -
    - -

    ValueSettings

    -
    -
    controllingFieldValue

    a character

    -
    valueName

    a character

    - -
    - -

    ValueSetValuesDefinition

    -
    -
    sorted

    a character either 'true' or 'false'

    -
    value

    a CustomValue

    - -
    - -

    ValueTranslation

    -
    -
    masterLabel

    a character

    -
    translation

    a character

    - -
    - -

    ValueTypeField

    -
    -
    fields

    a ValueTypeField

    -
    foreignKeyDomain

    a character

    -
    isForeignKey

    a character either 'true' or 'false'

    -
    isNameField

    a character either 'true' or 'false'

    -
    minOccurs

    an integer

    -
    name

    a character

    -
    picklistValues

    a PicklistEntry

    -
    soapType

    a character

    -
    valueRequired

    a character either 'true' or 'false'

    - -
    - -

    VisualizationPlugin

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    description

    a character

    -
    developerName

    a character

    -
    icon

    a character

    -
    masterLabel

    a character

    -
    visualizationResources

    a VisualizationResource

    -
    visualizationTypes

    a VisualizationType

    - -
    - -

    VisualizationResource

    -
    -
    description

    a character

    -
    file

    a character

    -
    rank

    an integer

    -
    type

    a VisualizationResourceType - which is a character taking one of the following values: -

      -

    • js

      • +
    + + +

    Users

    +
    user
    +

    a character

    + + +

    ValidationRule

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    active
    +

    a character either 'true' or 'false'

    + +
    description
    +

    a character

    + +
    errorConditionFormula
    +

    a character

    + +
    errorDisplayField
    +

    a character

    + +
    errorMessage
    +

    a character

    + + +

    ValidationRuleTranslation

    +
    errorMessage
    +

    a character

    + +
    name
    +

    a character

    + + +

    ValueSet

    +
    controllingField
    +

    a character

    + +
    restricted
    +

    a character either 'true' or 'false'

    + +
    valueSetDefinition
    +

    a ValueSetValuesDefinition

    + +
    valueSetName
    +

    a character

    + +
    valueSettings
    +

    a ValueSettings

    + + +

    ValueSettings

    +
    controllingFieldValue
    +

    a character

    + +
    valueName
    +

    a character

    + + +

    ValueSetValuesDefinition

    +
    sorted
    +

    a character either 'true' or 'false'

    + +
    value
    +

    a CustomValue

    + + +

    ValueTranslation

    +
    masterLabel
    +

    a character

    + +
    translation
    +

    a character

    + + +

    ValueTypeField

    +
    fields
    +

    a ValueTypeField

    + +
    foreignKeyDomain
    +

    a character

    + +
    isForeignKey
    +

    a character either 'true' or 'false'

    + +
    isNameField
    +

    a character either 'true' or 'false'

    + +
    minOccurs
    +

    an integer

    + +
    name
    +

    a character

    + +
    picklistValues
    +

    a PicklistEntry

    + +
    soapType
    +

    a character

    + +
    valueRequired
    +

    a character either 'true' or 'false'

    + + +

    VisualizationPlugin

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    description
    +

    a character

    + +
    developerName
    +

    a character

    + +
    icon
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    visualizationResources
    +

    a VisualizationResource

    + +
    visualizationTypes
    +

    a VisualizationType

    + + +

    VisualizationResource

    +
    description
    +

    a character

    + +
    file
    +

    a character

    + +
    rank
    +

    an integer

    + +
    type
    +

    a VisualizationResourceType - which is a character taking one of the following values:

    • js

    • css

      • -

    - -
    - -

    VisualizationType

    -
    -
    description

    a character

    -
    developerName

    a character

    -
    icon

    a character

    -
    masterLabel

    a character

    -
    scriptBootstrapMethod

    a character

    - -
    - -

    WaveApplication

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    assetIcon

    a character

    -
    description

    a character

    -
    folder

    a character

    -
    masterLabel

    a character

    -
    shares

    a FolderShare

    -
    templateOrigin

    a character

    -
    templateVersion

    a character

    - -
    - -

    WaveDashboard

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    application

    a character

    -
    description

    a character

    -
    masterLabel

    a character

    -
    templateAssetSourceName

    a character

    - -
    - -

    WaveDataflow

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    dataflowType

    a character

    -
    description

    a character

    -
    masterLabel

    a character

    - -
    - -

    WaveDataset

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    application

    a character

    -
    description

    a character

    -
    masterLabel

    a character

    -
    templateAssetSourceName

    a character

    - -
    - -

    WaveLens

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    application

    a character

    -
    datasets

    a character

    -
    description

    a character

    -
    masterLabel

    a character

    -
    templateAssetSourceName

    a character

    -
    visualizationType

    a character

    - -
    - -

    WaveRecipe

    -
    -
    content

    a character formed using base64encode (inherited from MetadataWithContent)

    -
    dataflow

    a character

    -
    masterLabel

    a character

    -
    securityPredicate

    a character

    -
    targetDatasetAlias

    a character

    - -
    - -

    WaveTemplateBundle

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    assetIcon

    a character

    -
    assetVersion

    a numeric

    -
    description

    a character

    -
    label

    a character

    -
    templateBadgeIcon

    a character

    -
    templateDetailIcon

    a character

    -
    templateType

    a character

    - -
    - -

    WaveXmd

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    application

    a character

    -
    dataset

    a character

    -
    datasetConnector

    a character

    -
    datasetFullyQualifiedName

    a character

    -
    dates

    a WaveXmdDate

    -
    dimensions

    a WaveXmdDimension

    -
    measures

    a WaveXmdMeasure

    -
    organizations

    a WaveXmdOrganization

    -
    origin

    a character

    -
    type

    a character

    -
    waveVisualization

    a character

    - -
    - -

    WaveXmdDate

    -
    -
    alias

    a character

    -
    compact

    a character either 'true' or 'false'

    -
    dateFieldDay

    a character

    -
    dateFieldEpochDay

    a character

    -
    dateFieldEpochSecond

    a character

    -
    dateFieldFiscalMonth

    a character

    -
    dateFieldFiscalQuarter

    a character

    -
    dateFieldFiscalWeek

    a character

    -
    dateFieldFiscalYear

    a character

    -
    dateFieldFullYear

    a character

    -
    dateFieldHour

    a character

    -
    dateFieldMinute

    a character

    -
    dateFieldMonth

    a character

    -
    dateFieldQuarter

    a character

    -
    dateFieldSecond

    a character

    -
    dateFieldWeek

    a character

    -
    dateFieldYear

    a character

    -
    description

    a character

    -
    firstDayOfWeek

    an integer

    -
    fiscalMonthOffset

    an integer

    -
    isYearEndFiscalYear

    a character either 'true' or 'false'

    -
    label

    a character

    -
    showInExplorer

    a character either 'true' or 'false'

    -
    sortIndex

    an integer

    - -
    - -

    WaveXmdDimension

    -
    -
    customActions

    a WaveXmdDimensionCustomAction

    -
    customActionsEnabled

    a character either 'true' or 'false'

    -
    dateFormat

    a character

    -
    description

    a character

    -
    field

    a character

    -
    fullyQualifiedName

    a character

    -
    imageTemplate

    a character

    -
    isDerived

    a character either 'true' or 'false'

    -
    isMultiValue

    a character either 'true' or 'false'

    -
    label

    a character

    -
    linkTemplate

    a character

    -
    linkTemplateEnabled

    a character either 'true' or 'false'

    -
    linkTooltip

    a character

    -
    members

    a WaveXmdDimensionMember

    -
    origin

    a character

    -
    recordDisplayFields

    a WaveXmdRecordDisplayLookup

    -
    recordIdField

    a character

    -
    recordOrganizationIdField

    a character

    -
    salesforceActions

    a WaveXmdDimensionSalesforceAction

    -
    salesforceActionsEnabled

    a character either 'true' or 'false'

    -
    showDetailsDefaultFieldIndex

    an integer

    -
    showInExplorer

    a character either 'true' or 'false'

    -
    sortIndex

    an integer

    - -
    - -

    WaveXmdDimensionCustomAction

    -
    -
    customActionName

    a character

    -
    enabled

    a character either 'true' or 'false'

    -
    icon

    a character

    -
    method

    a character

    -
    sortIndex

    an integer

    -
    target

    a character

    -
    tooltip

    a character

    -
    url

    a character

    - -
    - -

    WaveXmdDimensionMember

    -
    -
    color

    a character

    -
    label

    a character

    -
    member

    a character

    -
    sortIndex

    an integer

    - -
    - -

    WaveXmdDimensionSalesforceAction

    -
    -
    enabled

    a character either 'true' or 'false'

    -
    salesforceActionName

    a character

    -
    sortIndex

    an integer

    - -
    - -

    WaveXmdMeasure

    -
    -
    dateFormat

    a character

    -
    description

    a character

    -
    field

    a character

    -
    formatCustomFormat

    a character

    -
    formatDecimalDigits

    an integer

    -
    formatIsNegativeParens

    a character either 'true' or 'false'

    -
    formatPrefix

    a character

    -
    formatSuffix

    a character

    -
    formatUnit

    a character

    -
    formatUnitMultiplier

    a numeric

    -
    fullyQualifiedName

    a character

    -
    isDerived

    a character either 'true' or 'false'

    -
    label

    a character

    -
    origin

    a character

    -
    showDetailsDefaultFieldIndex

    an integer

    -
    showInExplorer

    a character either 'true' or 'false'

    -
    sortIndex

    an integer

    - -
    - -

    WaveXmdOrganization

    -
    -
    instanceUrl

    a character

    -
    label

    a character

    -
    organizationIdentifier

    a character

    -
    sortIndex

    an integer

    - -
    - -

    WaveXmdRecordDisplayLookup

    -
    -
    recordDisplayField

    a character

    - -
    - -

    WebLink

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    availability

    a WebLinkAvailability - which is a character taking one of the following values: -

      -

    • online

      • +
    + + +

    VisualizationType

    +
    description
    +

    a character

    + +
    developerName
    +

    a character

    + +
    icon
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    scriptBootstrapMethod
    +

    a character

    + + +

    WaveApplication

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    assetIcon
    +

    a character

    + +
    description
    +

    a character

    + +
    folder
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    shares
    +

    a FolderShare

    + +
    templateOrigin
    +

    a character

    + +
    templateVersion
    +

    a character

    + + +

    WaveDashboard

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    application
    +

    a character

    + +
    description
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    templateAssetSourceName
    +

    a character

    + + +

    WaveDataflow

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    dataflowType
    +

    a character

    + +
    description
    +

    a character

    + +
    masterLabel
    +

    a character

    + + +

    WaveDataset

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    application
    +

    a character

    + +
    description
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    templateAssetSourceName
    +

    a character

    + + +

    WaveLens

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    application
    +

    a character

    + +
    datasets
    +

    a character

    + +
    description
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    templateAssetSourceName
    +

    a character

    + +
    visualizationType
    +

    a character

    + + +

    WaveRecipe

    +
    content
    +

    a character formed using base64encode (inherited from MetadataWithContent)

    + +
    dataflow
    +

    a character

    + +
    masterLabel
    +

    a character

    + +
    securityPredicate
    +

    a character

    + +
    targetDatasetAlias
    +

    a character

    + + +

    WaveTemplateBundle

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    assetIcon
    +

    a character

    + +
    assetVersion
    +

    a numeric

    + +
    description
    +

    a character

    + +
    label
    +

    a character

    + +
    templateBadgeIcon
    +

    a character

    + +
    templateDetailIcon
    +

    a character

    + +
    templateType
    +

    a character

    + + +

    WaveXmd

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    application
    +

    a character

    + +
    dataset
    +

    a character

    + +
    datasetConnector
    +

    a character

    + +
    datasetFullyQualifiedName
    +

    a character

    + +
    dates
    +

    a WaveXmdDate

    + +
    dimensions
    +

    a WaveXmdDimension

    + +
    measures
    +

    a WaveXmdMeasure

    + +
    organizations
    +

    a WaveXmdOrganization

    + +
    origin
    +

    a character

    + +
    type
    +

    a character

    + +
    waveVisualization
    +

    a character

    + + +

    WaveXmdDate

    +
    alias
    +

    a character

    + +
    compact
    +

    a character either 'true' or 'false'

    + +
    dateFieldDay
    +

    a character

    + +
    dateFieldEpochDay
    +

    a character

    + +
    dateFieldEpochSecond
    +

    a character

    + +
    dateFieldFiscalMonth
    +

    a character

    + +
    dateFieldFiscalQuarter
    +

    a character

    + +
    dateFieldFiscalWeek
    +

    a character

    + +
    dateFieldFiscalYear
    +

    a character

    + +
    dateFieldFullYear
    +

    a character

    + +
    dateFieldHour
    +

    a character

    + +
    dateFieldMinute
    +

    a character

    + +
    dateFieldMonth
    +

    a character

    + +
    dateFieldQuarter
    +

    a character

    + +
    dateFieldSecond
    +

    a character

    + +
    dateFieldWeek
    +

    a character

    + +
    dateFieldYear
    +

    a character

    + +
    description
    +

    a character

    + +
    firstDayOfWeek
    +

    an integer

    + +
    fiscalMonthOffset
    +

    an integer

    + +
    isYearEndFiscalYear
    +

    a character either 'true' or 'false'

    + +
    label
    +

    a character

    + +
    showInExplorer
    +

    a character either 'true' or 'false'

    + +
    sortIndex
    +

    an integer

    + + +

    WaveXmdDimension

    +
    customActions
    +

    a WaveXmdDimensionCustomAction

    + +
    customActionsEnabled
    +

    a character either 'true' or 'false'

    + +
    dateFormat
    +

    a character

    + +
    description
    +

    a character

    + +
    field
    +

    a character

    + +
    fullyQualifiedName
    +

    a character

    + +
    imageTemplate
    +

    a character

    + +
    isDerived
    +

    a character either 'true' or 'false'

    + +
    isMultiValue
    +

    a character either 'true' or 'false'

    + +
    label
    +

    a character

    + +
    linkTemplate
    +

    a character

    + +
    linkTemplateEnabled
    +

    a character either 'true' or 'false'

    + +
    linkTooltip
    +

    a character

    + +
    members
    +

    a WaveXmdDimensionMember

    + +
    origin
    +

    a character

    + +
    recordDisplayFields
    +

    a WaveXmdRecordDisplayLookup

    + +
    recordIdField
    +

    a character

    + +
    recordOrganizationIdField
    +

    a character

    + +
    salesforceActions
    +

    a WaveXmdDimensionSalesforceAction

    + +
    salesforceActionsEnabled
    +

    a character either 'true' or 'false'

    + +
    showDetailsDefaultFieldIndex
    +

    an integer

    + +
    showInExplorer
    +

    a character either 'true' or 'false'

    + +
    sortIndex
    +

    an integer

    + + +

    WaveXmdDimensionCustomAction

    +
    customActionName
    +

    a character

    + +
    enabled
    +

    a character either 'true' or 'false'

    + +
    icon
    +

    a character

    + +
    method
    +

    a character

    + +
    sortIndex
    +

    an integer

    + +
    target
    +

    a character

    + +
    tooltip
    +

    a character

    + +
    url
    +

    a character

    + + +

    WaveXmdDimensionMember

    +
    color
    +

    a character

    + +
    label
    +

    a character

    + +
    member
    +

    a character

    + +
    sortIndex
    +

    an integer

    + + +

    WaveXmdDimensionSalesforceAction

    +
    enabled
    +

    a character either 'true' or 'false'

    + +
    salesforceActionName
    +

    a character

    + +
    sortIndex
    +

    an integer

    + + +

    WaveXmdMeasure

    +
    dateFormat
    +

    a character

    + +
    description
    +

    a character

    + +
    field
    +

    a character

    + +
    formatCustomFormat
    +

    a character

    + +
    formatDecimalDigits
    +

    an integer

    + +
    formatIsNegativeParens
    +

    a character either 'true' or 'false'

    + +
    formatPrefix
    +

    a character

    + +
    formatSuffix
    +

    a character

    + +
    formatUnit
    +

    a character

    + +
    formatUnitMultiplier
    +

    a numeric

    + +
    fullyQualifiedName
    +

    a character

    + +
    isDerived
    +

    a character either 'true' or 'false'

    + +
    label
    +

    a character

    + +
    origin
    +

    a character

    + +
    showDetailsDefaultFieldIndex
    +

    an integer

    + +
    showInExplorer
    +

    a character either 'true' or 'false'

    + +
    sortIndex
    +

    an integer

    + + +

    WaveXmdOrganization

    +
    instanceUrl
    +

    a character

    + +
    label
    +

    a character

    + +
    organizationIdentifier
    +

    a character

    + +
    sortIndex
    +

    an integer

    + + +

    WaveXmdRecordDisplayLookup

    +
    recordDisplayField
    +

    a character

    + + +

    WebLink

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    availability
    +

    a WebLinkAvailability - which is a character taking one of the following values:

    • online

    • offline

      • -

    -
    description

    a character

    -
    displayType

    a WebLinkDisplayType - which is a character taking one of the following values: -

      -

    • link

      • +
    + +
    description
    +

    a character

    + +
    displayType
    +

    a WebLinkDisplayType - which is a character taking one of the following values:

    • link

    • button

    • massActionButton

      • -

    -
    encodingKey

    a Encoding - which is a character taking one of the following values: -

      -

    • UTF-8

      • +
    + +
    encodingKey
    +

    a Encoding - which is a character taking one of the following values:

    • UTF-8

    • ISO-8859-1

    • Shift_JIS

    • ISO-2022-JP

      • @@ -10128,129 +14731,187 @@

      Details

    • GB2312

    • Big5-HKSCS

    • x-SJIS_0213

      • -

    -
    hasMenubar

    a character either 'true' or 'false'

    -
    hasScrollbars

    a character either 'true' or 'false'

    -
    hasToolbar

    a character either 'true' or 'false'

    -
    height

    an integer

    -
    isResizable

    a character either 'true' or 'false'

    -
    linkType

    a WebLinkType - which is a character taking one of the following values: -

      -

    • url

      • +
    + +
    hasMenubar
    +

    a character either 'true' or 'false'

    + +
    hasScrollbars
    +

    a character either 'true' or 'false'

    + +
    hasToolbar
    +

    a character either 'true' or 'false'

    + +
    height
    +

    an integer

    + +
    isResizable
    +

    a character either 'true' or 'false'

    + +
    linkType
    +

    a WebLinkType - which is a character taking one of the following values:

    • url

    • sControl

    • javascript

    • page

    • flow

      • -

    -
    masterLabel

    a character

    -
    openType

    a WebLinkWindowType - which is a character taking one of the following values: -

      -

    • newWindow

      • +
    + +
    masterLabel
    +

    a character

    + +
    openType
    +

    a WebLinkWindowType - which is a character taking one of the following values:

    • newWindow

    • sidebar

    • noSidebar

    • replace

    • onClickJavaScript

      • -

    -
    page

    a character

    -
    position

    a WebLinkPosition - which is a character taking one of the following values: -

      -

    • fullScreen

      • +
    + +
    page
    +

    a character

    + +
    position
    +

    a WebLinkPosition - which is a character taking one of the following values:

    • fullScreen

    • none

    • topLeft

      • -

    -
    protected

    a character either 'true' or 'false'

    -
    requireRowSelection

    a character either 'true' or 'false'

    -
    scontrol

    a character

    -
    showsLocation

    a character either 'true' or 'false'

    -
    showsStatus

    a character either 'true' or 'false'

    -
    url

    a character

    -
    width

    an integer

    - -
    - -

    WebLinkTranslation

    -
    -
    label

    a character

    -
    name

    a character

    - -
    - -

    WebToCaseSettings

    -
    -
    caseOrigin

    a character

    -
    defaultResponseTemplate

    a character

    -
    enableWebToCase

    a character either 'true' or 'false'

    - -
    - -

    WeightedSourceCategory

    -
    -
    sourceCategoryApiName

    a character

    -
    weight

    a numeric

    - -
    - -

    Workflow

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    alerts

    a WorkflowAlert

    -
    fieldUpdates

    a WorkflowFieldUpdate

    -
    flowActions

    a WorkflowFlowAction

    -
    knowledgePublishes

    a WorkflowKnowledgePublish

    -
    outboundMessages

    a WorkflowOutboundMessage

    -
    rules

    a WorkflowRule

    -
    send

    a WorkflowSend

    -
    tasks

    a WorkflowTask

    - -
    - -

    WorkflowAction

    -
    -
    fullName

    a character (inherited from Metadata)

    - -
    - -

    WorkflowActionReference

    -
    -
    name

    a character

    -
    type

    a WorkflowActionType - which is a character taking one of the following values: -

      -

    • FieldUpdate

      • +
    + +
    protected
    +

    a character either 'true' or 'false'

    + +
    requireRowSelection
    +

    a character either 'true' or 'false'

    + +
    scontrol
    +

    a character

    + +
    showsLocation
    +

    a character either 'true' or 'false'

    + +
    showsStatus
    +

    a character either 'true' or 'false'

    + +
    url
    +

    a character

    + +
    width
    +

    an integer

    + + +

    WebLinkTranslation

    +
    label
    +

    a character

    + +
    name
    +

    a character

    + + +

    WebToCaseSettings

    +
    caseOrigin
    +

    a character

    + +
    defaultResponseTemplate
    +

    a character

    + +
    enableWebToCase
    +

    a character either 'true' or 'false'

    + + +

    WeightedSourceCategory

    +
    sourceCategoryApiName
    +

    a character

    + +
    weight
    +

    a numeric

    + + +

    Workflow

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    alerts
    +

    a WorkflowAlert

    + +
    fieldUpdates
    +

    a WorkflowFieldUpdate

    + +
    flowActions
    +

    a WorkflowFlowAction

    + +
    knowledgePublishes
    +

    a WorkflowKnowledgePublish

    + +
    outboundMessages
    +

    a WorkflowOutboundMessage

    + +
    rules
    +

    a WorkflowRule

    + +
    send
    +

    a WorkflowSend

    + +
    tasks
    +

    a WorkflowTask

    + + +

    WorkflowAction

    +
    fullName
    +

    a character (inherited from Metadata)

    + + +

    WorkflowActionReference

    +
    name
    +

    a character

    + +
    type
    +

    a WorkflowActionType - which is a character taking one of the following values:

    • FieldUpdate

    • KnowledgePublish

    • Task

    • Alert

    • Send

    • OutboundMessage

    • FlowAction

      • -

    - -
    - -

    WorkflowAlert

    -
    -
    extends WorkflowAction

    see documentation for WorkflowAction

    -
    ccEmails

    a character

    -
    description

    a character

    -
    protected

    a character either 'true' or 'false'

    -
    recipients

    a WorkflowEmailRecipient

    -
    senderAddress

    a character

    -
    senderType

    a ActionEmailSenderType - which is a character taking one of the following values: -

      -

    • CurrentUser

      • +
    + + +

    WorkflowAlert

    +
    extends WorkflowAction
    +

    see documentation for WorkflowAction

    + +
    ccEmails
    +

    a character

    + +
    description
    +

    a character

    + +
    protected
    +

    a character either 'true' or 'false'

    + +
    recipients
    +

    a WorkflowEmailRecipient

    + +
    senderAddress
    +

    a character

    + +
    senderType
    +

    a ActionEmailSenderType - which is a character taking one of the following values:

    • CurrentUser

    • OrgWideEmailAddress

    • DefaultWorkflowUser

      • -

    -
    template

    a character

    - -
    - -

    WorkflowEmailRecipient

    -
    -
    field

    a character

    -
    recipient

    a character

    -
    type

    a ActionEmailRecipientTypes - which is a character taking one of the following values: -

      -

    • group

      • +
    + +
    template
    +

    a character

    + + +

    WorkflowEmailRecipient

    +
    field
    +

    a character

    + +
    recipient
    +

    a character

    + +
    type
    +

    a ActionEmailRecipientTypes - which is a character taking one of the following values:

    • group

    • role

    • user

    • opportunityTeam

      • @@ -10269,116 +14930,175 @@

      Details

    • email

    • caseTeam

    • campaignMemberDerivedOwner

      • -

    - -
    - -

    WorkflowFieldUpdate

    -
    -
    extends WorkflowAction

    see documentation for WorkflowAction

    -
    description

    a character

    -
    field

    a character

    -
    formula

    a character

    -
    literalValue

    a character

    -
    lookupValue

    a character

    -
    lookupValueType

    a LookupValueType - which is a character taking one of the following values: -

      -

    • User

      • +
    + + +

    WorkflowFieldUpdate

    +
    extends WorkflowAction
    +

    see documentation for WorkflowAction

    + +
    description
    +

    a character

    + +
    field
    +

    a character

    + +
    formula
    +

    a character

    + +
    literalValue
    +

    a character

    + +
    lookupValue
    +

    a character

    + +
    lookupValueType
    +

    a LookupValueType - which is a character taking one of the following values:

    • User

    • Queue

    • RecordType

      • -

    -
    name

    a character

    -
    notifyAssignee

    a character either 'true' or 'false'

    -
    operation

    a FieldUpdateOperation - which is a character taking one of the following values: -

      -

    • Formula

      • +
    + +
    name
    +

    a character

    + +
    notifyAssignee
    +

    a character either 'true' or 'false'

    + +
    operation
    +

    a FieldUpdateOperation - which is a character taking one of the following values:

    • Formula

    • Literal

    • Null

    • NextValue

    • PreviousValue

    • LookupValue

      • -

    -
    protected

    a character either 'true' or 'false'

    -
    reevaluateOnChange

    a character either 'true' or 'false'

    -
    targetObject

    a character

    - -
    - -

    WorkflowFlowAction

    -
    -
    extends WorkflowAction

    see documentation for WorkflowAction

    -
    description

    a character

    -
    flow

    a character

    -
    flowInputs

    a WorkflowFlowActionParameter

    -
    label

    a character

    -
    language

    a character

    -
    protected

    a character either 'true' or 'false'

    - -
    - -

    WorkflowFlowActionParameter

    -
    -
    name

    a character

    -
    value

    a character

    - -
    - -

    WorkflowKnowledgePublish

    -
    -
    extends WorkflowAction

    see documentation for WorkflowAction

    -
    action

    a KnowledgeWorkflowAction - which is a character taking one of the following values: -

      -

    • PublishAsNew

      • +
    + +
    protected
    +

    a character either 'true' or 'false'

    + +
    reevaluateOnChange
    +

    a character either 'true' or 'false'

    + +
    targetObject
    +

    a character

    + + +

    WorkflowFlowAction

    +
    extends WorkflowAction
    +

    see documentation for WorkflowAction

    + +
    description
    +

    a character

    + +
    flow
    +

    a character

    + +
    flowInputs
    +

    a WorkflowFlowActionParameter

    + +
    label
    +

    a character

    + +
    language
    +

    a character

    + +
    protected
    +

    a character either 'true' or 'false'

    + + +

    WorkflowFlowActionParameter

    +
    name
    +

    a character

    + +
    value
    +

    a character

    + + +

    WorkflowKnowledgePublish

    +
    extends WorkflowAction
    +

    see documentation for WorkflowAction

    + +
    action
    +

    a KnowledgeWorkflowAction - which is a character taking one of the following values:

    • PublishAsNew

    • Publish

      • -

    -
    description

    a character

    -
    label

    a character

    -
    language

    a character

    -
    protected

    a character either 'true' or 'false'

    - -
    - -

    WorkflowRule

    -
    -
    fullName

    a character (inherited from Metadata)

    -
    actions

    a WorkflowActionReference

    -
    active

    a character either 'true' or 'false'

    -
    booleanFilter

    a character

    -
    criteriaItems

    a FilterItem

    -
    description

    a character

    -
    formula

    a character

    -
    triggerType

    a WorkflowTriggerTypes - which is a character taking one of the following values: -

      -

    • onCreateOnly

      • +
    + +
    description
    +

    a character

    + +
    label
    +

    a character

    + +
    language
    +

    a character

    + +
    protected
    +

    a character either 'true' or 'false'

    + + +

    WorkflowRule

    +
    fullName
    +

    a character (inherited from Metadata)

    + +
    actions
    +

    a WorkflowActionReference

    + +
    active
    +

    a character either 'true' or 'false'

    + +
    booleanFilter
    +

    a character

    + +
    criteriaItems
    +

    a FilterItem

    + +
    description
    +

    a character

    + +
    formula
    +

    a character

    + +
    triggerType
    +

    a WorkflowTriggerTypes - which is a character taking one of the following values:

    • onCreateOnly

    • onCreateOrTriggeringUpdate

    • onAllChanges

    • OnRecursiveUpdate

      • -

    -
    workflowTimeTriggers

    a WorkflowTimeTrigger

    + -
    +
    workflowTimeTriggers
    +

    a WorkflowTimeTrigger

    -

    WorkflowSend

    -
    -
    extends WorkflowAction

    see documentation for WorkflowAction

    -
    action

    a SendAction - which is a character taking one of the following values: -

      -

    • Send

      • -

    -
    description

    a character

    -
    label

    a character

    -
    language

    a character

    -
    protected

    a character either 'true' or 'false'

    - -
    - -

    WorkflowTask

    -
    -
    extends WorkflowAction

    see documentation for WorkflowAction

    -
    assignedTo

    a character

    -
    assignedToType

    a ActionTaskAssignedToTypes - which is a character taking one of the following values: -

      -

    • user

      • + +

    WorkflowSend

    +
    extends WorkflowAction
    +

    see documentation for WorkflowAction

    + +
    action
    +

    a SendAction - which is a character taking one of the following values:

    • Send

      • +
    + +
    description
    +

    a character

    + +
    label
    +

    a character

    + +
    language
    +

    a character

    + +
    protected
    +

    a character either 'true' or 'false'

    + + +

    WorkflowTask

    +
    extends WorkflowAction
    +

    see documentation for WorkflowAction

    + +
    assignedTo
    +

    a character

    + +
    assignedToType
    +

    a ActionTaskAssignedToTypes - which is a character taking one of the following values:

    • user

    • role

    • opportunityTeam

    • accountTeam

      • @@ -10388,75 +15108,93 @@

      Details

    • accountCreator

    • partnerUser

    • portalRole

      • -

    -
    description

    a character

    -
    dueDateOffset

    an integer

    -
    notifyAssignee

    a character either 'true' or 'false'

    -
    offsetFromField

    a character

    -
    priority

    a character

    -
    protected

    a character either 'true' or 'false'

    -
    status

    a character

    -
    subject

    a character

    - -
    - -

    WorkflowTaskTranslation

    -
    -
    description

    a character

    -
    name

    a character

    -
    subject

    a character

    - -
    - -

    WorkflowTimeTrigger

    -
    -
    actions

    a WorkflowActionReference

    -
    offsetFromField

    a character

    -
    timeLength

    a character

    -
    workflowTimeTriggerUnit

    a WorkflowTimeUnits - which is a character taking one of the following values: -

      -

    • Hours

      • +
    + +
    description
    +

    a character

    + +
    dueDateOffset
    +

    an integer

    + +
    notifyAssignee
    +

    a character either 'true' or 'false'

    + +
    offsetFromField
    +

    a character

    + +
    priority
    +

    a character

    + +
    protected
    +

    a character either 'true' or 'false'

    + +
    status
    +

    a character

    + +
    subject
    +

    a character

    + + +

    WorkflowTaskTranslation

    +
    description
    +

    a character

    + +
    name
    +

    a character

    + +
    subject
    +

    a character

    + + +

    WorkflowTimeTrigger

    +
    actions
    +

    a WorkflowActionReference

    + +
    offsetFromField
    +

    a character

    + +
    timeLength
    +

    a character

    + +
    workflowTimeTriggerUnit
    +

    a WorkflowTimeUnits - which is a character taking one of the following values:

    • Hours

    • Days

      • -

    + + -
    +

    WorkspaceMapping

    +
    fieldName
    +

    a character

    -

    WorkspaceMapping

    -
    -
    fieldName

    a character

    -
    tab

    a character

    +
    tab
    +

    a character

    -
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/parameterized_search_control.html b/docs/reference/parameterized_search_control.html index a8c0d431..81769ce6 100644 --- a/docs/reference/parameterized_search_control.html +++ b/docs/reference/parameterized_search_control.html @@ -1,92 +1,19 @@ - - - - - - - -Auxiliary for Controlling Parametrized Searches — parameterized_search_control • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Auxiliary for Controlling Parametrized Searches — parameterized_search_control • salesforcer - - - - - - - - + + -
    -
    -

    Auxiliary for Controlling Parametrized Searches

    - Source: R/search.R + Source: R/search.R
    @@ -190,98 +107,85 @@

    Auxiliary for Controlling Parametrized Searches

    when not using SOSL

    - 
    parameterized_search_control(
-  objects = NULL,
-  fields_scope = c("ALL", "NAME", "EMAIL", "PHONE", "SIDEBAR"),
-  fields = NULL,
-  overall_limit = 2000,
-  default_limit = 200,
-  spell_correction = TRUE
-)
    +
    + 
    parameterized_search_control(
+  objects = NULL,
+  fields_scope = c("ALL", "NAME", "EMAIL", "PHONE", "SIDEBAR"),
+  fields = NULL,
+  overall_limit = 2000,
+  default_limit = 200,
+  spell_correction = TRUE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    objects

    character; objects to search and return in the response. Multiple -objects can be provided as a character vector

    fields_scope

    character; scope of fields to search in order to limit the resources -used and improve performance

    fields

    character; one or more fields to return in the response for each +

    +

    Arguments

    +
    objects
    +

    character; objects to search and return in the response. Multiple +objects can be provided as a character vector

    +
    fields_scope
    +

    character; scope of fields to search in order to limit the resources +used and improve performance

    +
    fields
    +

    character; one or more fields to return in the response for each sobject specified. If no fields are specified only the Ids of the matching records -are returned.

    overall_limit

    numeric; the maximum number of results to return across -all objects in the search.

    default_limit

    numeric; the maximum number of results to return for +are returned.

    +
    overall_limit
    +

    numeric; the maximum number of results to return across +all objects in the search.

    +
    default_limit
    +

    numeric; the maximum number of results to return for each of the specified objects. This parameter is ignored if the objects argument -is left NULL.

    spell_correction

    logical; specifies whether spell correction should be -enabled for a user’s search.

    - -

    Value

    - +is left NULL.

    +
    spell_correction
    +

    logical; specifies whether spell correction should be +enabled for a user’s search.

    +
    + + -

    Examples

    - 
    if (FALSE) {
-# free text search only on Contact record Phone fields
-# this will improve the performance of the search
-my_phone_search <- "(336)"
-search_result <- sf_search(my_phone_search,
-                           objects = c("Contact", "Lead"),
-                           fields_scope = "PHONE",
-                           fields = c("Id", "FirstName", "LastName"))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# free text search only on Contact record Phone fields
+# this will improve the performance of the search
+my_phone_search <- "(336)"
+search_result <- sf_search(my_phone_search,
+                           objects = c("Contact", "Lead"),
+                           fields_scope = "PHONE",
+                           fields = c("Id", "FirstName", "LastName"))
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/parse_error_code_and_message.html b/docs/reference/parse_error_code_and_message.html index 28b3b843..c9472f8d 100644 --- a/docs/reference/parse_error_code_and_message.html +++ b/docs/reference/parse_error_code_and_message.html @@ -1,91 +1,18 @@ - - - - - - - -Function to parse out the message and status code of an HTTP error — parse_error_code_and_message • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Function to parse out the message and status code of an HTTP error — parse_error_code_and_message • salesforcer - - - - - - - - + + -
    -
    -

    Function to parse out the message and status code of an HTTP error

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,41 +105,47 @@

    Function to parse out the message and status code of an HTTP error

    Assuming the error code is less than 500, this function will return the

    - 
    parse_error_code_and_message(x)
    - - -

    Note

    +
    + 
    parse_error_code_and_message(x)
    +
    +
    +

    Arguments

    +
    x
    +

    response(); a response that indicates an error

    +
    +
    +

    Value

    +

    list; a list containing the error code and message for printing.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/parse_report_detail_rows.html b/docs/reference/parse_report_detail_rows.html index 48110522..d8c5242f 100644 --- a/docs/reference/parse_report_detail_rows.html +++ b/docs/reference/parse_report_detail_rows.html @@ -1,93 +1,20 @@ - - - - - - - -Format the detailed data from the "T!T" fact map in a tabular report — parse_report_detail_rows • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Format the detailed data from the "T!T" fact map in a tabular report — parse_report_detail_rows • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Format the detailed data from the "T!T" fact map in a tabular report

    - Source: R/utils-report.R + Source: R/utils-report.R
    @@ -192,118 +109,113 @@

    Format the detailed data from the "T!T" fact map in a tabular report

    columns of the report without any filters, aggregates, or totals.

    - 
    parse_report_detail_rows(
-  content,
-  fact_map_key = "T!T",
-  labels = TRUE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated()
-)
    +
    + 
    parse_report_detail_rows(
+  content,
+  fact_map_key = "T!T",
+  labels = TRUE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated()
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    content

    list; the list returned from the content -function that parses the JSON response to a list.

    fact_map_key

    character; string providing an index into each +

    +

    Arguments

    +
    content
    +

    list; the list returned from the content +function that parses the JSON response to a list.

    +
    fact_map_key
    +

    character; string providing an index into each section of a fact map, from which you can access summary and detailed data. The pattern for the fact map keys varies by report format so it is important to know what the reportFormat property of the target report is. See the -note below for more details.

    labels

    logical; an indicator of whether the returned data should +note below for more details.

    +
    labels
    +

    logical; an indicator of whether the returned data should be the label (i.e. formatted value) or the actual value. By default, the labels are returned because these are what appear in the Salesforce dashboard and more closely align with the column names. For example, "Account.Name" label may be "Account B" and the value 0016A0000035mJEQAY. The former -(label) more accurately reflects the "Account.Name".

    guess_types

    logical; indicating whether or not to use col_guess() +(label) more accurately reflects the "Account.Name".

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    - -

    Value

    - +character.

    +
    +
    +

    Value

    tbl_df; a data frame representing the detail rows of a parsed report result HTTP response where the rows represent each row in the report and the columns represent the detail columns.

    -

    Note

    - -

    Below are the fact map key patterns for three report types:

    -
    TABULAR

    T!T: The grand total of a report. Both record data +

    +
    +

    Note

    +

    Below are the fact map key patterns for three report types:

    TABULAR
    +

    T!T: The grand total of a report. Both record data values and the grand total are represented by this key.

    -
    SUMMARY

    <First level row grouping_second level row grouping_third + +

    SUMMARY
    +

    <First level row grouping_second level row grouping_third level row grouping>!T: T refers to the row grand total.

    -
    MATRIX

    <First level row grouping_second level row grouping>!<First + +

    MATRIX
    +

    <First level row grouping_second level row grouping>!<First level column grouping_second level column grouping>.

    -
    -

    Each item in a row or column grouping is numbered starting with 0. Here are +

    Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:

    -
    -
    0!T

    The first item in the first-level grouping.

    -
    1!T

    The second item in the first-level grouping.

    -
    0_0!T

    The first item in the first-level grouping and the first item +

    0!T
    +

    The first item in the first-level grouping.

    + +
    1!T
    +

    The second item in the first-level grouping.

    + +
    0_0!T
    +

    The first item in the first-level grouping and the first item in the second-level grouping.

    -
    0_1!T

    The first item in the first-level grouping and the second item + +

    0_1!T
    +

    The first item in the first-level grouping and the second item in the second-level grouping.

    -
    -

    This function is meant to be used internally. Only use when debugging.

    +

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/patched_tempdir.html b/docs/reference/patched_tempdir.html index 5f91bac4..8e2a6a84 100644 --- a/docs/reference/patched_tempdir.html +++ b/docs/reference/patched_tempdir.html @@ -1,93 +1,20 @@ - - - - - - - -Create a temporary directory path without a double slash — patched_tempdir • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a temporary directory path without a double slash — patched_tempdir • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Create a temporary directory path without a double slash

    - Source: R/utils.R + Source: R/utils.R

    This function fixes a long standing bug in R where the -tempdir function will return a path with an +tempdir function will return a path with an extra slash.

    - 
    patched_tempdir()
    - - -

    Value

    +
    + 
    patched_tempdir()
    +
    +
    +

    Value

    character; a string representing the temp directory path without containing a double slash

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    -

    See also

    - -

    R documentation on environment vars, Stack Overflow - Why does tempdir() adds extra slash...

    +
    + -

    Examples

    - 
    if (FALSE) {
-patched_tempdir()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+patched_tempdir()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rDELETE.html b/docs/reference/rDELETE.html index 21da4752..f73db966 100644 --- a/docs/reference/rDELETE.html +++ b/docs/reference/rDELETE.html @@ -1,91 +1,18 @@ - - - - - - - -DELETEs with retries and authentication — rDELETE • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DELETEs with retries and authentication — rDELETE • salesforcer - - - - - - - - + + -
    -
    -

    DELETEs with retries and authentication

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,41 +105,42 @@

    DELETEs with retries and authentication

    DELETEs with retries and authentication

    - 
    rDELETE(url, headers = character(0), ...)
    - - -

    Note

    +
    + 
    rDELETE(url, headers = character(0), ...)
    +
    +
    +

    Value

    +

    A response() object as defined by the httr package.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rGET.html b/docs/reference/rGET.html index 3d527cf3..35ff7117 100644 --- a/docs/reference/rGET.html +++ b/docs/reference/rGET.html @@ -1,91 +1,18 @@ - - - - - - - -GETs with retries and authentication — rGET • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GETs with retries and authentication — rGET • salesforcer - - - - - - - - + + -
    -
    -

    GETs with retries and authentication

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,41 +105,42 @@

    GETs with retries and authentication

    GETs with retries and authentication

    - 
    rGET(url, headers = character(0), ...)
    - - -

    Note

    +
    + 
    rGET(url, headers = character(0), ...)
    +
    +
    +

    Value

    +

    A response() object as defined by the httr package.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rPATCH.html b/docs/reference/rPATCH.html index d818bd0c..2554813f 100644 --- a/docs/reference/rPATCH.html +++ b/docs/reference/rPATCH.html @@ -1,91 +1,18 @@ - - - - - - - -PATCHs with retries and authentication — rPATCH • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PATCHs with retries and authentication — rPATCH • salesforcer - - - - - - - - + + -
    -
    -

    PATCHs with retries and authentication

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,41 +105,42 @@

    PATCHs with retries and authentication

    PATCHs with retries and authentication

    - 
    rPATCH(url, headers = character(0), ...)
    - - -

    Note

    +
    + 
    rPATCH(url, headers = character(0), ...)
    +
    +
    +

    Value

    +

    A response() object as defined by the httr package.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rPOST.html b/docs/reference/rPOST.html index d1f1277c..e310b89b 100644 --- a/docs/reference/rPOST.html +++ b/docs/reference/rPOST.html @@ -1,91 +1,18 @@ - - - - - - - -POSTs with retries and authentication — rPOST • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -POSTs with retries and authentication — rPOST • salesforcer - - - - - - - - + + -
    -
    -

    POSTs with retries and authentication

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,41 +105,42 @@

    POSTs with retries and authentication

    POSTs with retries and authentication

    - 
    rPOST(url, headers = character(0), ...)
    - - -

    Note

    +
    + 
    rPOST(url, headers = character(0), ...)
    +
    +
    +

    Value

    +

    A response() object as defined by the httr package.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rPUT.html b/docs/reference/rPUT.html index b87bd7bb..5f5acc79 100644 --- a/docs/reference/rPUT.html +++ b/docs/reference/rPUT.html @@ -1,91 +1,18 @@ - - - - - - - -PUTs with retries and authentication — rPUT • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -PUTs with retries and authentication — rPUT • salesforcer - - - - - - - - + + -
    -
    -

    PUTs with retries and authentication

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,41 +105,42 @@

    PUTs with retries and authentication

    PUTs with retries and authentication

    - 
    rPUT(url, headers = character(0), ...)
    - - -

    Note

    +
    + 
    rPUT(url, headers = character(0), ...)
    +
    +
    +

    Value

    +

    A response() object as defined by the httr package.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/records_list_to_tbl.html b/docs/reference/records_list_to_tbl.html index bf63dc80..520cf19f 100644 --- a/docs/reference/records_list_to_tbl.html +++ b/docs/reference/records_list_to_tbl.html @@ -1,94 +1,21 @@ - - - - - - - -Extract tibble based on the "records" element of a list — records_list_to_tbl • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Extract tibble based on the "records" element of a list — records_list_to_tbl • salesforcer - - - - - - - - + + -
    -
    -

    Extract tibble based on the "records" element of a list

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -194,63 +111,54 @@

    Extract tibble based on the "records" element of a list

    and then returned as one complete tbl_df of all records.

    - 
    records_list_to_tbl(x, object_name_append = FALSE, object_name_as_col = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    x

    list; list of records parsed from JSON.

    object_name_append

    logical; whether to include the object type -(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

    object_name_as_col

    logical; whether to include the object type -(e.g. Account or Contact) as a new column.

    - -

    Value

    +
    + 
    records_list_to_tbl(x, object_name_append = FALSE, object_name_as_col = FALSE)
    +
    +
    +

    Arguments

    +
    x
    +

    list; list of records parsed from JSON.

    +
    object_name_append
    +

    logical; whether to include the object type +(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

    +
    object_name_as_col
    +

    logical; whether to include the object type +(e.g. Account or Contact) as a new column.

    +
    +
    +

    Value

    tbl_df a data frame with each row representing a single element from the "records" element of the list.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/remove_empty_linked_object_cols.html b/docs/reference/remove_empty_linked_object_cols.html index 58a05ee4..3965555f 100644 --- a/docs/reference/remove_empty_linked_object_cols.html +++ b/docs/reference/remove_empty_linked_object_cols.html @@ -1,93 +1,20 @@ - - - - - - - -Remove NA Columns Created by Empty Related Entity Values — remove_empty_linked_object_cols • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Remove NA Columns Created by Empty Related Entity Values — remove_empty_linked_object_cols • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Remove NA Columns Created by Empty Related Entity Values

    - Source: R/utils.R + Source: R/utils.R
    @@ -192,52 +109,48 @@

    Remove NA Columns Created by Empty Related Entity Values

    created by records that don't have a relationship at all in that related entity.

    - 
    remove_empty_linked_object_cols(dat, api_type = c("SOAP", "REST"))
    +
    + 
    remove_empty_linked_object_cols(dat, api_type = c("SOAP", "REST"))
    +
    -

    Arguments

    - - - - - - - - - - -
    dat

    data; a tbl_df or data.frame of a returned resultset

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    dat
    +

    data; a tbl_df or data.frame of a returned resultset

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    - +making the request.

    +
    +
    +

    Value

    +

    tbl_df; the passed in data, but with the object columns removed +that are empty links to other objects.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/return_matching_controls.html b/docs/reference/return_matching_controls.html index 3abe02f9..8259ee77 100644 --- a/docs/reference/return_matching_controls.html +++ b/docs/reference/return_matching_controls.html @@ -1,91 +1,18 @@ - - - - - - - -Of All Args Return Ones Matching Control Arguments — return_matching_controls • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Of All Args Return Ones Matching Control Arguments — return_matching_controls • salesforcer - - - - - - - - + + -
    -
    -

    Of All Args Return Ones Matching Control Arguments

    - Source: R/utils-control.R + Source: R/utils-control.R
    @@ -188,41 +105,51 @@

    Of All Args Return Ones Matching Control Arguments

    Of All Args Return Ones Matching Control Arguments

    - 
    return_matching_controls(args)
    - - -

    Note

    +
    + 
    return_matching_controls(args)
    +
    +
    +

    Arguments

    +
    args
    +

    character; a vector of strings that represent the function +arguments.

    +
    +
    +

    Value

    +

    character; a vector of strings returning only the function arguments +that match control arguments so that users can specify them directly in each +function and not have to construct a control object every time in order to +pass only one or two control arguments.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.bulkAction.html b/docs/reference/rforcecom.bulkAction.html index 22e53f9a..1dcf6316 100644 --- a/docs/reference/rforcecom.bulkAction.html +++ b/docs/reference/rforcecom.bulkAction.html @@ -1,94 +1,21 @@ - - - - - - - -The salesforcer backwards compatible version of the RForcecom function -rforcecom.bulkAction — rforcecom.bulkAction • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of the RForcecom function +rforcecom.bulkAction — rforcecom.bulkAction • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of the RForcecom function rforcecom.bulkAction

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    This function is a convenience wrapper for submitting bulk API jobs

    - 
    rforcecom.bulkAction(
-  session,
-  operation = c("insert", "delete", "upsert", "update", "hardDelete"),
-  data,
-  object,
-  external_id_fieldname = NULL,
-  multiBatch = TRUE,
-  batchSize = 10000,
-  interval_seconds = 5,
-  max_attempts = 100,
-  verbose = FALSE
-)
    +
    + 
    rforcecom.bulkAction(
+  session,
+  operation = c("insert", "delete", "upsert", "update", "hardDelete"),
+  data,
+  object,
+  external_id_fieldname = NULL,
+  multiBatch = TRUE,
+  batchSize = 10000,
+  interval_seconds = 5,
+  max_attempts = 100,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    operation

    a character string defining the type of operation being performed

    data

    a matrix or data.frame that can be coerced into a CSV file for submitting as batch request

    object

    a character string defining the target salesforce object that the operation will be performed on

    external_id_fieldname

    character; string identifying a custom field on the +necessary to pass the session in each function call.

    +
    operation
    +

    a character string defining the type of operation being performed

    +
    data
    +

    a matrix or data.frame that can be coerced into a CSV file for submitting as batch request

    +
    object
    +

    a character string defining the target salesforce object that the operation will be performed on

    +
    external_id_fieldname
    +

    character; string identifying a custom field on the object that has been set as an "External ID" field. This field is used to reference -objects during upserts to determine if the record already exists in Salesforce or not.

    multiBatch

    a boolean value defining whether or not submit data in batches to the API

    batchSize

    an integer value defining the number of records to submit if multiBatch is true. -The max value is 10,000 in accordance with Salesforce limits.

    interval_seconds

    an integer defining the seconds between attempts to check for job completion

    max_attempts

    an integer defining then max number attempts to check for job completion before stopping

    verbose

    logical; an indicator of whether to print additional +objects during upserts to determine if the record already exists in Salesforce or not.

    +
    multiBatch
    +

    a boolean value defining whether or not submit data in batches to the API

    +
    batchSize
    +

    an integer value defining the number of records to submit if multiBatch is true. +The max value is 10,000 in accordance with Salesforce limits.

    +
    interval_seconds
    +

    an integer defining the seconds between attempts to check for job completion

    +
    max_attempts
    +

    an integer defining then max number attempts to check for job completion before stopping

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of the results of the bulk job

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-# update Account object
-updates <- rforcecom.bulkAction(session, 
-                                operation = 'update', 
-                                data = my_data, 
-                                object = 'Account')
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# update Account object
+updates <- rforcecom.bulkAction(session, 
+                                operation = 'update', 
+                                data = my_data, 
+                                object = 'Account')
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.bulkQuery.html b/docs/reference/rforcecom.bulkQuery.html index 00807db8..6db65e60 100644 --- a/docs/reference/rforcecom.bulkQuery.html +++ b/docs/reference/rforcecom.bulkQuery.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.bulkQuery — rforcecom.bulkQuery • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.bulkQuery — rforcecom.bulkQuery • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.bulkQuery

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.bulkQuery(
-  session,
-  soqlQuery,
-  object,
-  interval_seconds = 5,
-  max_attempts = 100,
-  verbose = FALSE
-)
    +
    + 
    rforcecom.bulkQuery(
+  session,
+  soqlQuery,
+  object,
+  interval_seconds = 5,
+  max_attempts = 100,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    soqlQuery

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    object

    character; the name of one Salesforce objects that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c")

    interval_seconds

    an integer defining the seconds between attempts to check for job completion

    max_attempts

    an integer defining then max number attempts to check for job completion before stopping

    verbose

    logical; an indicator of whether to print additional +necessary to pass the session in each function call.

    +
    soqlQuery
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    object
    +

    character; the name of one Salesforce objects that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c")

    +
    interval_seconds
    +

    an integer defining the seconds between attempts to check for job completion

    +
    max_attempts
    +

    an integer defining then max number attempts to check for job completion before stopping

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A data.frame of the recordset returned by query

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.create.html b/docs/reference/rforcecom.create.html index 30628722..d97907b9 100644 --- a/docs/reference/rforcecom.create.html +++ b/docs/reference/rforcecom.create.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.create — rforcecom.create • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.create — rforcecom.create • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.create

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.create(session, objectName, fields)
    +
    + 
    rforcecom.create(session, objectName, fields)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    objectName

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    fields

    Field names and values. (ex: Name="CompanyName", Phone="000-000-000" )

    - -

    Value

    - +necessary to pass the session in each function call.

    +
    objectName
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    fields
    +

    Field names and values. (ex: Name="CompanyName", Phone="000-000-000" )

    +
    +
    +

    Value

    data.frame containing the id and success indicator of the record creation process

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.delete.html b/docs/reference/rforcecom.delete.html index ef83f45c..97d316e0 100644 --- a/docs/reference/rforcecom.delete.html +++ b/docs/reference/rforcecom.delete.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.delete — rforcecom.delete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.delete — rforcecom.delete • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.delete

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.delete(session, objectName, id)
    +
    + 
    rforcecom.delete(session, objectName, id)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    objectName

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    id

    Record ID to delete. (ex: "999x000000xxxxxZZZ")

    - -

    Value

    - +necessary to pass the session in each function call.

    +
    objectName
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    id
    +

    Record ID to delete. (ex: "999x000000xxxxxZZZ")

    +
    +
    +

    Value

    NULL if successful otherwise the function errors out

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.getObjectDescription.html b/docs/reference/rforcecom.getObjectDescription.html index c7e019a5..6a437f31 100644 --- a/docs/reference/rforcecom.getObjectDescription.html +++ b/docs/reference/rforcecom.getObjectDescription.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.getObjectDescription — rforcecom.getObjectDescription • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.getObjectDescription — rforcecom.getObjectDescription • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.getObjectDescription

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.getObjectDescription(session, objectName)
    +
    + 
    rforcecom.getObjectDescription(session, objectName)
    +
    -

    Arguments

    - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    objectName

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    - -

    Value

    - +necessary to pass the session in each function call.

    +
    objectName
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    +
    +

    Value

    Object descriptions

    -

    Note

    - +
    +
    +

    Note

    This function returns a data.frame with one row per field for an object.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.getServerTimestamp.html b/docs/reference/rforcecom.getServerTimestamp.html index d311578b..baa73abe 100644 --- a/docs/reference/rforcecom.getServerTimestamp.html +++ b/docs/reference/rforcecom.getServerTimestamp.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.getServerTimestamp — rforcecom.getServerTimestamp • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.getServerTimestamp — rforcecom.getServerTimestamp • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.getServerTimestamp

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.getServerTimestamp(session)
    +
    + 
    rforcecom.getServerTimestamp(session)
    +
    -

    Arguments

    - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    - +necessary to pass the session in each function call.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.login.html b/docs/reference/rforcecom.login.html index 57f68630..92d8fed5 100644 --- a/docs/reference/rforcecom.login.html +++ b/docs/reference/rforcecom.login.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.login — rforcecom.login • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.login — rforcecom.login • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.login

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.login(
-  username,
-  password,
-  loginURL = "https://login.salesforce.com/",
-  apiVersion = "35.0"
-)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    username

    Your username for login to the Salesforce.com. In many cases, username is your E-mail address.

    password

    Your password for login to the Salesforce.com. Note: DO NOT FORGET your Security Token. (Ex.) If your password is "Pass1234" and your security token is "XYZXYZXYZXYZ", you should set "Pass1234XYZXYZXYZXYZ".

    loginURL

    (optional) Login URL. If your environment is sandbox specify (ex:) "https://test.salesforce.com/".

    apiVersion

    (optional) Version of the REST API and SOAP API that you want to use. (ex:) "35.0" Supported versions from v20.0 and up.

    - -

    Value

    - - - -
    sessionID

    Session ID.

    -
    instanceURL

    Instance URL.

    -
    apiVersion

    API Version.

    +
    + 
    rforcecom.login(
+  username,
+  password,
+  loginURL = "https://login.salesforce.com/",
+  apiVersion = "35.0"
+)
    +
    +
    +

    Arguments

    +
    username
    +

    Your username for login to the Salesforce.com. In many cases, username is your E-mail address.

    +
    password
    +

    Your password for login to the Salesforce.com. Note: DO NOT FORGET your Security Token. (Ex.) If your password is "Pass1234" and your security token is "XYZXYZXYZXYZ", you should set "Pass1234XYZXYZXYZXYZ".

    +
    loginURL
    +

    (optional) Login URL. If your environment is sandbox specify (ex:) "https://test.salesforce.com".

    +
    apiVersion
    +

    (optional) Version of the REST API and SOAP API that you want to use. (ex:) "35.0" Supported versions from v20.0 and up.

    +
    +
    +

    Value

    +
    sessionID
    +

    Session ID.

    +
    instanceURL
    +

    Instance URL.

    +
    apiVersion
    +

    API Version.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.query.html b/docs/reference/rforcecom.query.html index f89d8b82..2796fa82 100644 --- a/docs/reference/rforcecom.query.html +++ b/docs/reference/rforcecom.query.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.query — rforcecom.query • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.query — rforcecom.query • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.query

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.query(session, soqlQuery, queryAll = FALSE)
    +
    + 
    rforcecom.query(session, soqlQuery, queryAll = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    soqlQuery

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    queryAll

    logical; indicating if the query recordset should include -deleted and archived records (available only when querying Task and Event records)

    - -

    Value

    - +necessary to pass the session in each function call.

    +
    soqlQuery
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    queryAll
    +

    logical; indicating if the query recordset should include +deleted and archived records (available only when querying Task and Event records)

    +
    +
    +

    Value

    Result dataset.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.retrieve.html b/docs/reference/rforcecom.retrieve.html index de98d344..3beb7715 100644 --- a/docs/reference/rforcecom.retrieve.html +++ b/docs/reference/rforcecom.retrieve.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.retrieve — rforcecom.retrieve • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.retrieve — rforcecom.retrieve • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.retrieve

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.retrieve(
-  session,
-  objectName,
-  fields,
-  limit = NULL,
-  id = NULL,
-  offset = NULL,
-  order = NULL,
-  inverse = NULL,
-  nullsLast = NULL
-)
    +
    + 
    rforcecom.retrieve(
+  session,
+  objectName,
+  fields,
+  limit = NULL,
+  id = NULL,
+  offset = NULL,
+  order = NULL,
+  inverse = NULL,
+  nullsLast = NULL
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    objectName

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    fields

    A List of field names. (ex: c("Id", "Name", "Industry", -"AnnualRevenue)"))

    limit

    Number of the records to retrieve. (ex: 5)

    id

    Record ID to retrieve. (ex: "999x000000xxxxxZZZ")

    offset

    Specifies the starting row offset. (ex: "100")

    order

    A list for controlling the order of query results. -(ex: "c("Industry","Name")")

    inverse

    If it is TRUE, the results are ordered in descending order. -This parameter works when order parameter has been set. (Default: FALSE)

    nullsLast

    If it is TRUE, null records list in last. If not null records +necessary to pass the session in each function call.

    +
    objectName
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    fields
    +

    A List of field names. (ex: c("Id", "Name", "Industry", +"AnnualRevenue)"))

    +
    limit
    +

    Number of the records to retrieve. (ex: 5)

    +
    id
    +

    Record ID to retrieve. (ex: "999x000000xxxxxZZZ")

    +
    offset
    +

    Specifies the starting row offset. (ex: "100")

    +
    order
    +

    A list for controlling the order of query results. +(ex: "c("Industry","Name")")

    +
    inverse
    +

    If it is TRUE, the results are ordered in descending order. +This parameter works when order parameter has been set. (Default: FALSE)

    +
    nullsLast
    +

    If it is TRUE, null records list in last. If not null records list in first. This parameter works when order parameter has been set. -(Default: FALSE)

    - +(Default: FALSE)

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.search.html b/docs/reference/rforcecom.search.html index 211a9d42..71e3f0c2 100644 --- a/docs/reference/rforcecom.search.html +++ b/docs/reference/rforcecom.search.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.search — rforcecom.search • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.search — rforcecom.search • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.search

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.search(session, queryString)
    +
    + 
    rforcecom.search(session, queryString)
    +
    -

    Arguments

    - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    queryString

    Query strings to search. (ex: "United", "Electoronics")

    - +necessary to pass the session in each function call.

    +
    queryString
    +

    Query strings to search. (ex: "United", "Electoronics")

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.update.html b/docs/reference/rforcecom.update.html index 828b0540..44381ff8 100644 --- a/docs/reference/rforcecom.update.html +++ b/docs/reference/rforcecom.update.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.update — rforcecom.update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.update — rforcecom.update • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.update

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.update(session, objectName, id, fields)
    +
    + 
    rforcecom.update(session, objectName, id, fields)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    objectName

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    id

    Record ID to update. (ex: "999x000000xxxxxZZZ")

    fields

    Field names and values. (ex: Name="CompanyName", Phone="000-000-000" )

    - -

    Value

    - +necessary to pass the session in each function call.

    +
    objectName
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    id
    +

    Record ID to update. (ex: "999x000000xxxxxZZZ")

    +
    fields
    +

    Field names and values. (ex: Name="CompanyName", Phone="000-000-000" )

    +
    +
    +

    Value

    NULL if successful otherwise the function errors out

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/rforcecom.upsert.html b/docs/reference/rforcecom.upsert.html index 45475005..b754c94a 100644 --- a/docs/reference/rforcecom.upsert.html +++ b/docs/reference/rforcecom.upsert.html @@ -1,93 +1,20 @@ - - - - - - - -The salesforcer backwards compatible version of -RForcecom::rforcecom.upsert — rforcecom.upsert • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -The salesforcer backwards compatible version of +RForcecom::rforcecom.upsert — rforcecom.upsert • salesforcer - - - - - - - - + + -
    -
    -

    The salesforcer backwards compatible version of RForcecom::rforcecom.upsert

    - Source: R/compatibility.R + Source: R/compatibility.R
    -

    [Soft-deprecated]

    +

    [Soft-deprecated]

    - 
    rforcecom.upsert(session, objectName, externalIdField, externalId, fields)
    +
    + 
    rforcecom.upsert(session, objectName, externalIdField, externalId, fields)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    session

    list; a list containing "sessionID", +

    +

    Arguments

    +
    session
    +

    list; a list containing "sessionID", "instanceURL", and "apiVersion" as returned by -RForcecom::rforcecom.login. This argument is ignored in all +RForcecom::rforcecom.login. This argument is ignored in all backward compatible calls because the authorization credentials are stored in an environment internal to the salesforcer package, so it is no longer -necessary to pass the session in each function call.

    objectName

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    externalIdField

    An external Key's field name. (ex: "AccountMaster__c")

    externalId

    An external Key's ID. (ex: "999x000000xxxxxZZZ")

    fields

    Field names and values. (ex: Name="CompanyName", Phone="000-000-000" )

    - -

    Value

    - +necessary to pass the session in each function call.

    +
    objectName
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    externalIdField
    +

    An external Key's field name. (ex: "AccountMaster__c")

    +
    externalId
    +

    An external Key's ID. (ex: "999x000000xxxxxZZZ")

    +
    fields
    +

    Field names and values. (ex: Name="CompanyName", Phone="000-000-000" )

    +
    +
    +

    Value

    NULL if successful otherwise the function errors out

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/safe_bind_rows.html b/docs/reference/safe_bind_rows.html index b8e1cbda..b0d01d13 100644 --- a/docs/reference/safe_bind_rows.html +++ b/docs/reference/safe_bind_rows.html @@ -1,93 +1,20 @@ - - - - - - - -Stack data frames which may have differing types in the same column — safe_bind_rows • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Stack data frames which may have differing types in the same column — safe_bind_rows • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Stack data frames which may have differing types in the same column

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -192,69 +109,58 @@

    Stack data frames which may have differing types in the same column

    regardless of if the datatypes were different within the same column.

    - 
    safe_bind_rows(l, fill = TRUE, idcol = NULL, ...)
    +
    + 
    safe_bind_rows(l, fill = TRUE, idcol = NULL, ...)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    l

    list; A list containing data frames or lists that can be coerced -to data frames.

    fill

    logical; TRUE fills missing columns with NA -(default TRUE). When TRUE, use.names is set to TRUE.

    idcol

    character; Creates a column in the result showing which +

    +

    Arguments

    +
    l
    +

    list; A list containing data frames or lists that can be coerced +to data frames.

    +
    fill
    +

    logical; TRUE fills missing columns with NA +(default TRUE). When TRUE, use.names is set to TRUE.

    +
    idcol
    +

    character; Creates a column in the result showing which list item those rows came from. TRUE names this column ".id". idcol="file" -names this column "file".

    ...

    arguments passed to rbindlist

    - -

    Value

    - +names this column "file".

    +
    ...
    +

    arguments passed to rbindlist

    +
    +
    +

    Value

    tbl_df; all list elements stacked on top of each other to form a single data frame

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/salesforcer-package.html b/docs/reference/salesforcer-package.html index a5aa388d..6d16780b 100644 --- a/docs/reference/salesforcer-package.html +++ b/docs/reference/salesforcer-package.html @@ -1,91 +1,18 @@ - - - - - - - -salesforcer package — salesforcer-package • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -salesforcer package — salesforcer-package • salesforcer - - - - - - - - + + -
    -
    -

    salesforcer package

    - Source: R/salesforcer-package.R + Source: R/salesforcer-package.R
    @@ -189,62 +106,52 @@

    salesforcer package

    - -

    Details

    - +
    +

    Details

    A package that connects R to Salesforce via REST, SOAP, Bulk, Reports and Dashboards, and Metadata APIs with an emphasis on the use of tidy data principles and the tidyverse.

    Additional material can be found in the -README on GitHub and -the package website https://stevenmmortimer.github.io/salesforcer/.

    -

    See also

    - -

    Useful links:

    - -
    -

    Author

    - -

    Maintainer: Steven M. Mortimer mortimer.steven.m@gmail.com

    -

    Other contributors:

    - - +README on GitHub and +the package website https://stevenmmortimer.github.io/salesforcer/.

    +
    + +
    +

    Author

    +

    Maintainer: Steven M. Mortimer mortimer.steven.m@gmail.com

    +

    Other contributors:

    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/salesforcer_state.html b/docs/reference/salesforcer_state.html index 93ed19e1..ec3fce44 100644 --- a/docs/reference/salesforcer_state.html +++ b/docs/reference/salesforcer_state.html @@ -1,91 +1,18 @@ - - - - - - - -Return the package's .state environment variable — salesforcer_state • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Return the package's .state environment variable — salesforcer_state • salesforcer - - - - - - - - + + -
    -
    -

    Return the package's .state environment variable

    - Source: R/utils.R + Source: R/utils.R
    @@ -188,41 +105,42 @@

    Return the package's .state environment variable

    Return the package's .state environment variable

    - 
    salesforcer_state()
    - - -

    Note

    +
    + 
    salesforcer_state()
    +
    +
    +

    Value

    +

    list; a list of values stored in the package's .state environment variable

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/session_id_available.html b/docs/reference/session_id_available.html index 3e8a59b2..6e107dd2 100644 --- a/docs/reference/session_id_available.html +++ b/docs/reference/session_id_available.html @@ -1,92 +1,19 @@ - - - - - - - -Check session_id availability — session_id_available • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Check session_id availability — session_id_available • salesforcer - - - - - - - - + + -
    -
    -

    Check session_id availability

    - Source: R/auth.R + Source: R/auth.R
    -

    Check if a session_id is available in salesforcer's internal +

    Check if a session_id is available in salesforcer's internal .state environment.

    - 
    session_id_available(verbose = TRUE)
    - - -

    Value

    - -

    logical

    -

    Note

    +
    + 
    session_id_available(verbose = TRUE)
    +
    +
    +

    Value

    +

    logical

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/set_null_elements_to_na.html b/docs/reference/set_null_elements_to_na.html index 45c480d9..9ecd91de 100644 --- a/docs/reference/set_null_elements_to_na.html +++ b/docs/reference/set_null_elements_to_na.html @@ -1,93 +1,20 @@ - - - - - - - -Set all NULL or zero-length elements from list to NA — set_null_elements_to_na • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Set all NULL or zero-length elements from list to NA — set_null_elements_to_na • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Set all NULL or zero-length elements from list to NA

    - Source: R/utils-query.R + Source: R/utils-query.R
    -

    This function is a simple modify_if function +

    This function is a simple modify_if function to replace zero-length elements (includes NULL) to NA in a one-level list.

    - 
    set_null_elements_to_na(x)
    - -

    Arguments

    - - - - - - -
    x

    list; a list to be cleaned.

    - -

    Value

    +
    + 
    set_null_elements_to_na(x)
    +
    +
    +

    Arguments

    +
    x
    +

    list; a list to be cleaned.

    +
    +
    +

    Value

    list containing NA in place of NULL element values.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/set_null_elements_to_na_recursively.html b/docs/reference/set_null_elements_to_na_recursively.html index f01e0710..838a59e2 100644 --- a/docs/reference/set_null_elements_to_na_recursively.html +++ b/docs/reference/set_null_elements_to_na_recursively.html @@ -1,92 +1,19 @@ - - - - - - - -Recursively set all NULL or zero-length elements from list to NA — set_null_elements_to_na_recursively • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Recursively set all NULL or zero-length elements from list to NA — set_null_elements_to_na_recursively • salesforcer - - - - - - - - + + -
    -
    -

    Recursively set all NULL or zero-length elements from list to NA

    - Source: R/utils-query.R + Source: R/utils-query.R
    -

    This function wraps a simple modify_if function +

    This function wraps a simple modify_if function to recursively set NULL elements in a list to NA.

    - 
    set_null_elements_to_na_recursively(x)
    - -

    Arguments

    - - - - - - -
    x

    list; a list to be cleaned.

    - -

    Value

    +
    + 
    set_null_elements_to_na_recursively(x)
    +
    +
    +

    Arguments

    +
    x
    +

    list; a list to be cleaned.

    +
    +
    +

    Value

    list containing NA in place of NULL element values.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_abort_job_bulk.html b/docs/reference/sf_abort_job_bulk.html index 2ed182c6..e945d694 100644 --- a/docs/reference/sf_abort_job_bulk.html +++ b/docs/reference/sf_abort_job_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Abort Bulk API Job — sf_abort_job_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Abort Bulk API Job — sf_abort_job_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Abort Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,76 +105,69 @@

    Abort Bulk API Job

    This function aborts a Job in the Salesforce Bulk API

    - 
    sf_abort_job_bulk(
-  job_id,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_abort_job_bulk(
+  job_id,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list of parameters defining the now aborted job

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk('insert', 'Account')
-sf_abort_job_bulk(job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk('insert', 'Account')
+sf_abort_job_bulk(job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_access_token.html b/docs/reference/sf_access_token.html index aa2dcca3..4334f19b 100644 --- a/docs/reference/sf_access_token.html +++ b/docs/reference/sf_access_token.html @@ -1,91 +1,18 @@ - - - - - - - -Return access_token attribute of OAuth 2.0 Token — sf_access_token • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Return access_token attribute of OAuth 2.0 Token — sf_access_token • salesforcer - - - - - - - - + + -
    -
    -

    Return access_token attribute of OAuth 2.0 Token

    - Source: R/auth.R + Source: R/auth.R
    @@ -188,56 +105,51 @@

    Return access_token attribute of OAuth 2.0 Token

    Return access_token attribute of OAuth 2.0 Token

    - 
    sf_access_token(verbose = FALSE)
    +
    + 
    sf_access_token(verbose = FALSE)
    +
    -

    Arguments

    - - - - - - -
    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    character; a string of the access_token element of the current token in force; otherwise NULL

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_analytics_notification_create.html b/docs/reference/sf_analytics_notification_create.html index 28f8725c..5d566d36 100644 --- a/docs/reference/sf_analytics_notification_create.html +++ b/docs/reference/sf_analytics_notification_create.html @@ -1,91 +1,18 @@ - - - - - - - -Create an analytics notification — sf_analytics_notification_create • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create an analytics notification — sf_analytics_notification_create • salesforcer - - - - - - - - + + -
    -
    -

    Create an analytics notification

    - Source: R/analytics-notification.R + Source: R/analytics-notification.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_analytics_notification_create(body)
    +
    + 
    sf_analytics_notification_create(body)
    +
    -

    Arguments

    - - - - - - -
    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_analytics_notification_delete.html b/docs/reference/sf_analytics_notification_delete.html index 9da53bbb..649e8ca8 100644 --- a/docs/reference/sf_analytics_notification_delete.html +++ b/docs/reference/sf_analytics_notification_delete.html @@ -1,91 +1,18 @@ - - - - - - - -Delete an analytics notification — sf_analytics_notification_delete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete an analytics notification — sf_analytics_notification_delete • salesforcer - - - - - - - - + + -
    -
    -

    Delete an analytics notification

    - Source: R/analytics-notification.R + Source: R/analytics-notification.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_analytics_notification_delete(notification_id)
    - -

    Arguments

    - - - - - - -
    notification_id

    character; the Salesforce Id assigned to a created -analytics notification. It will start with "0Au".

    - -

    Value

    +
    + 
    sf_analytics_notification_delete(notification_id)
    +
    +
    +

    Arguments

    +
    notification_id
    +

    character; the Salesforce Id assigned to a created +analytics notification. It will start with "0Au".

    +
    +
    +

    Value

    logical

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_analytics_notification_describe.html b/docs/reference/sf_analytics_notification_describe.html index 2028b8be..12d82a28 100644 --- a/docs/reference/sf_analytics_notification_describe.html +++ b/docs/reference/sf_analytics_notification_describe.html @@ -1,91 +1,18 @@ - - - - - - - -Describe an analytics notification — sf_analytics_notification_describe • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe an analytics notification — sf_analytics_notification_describe • salesforcer - - - - - - - - + + -
    -
    -

    Describe an analytics notification

    - Source: R/analytics-notification.R + Source: R/analytics-notification.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_analytics_notification_describe(notification_id)
    - -

    Arguments

    - - - - - - -
    notification_id

    character; the Salesforce Id assigned to a created -analytics notification. It will start with "0Au".

    - -

    Value

    +
    + 
    sf_analytics_notification_describe(notification_id)
    +
    +
    +

    Arguments

    +
    notification_id
    +

    character; the Salesforce Id assigned to a created +analytics notification. It will start with "0Au".

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_analytics_notification_update.html b/docs/reference/sf_analytics_notification_update.html index fd95459f..5d04b42f 100644 --- a/docs/reference/sf_analytics_notification_update.html +++ b/docs/reference/sf_analytics_notification_update.html @@ -1,91 +1,18 @@ - - - - - - - -Update an analytics notification — sf_analytics_notification_update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update an analytics notification — sf_analytics_notification_update • salesforcer - - - - - - - - + + -
    -
    -

    Update an analytics notification

    - Source: R/analytics-notification.R + Source: R/analytics-notification.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_analytics_notification_update(notification_id, body)
    +
    + 
    sf_analytics_notification_update(notification_id, body)
    +
    -

    Arguments

    - - - - - - - - - - -
    notification_id

    character; the Salesforce Id assigned to a created -analytics notification. It will start with "0Au".

    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    notification_id
    +

    character; the Salesforce Id assigned to a created +analytics notification. It will start with "0Au".

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_analytics_notifications_limits.html b/docs/reference/sf_analytics_notifications_limits.html index 7255f603..6f265a49 100644 --- a/docs/reference/sf_analytics_notifications_limits.html +++ b/docs/reference/sf_analytics_notifications_limits.html @@ -1,91 +1,18 @@ - - - - - - - -Return limits of analytics notifications — sf_analytics_notifications_limits • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Return limits of analytics notifications — sf_analytics_notifications_limits • salesforcer - - - - - - - - + + -
    -
    -

    Return limits of analytics notifications

    - Source: R/analytics-notification.R + Source: R/analytics-notification.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_analytics_notifications_limits(
-  source = c("lightningDashboardSubscribe", "lightningReportSubscribe",
-    "waveNotification"),
-  record_id = NULL
-)
    +
    + 
    sf_analytics_notifications_limits(
+  source = c("lightningDashboardSubscribe", "lightningReportSubscribe",
+    "waveNotification"),
+  record_id = NULL
+)
    +
    -

    Arguments

    - - - - - - - - - - -
    source

    character; a vector of character to specify what type of -analytics notification to return. Valid values are:

    -
    lightningDashboardSubscribe

    Dashboard subscriptions

    -
    lightningReportSubscribe

    Report subscriptions

    -
    waveNotification

    Einstein Analytics notifications

    +
    +

    Arguments

    +
    source
    +

    character; a vector of character to specify what type of +analytics notification to return. Valid values are:

    lightningDashboardSubscribe
    +

    Dashboard subscriptions

    -

    By default, all 3 sources will be returned in the results.

    record_id

    character; specify if wanting to return the notification -details for a single record. Valid values are either a unique report Id -(these reference Ids start with "00O") or an Einstein Analytics lens ID (these -reference Ids start with "0FK").

    +
    lightningReportSubscribe
    +

    Report subscriptions

    -

    Value

    +
    waveNotification
    +

    Einstein Analytics notifications

    + +

    By default, all 3 sources will be returned in the results.

    +
    record_id
    +

    character; specify if wanting to return the notification +details for a single record. Valid values are either a unique report Id +(these reference Ids start with "00O") or an Einstein Analytics lens ID (these +reference Ids start with "0FK").

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_analytics_notifications_list.html b/docs/reference/sf_analytics_notifications_list.html index 0350eadb..223f0c80 100644 --- a/docs/reference/sf_analytics_notifications_list.html +++ b/docs/reference/sf_analytics_notifications_list.html @@ -1,91 +1,18 @@ - - - - - - - -List analytics notifications — sf_analytics_notifications_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List analytics notifications — sf_analytics_notifications_list • salesforcer - - - - - - - - + + -
    -
    -

    List analytics notifications

    - Source: R/analytics-notification.R + Source: R/analytics-notification.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_analytics_notifications_list(
-  source = c("lightningDashboardSubscribe", "lightningReportSubscribe",
-    "waveNotification"),
-  owner_id = NULL,
-  record_id = NULL
-)
    +
    + 
    sf_analytics_notifications_list(
+  source = c("lightningDashboardSubscribe", "lightningReportSubscribe",
+    "waveNotification"),
+  owner_id = NULL,
+  record_id = NULL
+)
    +
    + +
    +

    Arguments

    +
    source
    +

    character; a vector of character to specify what type of +analytics notification to return. Valid values are:

    lightningDashboardSubscribe
    +

    Dashboard subscriptions

    + +
    lightningReportSubscribe
    +

    Report subscriptions

    -

    Arguments

    - - - - - - - - - - - - - - -
    source

    character; a vector of character to specify what type of -analytics notification to return. Valid values are:

    -
    lightningDashboardSubscribe

    Dashboard subscriptions

    -
    lightningReportSubscribe

    Report subscriptions

    -
    waveNotification

    Einstein Analytics notifications

    +
    waveNotification
    +

    Einstein Analytics notifications

    -

    By default, all 3 sources will be returned in the results.

    owner_id

    character; Allows users with Manage Analytics Notifications + +

    By default, all 3 sources will be returned in the results.

    +
    owner_id
    +

    character; Allows users with Manage Analytics Notifications permission to get notifications for another user with the specified Salesforce -Id representing the owner, which is a User record (i.e. the Id will start with "005").

    record_id

    character; specify if wanting to return the notification +Id representing the owner, which is a User record (i.e. the Id will start with "005").

    +
    record_id
    +

    character; specify if wanting to return the notification details for a single record. Valid values are either a unique report Id (these reference Ids start with "00O") or an Einstein Analytics lens ID (these -reference Ids start with "0FK").

    - -

    Value

    - +reference Ids start with "0FK").

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_auth.html b/docs/reference/sf_auth.html index 2fd4c505..df338f7c 100644 --- a/docs/reference/sf_auth.html +++ b/docs/reference/sf_auth.html @@ -1,97 +1,24 @@ - - - - - - - -Log in to Salesforce — sf_auth • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Log in to Salesforce — sf_auth • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Log in to Salesforce

    - Source: R/auth.R + Source: R/auth.R
    -

    [Stable]

    +

    [Stable]

    Log in using Basic (Username-Password) or OAuth 2.0 authentication. OAuth does not require sharing passwords, but will require authorizing salesforcer as a connected app to view and manage your organization. You will be directed to @@ -200,138 +117,126 @@

    Log in to Salesforce

    cached in a file named .httr-oauth-salesforcer in the current working directory.

    - 
    sf_auth(
-  username = NULL,
-  password = NULL,
-  security_token = NULL,
-  login_url = getOption("salesforcer.login_url"),
-  token = NULL,
-  consumer_key = getOption("salesforcer.consumer_key"),
-  consumer_secret = getOption("salesforcer.consumer_secret"),
-  callback_url = getOption("salesforcer.callback_url"),
-  cache = getOption("salesforcer.httr_oauth_cache"),
-  verbose = FALSE
-)
    +
    + 
    sf_auth(
+  username = NULL,
+  password = NULL,
+  security_token = NULL,
+  login_url = getOption("salesforcer.login_url"),
+  token = NULL,
+  consumer_key = getOption("salesforcer.consumer_key"),
+  consumer_secret = getOption("salesforcer.consumer_secret"),
+  callback_url = getOption("salesforcer.callback_url"),
+  cache = getOption("salesforcer.httr_oauth_cache"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    username

    Salesforce username, typically an email address

    password

    Salesforce password

    security_token

    Salesforce security token. Note: A new security token is -generated whenever your password is changed.

    login_url

    a custom login url; defaults to https://login.salesforce.com. If +

    +

    Arguments

    +
    username
    +

    Salesforce username, typically an email address

    +
    password
    +

    Salesforce password

    +
    security_token
    +

    Salesforce security token. Note: A new security token is +generated whenever your password is changed.

    +
    login_url
    +

    a custom login url; defaults to https://login.salesforce.com. If needing to log into a sandbox or dev environment then provide its login URL (e.g. -https://test.salesforce.com)

    token

    optional; an actual token object or the path to a valid token -stored as an .rds file

    consumer_key, consumer_secret, callback_url

    the "Consumer Key","Consumer Secret", +https://test.salesforce.com)

    +
    token
    +

    optional; an actual token object or the path to a valid token +stored as an .rds file

    +
    consumer_key, consumer_secret, callback_url
    +

    the "Consumer Key","Consumer Secret", and "Callback URL" when using a connected app; defaults to the salesforcer -connected apps' consumer key, secret, and callback url

    cache

    logical or character; TRUE means to cache using +connected apps' consumer key, secret, and callback url

    +
    cache
    +

    logical or character; TRUE means to cache using the default cache file .httr-oauth-salesforcer, FALSE means do not -cache. A string means use the specified path as the cache file.

    verbose

    logical; an indicator of whether to print additional +cache. A string means use the specified path as the cache file.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list invisibly that contains 4 elements detailing the authentication state

    -

    Note

    - +
    +
    +

    Note

    The link{sf_auth} function invisibly returns the following -4 pieces of information which can be reused in other operations:

    -
    auth_method

    character; One of two options 'Basic' or 'OAuth'. If a username, +4 pieces of information which can be reused in other operations:

    auth_method
    +

    character; One of two options 'Basic' or 'OAuth'. If a username, password, and security token were supplied, then this would result in 'Basic' authentication.

    -
    token

    Token2.0; The object returned by oauth2.0_token. + +

    token
    +

    Token2.0; The object returned by oauth2.0_token. This value is NULL if auth_method='Basic'.

    -
    session_id

    character; A unique ID associated with this user session. The session + +

    session_id
    +

    character; A unique ID associated with this user session. The session ID is obtained from the X-SFDC-Session header fetched with SOAP API's login() call. This value is NULL if auth_method='OAuth'.

    -
    instance_url

    character; The domain address of the server that your Salesforce org + +

    instance_url
    +

    character; The domain address of the server that your Salesforce org is on and where subsequent API calls will be directed to. For example, https://na21.salesforce.com refers to an org located on the 'NA21' server instance located in Chicago, USA / Washington DC, USA per this -Knowledge Article: https://help.salesforce.com/articleView?id=000314281.

    - -
    - - -

    Examples

    - 
    if (FALSE) {
-# log in using basic authentication (username-password)
-sf_auth(username = "test@gmail.com", 
-        password = "test_password", 
-        security_token = "test_token")
-
-# log in using OAuth 2.0 (via browser or cached .httr-oauth-salesforcer)
-sf_auth()
-
-# log in to a Sandbox environment
-# Via brower or refresh of .httr-oauth-salesforcer
-sf_auth(login_url = "https://test.salesforce.com")
-
-# Save token to disk and log in using it
-saveRDS(salesforcer_state()$token, "token.rds")
-sf_auth(token = "token.rds")
-}
-
    +Knowledge Article: https://help.salesforce.com/articleView?id=000314281.

    + + +
    + +
    +

    Examples

    + 
    if (FALSE) {
+# log in using basic authentication (username-password)
+sf_auth(username = "test@gmail.com", 
+        password = "test_password", 
+        security_token = "test_token")
+
+# log in using OAuth 2.0 (via browser or cached .httr-oauth-salesforcer)
+sf_auth()
+
+# log in to a Sandbox environment
+# Via brower or refresh of .httr-oauth-salesforcer
+sf_auth(login_url = "https://test.salesforce.com")
+
+# Save token to disk and log in using it
+saveRDS(salesforcer_state()$token, "token.rds")
+sf_auth(token = "token.rds")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_auth_check.html b/docs/reference/sf_auth_check.html index 3b6ebc60..3b109ba6 100644 --- a/docs/reference/sf_auth_check.html +++ b/docs/reference/sf_auth_check.html @@ -1,96 +1,23 @@ - - - - - - - -Check that an Authorized Salesforce Session Exists — sf_auth_check • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Check that an Authorized Salesforce Session Exists — sf_auth_check • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Check that an Authorized Salesforce Session Exists

    - Source: R/auth.R + Source: R/auth.R

    Before the user makes any calls requiring an authorized session, check if an -OAuth token or session is not already available, call sf_auth to +OAuth token or session is not already available, call sf_auth to by default initiate the OAuth 2.0 workflow that will load a token from cache or launch browser flow. Return the bare token. Use access_token() to reveal the actual access token, suitable for use with curl.

    - 
    sf_auth_check(verbose = FALSE)
    +
    + 
    sf_auth_check(verbose = FALSE)
    +
    -

    Arguments

    - - - - - - -
    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    a Token2.0 object (an S3 class provided by httr) or a a character string of the sessionId element of the current authorized API session

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_auth_refresh.html b/docs/reference/sf_auth_refresh.html index aa3bed93..9a9396ae 100644 --- a/docs/reference/sf_auth_refresh.html +++ b/docs/reference/sf_auth_refresh.html @@ -1,93 +1,20 @@ - - - - - - - -Refresh an existing Authorized Salesforce Token — sf_auth_refresh • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Refresh an existing Authorized Salesforce Token — sf_auth_refresh • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Refresh an existing Authorized Salesforce Token

    - Source: R/auth.R + Source: R/auth.R
    @@ -192,57 +109,52 @@

    Refresh an existing Authorized Salesforce Token

    you're running in non-interactive mode.

    - 
    sf_auth_refresh(verbose = FALSE)
    +
    + 
    sf_auth_refresh(verbose = FALSE)
    +
    -

    Arguments

    - - - - - - -
    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    a Token2.0 object (an S3 class provided by httr) or a a character string of the sessionId element of the current authorized API session

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_batch_details_bulk.html b/docs/reference/sf_batch_details_bulk.html index 8ab64d51..1e68a82b 100644 --- a/docs/reference/sf_batch_details_bulk.html +++ b/docs/reference/sf_batch_details_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Returning the Details of a Batch in a Bulk API Job — sf_batch_details_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Returning the Details of a Batch in a Bulk API Job — sf_batch_details_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Returning the Details of a Batch in a Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -190,91 +107,83 @@

    Returning the Details of a Batch in a Bulk API Job

    which has already been submitted to Bulk API Job

    - 
    sf_batch_details_bulk(
-  job_id,
-  batch_id,
-  api_type = c("Bulk 1.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_batch_details_bulk(
+  job_id,
+  batch_id,
+  api_type = c("Bulk 1.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    batch_id

    character; the Salesforce Id assigned to a submitted -batch as returned by sf_create_batches_bulk. It will start with "751".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    batch_id
    +

    character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df, formatted by Salesforce, with information containing the success or failure or certain rows in a submitted batch, unless the operation was query, then it is a data.frame containing the result_id for retrieving the recordset.

    -

    Note

    - +
    +
    +

    Note

    This is a legacy function used only with Bulk 1.0.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk(operation = "query", object = "Account")
-soql <- "SELECT Id, Name FROM Account LIMIT 10"
-batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql)
-batch_details <- sf_batch_details_bulk(job_id=batch_query_info$jobId,
-                                       batch_id=batch_query_info$id)
-sf_close_job_bulk(job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk(operation = "query", object = "Account")
+soql <- "SELECT Id, Name FROM Account LIMIT 10"
+batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql)
+batch_details <- sf_batch_details_bulk(job_id=batch_query_info$jobId,
+                                       batch_id=batch_query_info$id)
+sf_close_job_bulk(job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_batch_status_bulk.html b/docs/reference/sf_batch_status_bulk.html index 8c467107..ea49debe 100644 --- a/docs/reference/sf_batch_status_bulk.html +++ b/docs/reference/sf_batch_status_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Checking the Status of a Batch in a Bulk API Job — sf_batch_status_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Checking the Status of a Batch in a Bulk API Job — sf_batch_status_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Checking the Status of a Batch in a Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -190,90 +107,82 @@

    Checking the Status of a Batch in a Bulk API Job

    which has already been submitted to Bulk API Job

    - 
    sf_batch_status_bulk(
-  job_id,
-  batch_id,
-  api_type = c("Bulk 1.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_batch_status_bulk(
+  job_id,
+  batch_id,
+  api_type = c("Bulk 1.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    batch_id

    character; the Salesforce Id assigned to a submitted -batch as returned by sf_create_batches_bulk. It will start with "751".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    batch_id
    +

    character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of parameters defining the batch identified by the batch_id

    -

    Note

    - +
    +
    +

    Note

    This is a legacy function used only with Bulk 1.0.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk(operation = "query", object = "Account")
-soql <- "SELECT Id, Name FROM Account LIMIT 10"
-batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql)
-batch_status <- sf_batch_status_bulk(job_id = batch_query_info$jobId,
-                                     batch_id = batch_query_info$id)
-job_close_ind <- sf_close_job_bulk(job_info$id)
-sf_get_job_bulk(job_info$id)                               
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk(operation = "query", object = "Account")
+soql <- "SELECT Id, Name FROM Account LIMIT 10"
+batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql)
+batch_status <- sf_batch_status_bulk(job_id = batch_query_info$jobId,
+                                     batch_id = batch_query_info$id)
+job_close_ind <- sf_close_job_bulk(job_info$id)
+sf_get_job_bulk(job_info$id)                               
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_build_cols_spec.html b/docs/reference/sf_build_cols_spec.html index dfcec9d1..f9893e6a 100644 --- a/docs/reference/sf_build_cols_spec.html +++ b/docs/reference/sf_build_cols_spec.html @@ -1,92 +1,19 @@ - - - - - - - -Produce spec to convert Salesforce data types to R data types — sf_build_cols_spec • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Produce spec to convert Salesforce data types to R data types — sf_build_cols_spec • salesforcer - - - - - - - - + + -
    -
    -

    Produce spec to convert Salesforce data types to R data types

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -190,52 +107,47 @@

    Produce spec to convert Salesforce data types to R data types

    a single string that can be passed to the col_types argument.

    - 
    sf_build_cols_spec(x)
    - -

    Arguments

    - - - - - - -
    x

    character; the Salesforce data types to map

    - -

    Value

    +
    + 
    sf_build_cols_spec(x)
    +
    +
    +

    Arguments

    +
    x
    +

    character; the Salesforce data types to map

    +
    +
    +

    Value

    character the analogous R data types.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_close_job_bulk.html b/docs/reference/sf_close_job_bulk.html index 12e321f0..4abe4cfd 100644 --- a/docs/reference/sf_close_job_bulk.html +++ b/docs/reference/sf_close_job_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Close Bulk API Job — sf_close_job_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Close Bulk API Job — sf_close_job_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Close Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,84 +105,78 @@

    Close Bulk API Job

    This function closes a Job in the Salesforce Bulk API

    - 
    sf_close_job_bulk(
-  job_id,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_close_job_bulk(
+  job_id,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list of parameters defining the now closed job

    -

    Note

    - +
    +
    +

    Note

    This is a legacy function used only with Bulk 1.0.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-my_query <- "SELECT Id, Name FROM Account LIMIT 10"
-job_info <- sf_create_job_bulk(operation='query', object='Account')
-query_info <- sf_submit_query_bulk(job_id=job_info$id, soql=my_query)
-recordset <- sf_query_result_bulk(job_id = query_info$jobId,
-                                  batch_id = query_info$id,
-                                  result_id = result$result)
-sf_close_job_bulk(job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+my_query <- "SELECT Id, Name FROM Account LIMIT 10"
+job_info <- sf_create_job_bulk(operation='query', object='Account')
+query_info <- sf_submit_query_bulk(job_id=job_info$id, soql=my_query)
+recordset <- sf_query_result_bulk(job_id = query_info$jobId,
+                                  batch_id = query_info$id,
+                                  result_id = result$result)
+sf_close_job_bulk(job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_control.html b/docs/reference/sf_control.html index 7740fe5d..3a51efeb 100644 --- a/docs/reference/sf_control.html +++ b/docs/reference/sf_control.html @@ -1,94 +1,21 @@ - - - - - - - -Auxiliary for Controlling Calls to Salesforce APIs — sf_control • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Auxiliary for Controlling Calls to Salesforce APIs — sf_control • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Auxiliary for Controlling Calls to Salesforce APIs

    - Source: R/utils-control.R + Source: R/utils-control.R

    Typically only used internally by functions when control parameters are passed through via dots (...), but it can be called directly to control the behavior -of API calls. This function behaves exactly like glm.control -for the glm function.

    +of API calls. This function behaves exactly like glm.control +for the glm function.

    - 
    sf_control(
-  AllOrNoneHeader = list(allOrNone = FALSE),
-  AllowFieldTruncationHeader = list(allowFieldTruncation = FALSE),
-  AssignmentRuleHeader = list(useDefaultRule = TRUE),
-  DisableFeedTrackingHeader = list(disableFeedTracking = FALSE),
-  DuplicateRuleHeader = list(allowSave = FALSE, includeRecordDetails = FALSE,
-    runAsCurrentUser = TRUE),
-  EmailHeader = list(triggerAutoResponseEmail = FALSE, triggerOtherEmail = FALSE,
-    triggerUserEmail = TRUE),
-  LocaleOptions = list(language = "en_US"),
-  MruHeader = list(updateMru = FALSE),
-  OwnerChangeOptions = list(options = list(list(execute = TRUE, type =
-    "EnforceNewOwnerHasReadAccess"), list(execute = FALSE, type = "KeepAccountTeam"),
-    list(execute = FALSE, type = "KeepSalesTeam"), list(execute = FALSE, type =
-    "KeepSalesTeamGrantCurrentOwnerReadWriteAccess"), list(execute = FALSE, type =
-    "SendEmail"), list(execute = FALSE, type = "TransferAllOwnedCases"), list(execute =
-    TRUE, type = "TransferContacts"), list(execute = TRUE, type = "TransferContracts"),
-    list(execute = FALSE, type = "TransferNotesAndAttachments"),      list(execute =
-    TRUE, type = "TransferOpenActivities"), list(execute = TRUE, type =
-    "TransferOrders"), list(execute = FALSE, type = "TransferOtherOpenOpportunities"),
-    list(execute = FALSE, type = "TransferOwnedClosedOpportunities"), list(execute =
-    FALSE, type = "TransferOwnedOpenCases"), list(execute = FALSE, type =
-    "TransferOwnedOpenOpportunities"))),
-  QueryOptions = list(batchSize = 500),
-  UserTerritoryDeleteHeader = list(transferToUserId = NA),
-  BatchRetryHeader = list(`Sforce-Disable-Batch-Retry` = FALSE),
-  LineEndingHeader = list(`Sforce-Line-Ending` = NA),
-  PKChunkingHeader = list(`Sforce-Enable-PKChunking` = FALSE),
-  api_type = NULL,
-  operation = NULL
-)
    +
    + 
    sf_control(
+  AllOrNoneHeader = list(allOrNone = FALSE),
+  AllowFieldTruncationHeader = list(allowFieldTruncation = FALSE),
+  AssignmentRuleHeader = list(useDefaultRule = TRUE),
+  DisableFeedTrackingHeader = list(disableFeedTracking = FALSE),
+  DuplicateRuleHeader = list(allowSave = FALSE, includeRecordDetails = FALSE,
+    runAsCurrentUser = TRUE),
+  EmailHeader = list(triggerAutoResponseEmail = FALSE, triggerOtherEmail = FALSE,
+    triggerUserEmail = TRUE),
+  LocaleOptions = list(language = "en_US"),
+  MruHeader = list(updateMru = FALSE),
+  OwnerChangeOptions = list(options = list(list(execute = TRUE, type =
+    "EnforceNewOwnerHasReadAccess"), list(execute = FALSE, type = "KeepAccountTeam"),
+    list(execute = FALSE, type = "KeepSalesTeam"), list(execute = FALSE, type =
+    "KeepSalesTeamGrantCurrentOwnerReadWriteAccess"), list(execute = FALSE, type =
+    "SendEmail"), list(execute = FALSE, type = "TransferAllOwnedCases"), list(execute =
+    TRUE, type = "TransferContacts"), list(execute = TRUE, type = "TransferContracts"),
+    list(execute = FALSE, type = "TransferNotesAndAttachments"),      list(execute =
+    TRUE, type = "TransferOpenActivities"), list(execute = TRUE, type =
+    "TransferOrders"), list(execute = FALSE, type = "TransferOtherOpenOpportunities"),
+    list(execute = FALSE, type = "TransferOwnedClosedOpportunities"), list(execute =
+    FALSE, type = "TransferOwnedOpenCases"), list(execute = FALSE, type =
+    "TransferOwnedOpenOpportunities"))),
+  QueryOptions = list(batchSize = 500),
+  UserTerritoryDeleteHeader = list(transferToUserId = NA),
+  BatchRetryHeader = list(`Sforce-Disable-Batch-Retry` = FALSE),
+  LineEndingHeader = list(`Sforce-Line-Ending` = NA),
+  PKChunkingHeader = list(`Sforce-Enable-PKChunking` = FALSE),
+  api_type = NULL,
+  operation = NULL
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    AllOrNoneHeader

    list; containing the allOrNone element with +

    +

    Arguments

    +
    AllOrNoneHeader
    +

    list; containing the allOrNone element with a value of TRUE or FALSE. This control specifies whether a call rolls back all changes unless all records are processed successfully. This control is available in -SOAP, REST, and Metadata APIs for the following functions: sf_create, -sf_delete, sf_update, sf_upsert, sf_create_metadata, -sf_delete_metadata, sf_update_metadata, sf_upsert_metadata. +SOAP, REST, and Metadata APIs for the following functions: sf_create, +sf_delete, sf_update, sf_upsert, sf_create_metadata, +sf_delete_metadata, sf_update_metadata, sf_upsert_metadata. For more information, read the Salesforce documentation -here.

    AllowFieldTruncationHeader

    list; containing the allowFieldTruncation +here.

    +
    AllowFieldTruncationHeader
    +

    list; containing the allowFieldTruncation element with a value of TRUE or FALSE. This control specifies the truncation behavior for some field types in SOAP API version 15.0 and later for the following functions: -sf_create, sf_update, sf_upsert. For +sf_create, sf_update, sf_upsert. For more information, read the Salesforce documentation -here.

    AssignmentRuleHeader

    list; containing the useDefaultRule +here.

    +
    AssignmentRuleHeader
    +

    list; containing the useDefaultRule element with a value of TRUE or FALSE or the assignmentRuleId element. This control specifies the assignment rule to use when creating or updating an -Account, Case, or Lead for the following functions: sf_create, -sf_update, sf_upsert. For more information, read the Salesforce documentation -here.

    DisableFeedTrackingHeader

    list; containing the disableFeedTracking +Account, Case, or Lead for the following functions: sf_create, +sf_update, sf_upsert. For more information, read the Salesforce documentation +here.

    +
    DisableFeedTrackingHeader
    +

    list; containing the disableFeedTracking element with a value of TRUE or FALSE. This control specifies whether the changes made in the current call are tracked in feeds for SOAP API calls made -with the following functions: sf_create, sf_delete, -sf_update, sf_upsert. For more information, read the Salesforce documentation -here.

    DuplicateRuleHeader

    list; containing the allowSave, +with the following functions: sf_create, sf_delete, +sf_update, sf_upsert. For more information, read the Salesforce documentation +here.

    +
    DuplicateRuleHeader
    +

    list; containing the allowSave, includeRecordDetails, and runAsCurrentUser elements each with a value of TRUE or FALSE. This control specifies how duplicate rules should be applied -when using the following functions: sf_create, sf_update, -sf_upsert. For more information, read the Salesforce documentation -here.

    EmailHeader

    list; containing the triggerAutoResponseEmail, +when using the following functions: sf_create, sf_update, +sf_upsert. For more information, read the Salesforce documentation +here.

    +
    EmailHeader
    +

    list; containing the triggerAutoResponseEmail, triggerOtherEmail, and triggerUserEmail elements each with a value of TRUE or FALSE. This control determines if an email notification should be sent when a request is processed by SOAP API calls made with the following functions: -sf_create, sf_delete, sf_update, sf_upsert, -sf_reset_password. For more information, read the Salesforce documentation -here.

    LocaleOptions

    list; containing the language element. This control -specifies the language of the labels returned by the sf_describe_objects +sf_create, sf_delete, sf_update, sf_upsert, +sf_reset_password. For more information, read the Salesforce documentation +here.

    +
    LocaleOptions
    +

    list; containing the language element. This control +specifies the language of the labels returned by the sf_describe_objects function using the SOAP API. The value must be a valid user locale (language and country), such as de_DE or en_GB. For more information, read the Salesforce documentation -here. +here. The list of valid user locales is available -here.

    MruHeader

    list; containing the updateMru element with a value +here.

    +
    MruHeader
    +

    list; containing the updateMru element with a value of TRUE or FALSE. This control indicates whether to update the list of most recently used items (TRUE) or not (FALSE) in the Recent Items section of the sidebar in the Salesforce user interface. This works for SOAP API calls -made with the following functions: sf_create, sf_update, -sf_upsert, sf_retrieve, sf_query. For more +made with the following functions: sf_create, sf_update, +sf_upsert, sf_retrieve, sf_query. For more information, read the Salesforce documentation -here.

    OwnerChangeOptions

    list; containing the options element. +here.

    +
    OwnerChangeOptions
    +

    list; containing the options element. This control specifies the details of ownership of attachments and notes when a record’s owner is changed. This works for SOAP API calls made with the following functions: -sf_update, sf_upsert. For more information, read the Salesforce documentation -here.

    QueryOptions

    list; containing the batchSize element. +sf_update, sf_upsert. For more information, read the Salesforce documentation +here.

    +
    QueryOptions
    +

    list; containing the batchSize element. This control specifies the batch size for query results . This works for SOAP or -REST API calls made with the following functions: sf_query, -sf_retrieve. For more information, read the Salesforce documentation -here.

    UserTerritoryDeleteHeader

    list; containing the transferToUserId element. +REST API calls made with the following functions: sf_query, +sf_retrieve. For more information, read the Salesforce documentation +here.

    +
    UserTerritoryDeleteHeader
    +

    list; containing the transferToUserId element. This control specifies a user to whom open opportunities are assigned when the current -owner is removed from a territory. This works for the sf_delete function +owner is removed from a territory. This works for the sf_delete function using the SOAP API. For more information, read the Salesforce documentation -here.

    BatchRetryHeader

    list; containing the Sforce-Disable-Batch-Retry element. +here.

    +
    BatchRetryHeader
    +

    list; containing the Sforce-Disable-Batch-Retry element. When you create a bulk job, the Batch Retry control lets you disable retries for unfinished batches included in the job. This works for most operations run through -the Bulk 1.0 API (e.g. sf_create(., api_type = "Bulk 1.0")) or creating -a Bulk 1.0 job with sf_create_job_bulk. For more information, read the Salesforce documentation -here.

    LineEndingHeader

    list; containing the Sforce-Line-Ending element. +the Bulk 1.0 API (e.g. sf_create(., api_type = "Bulk 1.0")) or creating +a Bulk 1.0 job with sf_create_job_bulk. For more information, read the Salesforce documentation +here.

    +
    LineEndingHeader
    +

    list; containing the Sforce-Line-Ending element. When you’re creating a bulk upload job, the Line Ending control lets you specify whether line endings are read as line feeds (LFs) or as carriage returns and line feeds (CRLFs) for fields of type Text Area and Text Area (Long). This works for most operations run through the Bulk APIs and/or creating a Bulk -job from scratch with sf_create_job_bulk. However, note that +job from scratch with sf_create_job_bulk. However, note that as of readr v1.3.1 all CSV files end with the line feed character ("\n") regardless of the operating system. So it is usually best to not specify this argument. For more information, read the Salesforce documentation -here.

    PKChunkingHeader

    list; containing the Sforce-Enable-PKChunking element. +here.

    +
    PKChunkingHeader
    +

    list; containing the Sforce-Enable-PKChunking element. Use the PK Chunking control to enable automatic primary key (PK) chunking for a bulk query job. This works for queries run through the Bulk 1.0 API either via -sf_query(., api_type = "Bulk 1.0")) or sf_query_bulk. For +sf_query(., api_type = "Bulk 1.0")) or sf_query_bulk. For more information, read the Salesforce documentation -here.

    api_type

    character; one of "REST", "SOAP", +here.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    operation

    character; a string defining the type of operation being +making the request.

    +
    operation
    +

    character; a string defining the type of operation being performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", -"query", "queryall").

    - - -

    Examples

    - 
    if (FALSE) {
-this_control <- sf_control(DuplicateRuleHeader=list(allowSave=TRUE, 
-                                                    includeRecordDetails=FALSE, 
-                                                    runAsCurrentUser=TRUE))
-new_contact <- c(FirstName = "Test", LastName = "Contact-Create")
-new_record <- sf_create(new_contact, "Contact", control = this_control)
-
-# specifying the controls directly and are picked up by dots
-new_record <- sf_create(new_contact, "Contact", 
-                        DuplicateRuleHeader = list(allowSave=TRUE, 
-                                                   includeRecordDetails=FALSE, 
-                                                   runAsCurrentUser=TRUE))
-}
-
    +"query", "queryall").

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+this_control <- sf_control(DuplicateRuleHeader=list(allowSave=TRUE, 
+                                                    includeRecordDetails=FALSE, 
+                                                    runAsCurrentUser=TRUE))
+new_contact <- c(FirstName = "Test", LastName = "Contact-Create")
+new_record <- sf_create(new_contact, "Contact", control = this_control)
+
+# specifying the controls directly and are picked up by dots
+new_record <- sf_create(new_contact, "Contact", 
+                        DuplicateRuleHeader = list(allowSave=TRUE, 
+                                                   includeRecordDetails=FALSE, 
+                                                   runAsCurrentUser=TRUE))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_convert_lead.html b/docs/reference/sf_convert_lead.html index 33526c57..9711ec76 100644 --- a/docs/reference/sf_convert_lead.html +++ b/docs/reference/sf_convert_lead.html @@ -1,92 +1,19 @@ - - - - - - - -Convert Leads — sf_convert_lead • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Convert Leads — sf_convert_lead • salesforcer - - - - - - - - + + -
    -
    -

    Convert Leads

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Converts Leads each into an Account, Contact, as well as (optionally) an Opportunity.

    - 
    sf_convert_lead(
-  input_data,
-  guess_types = TRUE,
-  api_type = c("SOAP"),
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_convert_lead(
+  input_data,
+  guess_types = TRUE,
+  api_type = c("SOAP"),
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    input_data

    named vector, matrix, data.frame, or +

    +

    Arguments

    +
    input_data
    +

    named vector, matrix, data.frame, or tbl_df; data can be coerced into a data.frame. See the details below on how format your input data to control things like whether an opportunity -will be created, an email will be sent to the new owner, and other control options.

    guess_types

    logical; indicating whether or not to use col_guess() +will be created, an email will be sent to the new owner, and other control options.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    api_type

    character; one of "REST", "SOAP", +like numeric looking values that must be preserved as strings ("48.0").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df with details of the converted record

    -

    Details

    - +
    +
    +

    Details

    When converting leads owned by a queue, the owner must be specified. This is because accounts and contacts cannot be owned by a queue. Below is a complete list of options to control the conversion process. Include a column @@ -256,91 +162,108 @@

    Details in your input data called doNotCreateOpportunity and set its value to TRUE. The default is FALSE which creates opportunities. The order of columns in the input data does not matter, just that the names -match (case-insensitive).

    -
    leadId

    ID of the Lead to convert. Required.

    -
    convertedStatus

    Valid LeadStatus value for a converted lead. Required.

    -
    accountId

    Id of the Account into which the lead will be merged. Required +match (case-insensitive).

    leadId
    +

    ID of the Lead to convert. Required.

    + +
    convertedStatus
    +

    Valid LeadStatus value for a converted lead. Required.

    + +
    accountId
    +

    Id of the Account into which the lead will be merged. Required only when updating an existing account, including person accounts. If no accountId is specified, then the API creates a new account.

    -
    contactId

    Id of the Contact into which the lead will be merged (this + +

    contactId
    +

    Id of the Contact into which the lead will be merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact. If no contactId is specified, then the API creates a new contact that is implicitly associated with the Account.

    -
    ownerId

    Specifies the Id of the person to own any newly created account, + +

    ownerId
    +

    Specifies the Id of the person to own any newly created account, contact, and opportunity. If the client application does not specify this value, then the owner of the new object will be the owner of the lead.

    -
    opportunityId

    The Id of an existing opportunity to relate to the lead. + +

    opportunityId
    +

    The Id of an existing opportunity to relate to the lead. The opportunityId and opportunityName arguments are mutually exclusive. Specifying a value for both results in an error. If doNotCreateOpportunity argument is TRUE, then no Opportunity is created and this field must be left blank; otherwise, an error is returned.

    -
    doNotCreateOpportunity

    Specifies whether to create an Opportunity during + +

    doNotCreateOpportunity
    +

    Specifies whether to create an Opportunity during lead conversion (FALSE, the default) or not (TRUE). Set this flag to TRUE only if you do not want to create an opportunity from the lead. An opportunity is created by default.

    -
    opportunityName

    Name of the opportunity to create. If no name is specified, + +

    opportunityName
    +

    Name of the opportunity to create. If no name is specified, then this value defaults to the company name of the lead. The maximum length of this field is 80 characters. The opportunityId and opportunityName arguments are mutually exclusive. Specifying a value for both results in an error. If doNotCreateOpportunity argument is TRUE, then no Opportunity is created and this field must be left blank; otherwise, an error is returned.

    -
    overwriteLeadSource

    Specifies whether to overwrite the LeadSource field + +

    overwriteLeadSource
    +

    Specifies whether to overwrite the LeadSource field on the target Contact object with the contents of the LeadSource field in the source Lead object (TRUE), or not (FALSE, the default). To set this field to TRUE, the client application must specify a contactId for the target contact.

    -
    sendNotificationEmail

    Specifies whether to send a notification email + +

    sendNotificationEmail
    +

    Specifies whether to send a notification email to the owner specified in the ownerId (TRUE) or not (FALSE, the default).

    -

    Salesforce Documentation

    -

    Examples

    - 
    if (FALSE) {
-# create a new lead at Grand Hotels & Resorts Ltd
-new_lead <- tibble(FirstName = "Test", LastName = "Prospect",
-                   Company = "Grand Hotels & Resorts Ltd")
-rec <- sf_create(new_lead, "Lead")
-
-# find the Id of matching account to link to
-acct_id <- sf_query("SELECT Id from Account WHERE name = 'Grand Hotels & Resorts Ltd' LIMIT 1")
+

    Salesforce Documentation

    +

    -# create the row(s) for the leads to convert -to_convert <- tibble(leadId = rec$id, - convertedStatus = "Closed - Converted", - accountId = acct_id$Id) -converted_lead <- sf_convert_lead(to_convert) -} -
    +
    +

    Examples

    + 
    if (FALSE) {
+# create a new lead at Grand Hotels & Resorts Ltd
+new_lead <- tibble(FirstName = "Test", LastName = "Prospect",
+                   Company = "Grand Hotels & Resorts Ltd")
+rec <- sf_create(new_lead, "Lead")
+
+# find the Id of matching account to link to
+acct_id <- sf_query("SELECT Id from Account WHERE name = 'Grand Hotels & Resorts Ltd' LIMIT 1")
+
+# create the row(s) for the leads to convert
+to_convert <- tibble(leadId = rec$id, 
+                     convertedStatus = "Closed - Converted", 
+                     accountId = acct_id$Id)
+converted_lead <- sf_convert_lead(to_convert)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_copy_report.html b/docs/reference/sf_copy_report.html index a0107a58..8d49ce95 100644 --- a/docs/reference/sf_copy_report.html +++ b/docs/reference/sf_copy_report.html @@ -1,93 +1,20 @@ - - - - - - - -Copy a report — sf_copy_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Copy a report — sf_copy_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Copy a report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Creates a copy of a custom, standard, or public report by sending a POST request to the Report List resource.

    - 
    sf_copy_report(report_id, name = NULL, verbose = FALSE)
    +
    + 
    sf_copy_report(report_id, name = NULL, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    name

    character; a user-specified name for the newly cloned report. +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    name
    +

    character; a user-specified name for the newly cloned report. If left NULL, then the new name will be the same name as the report being cloned appended with " = Copy" that is prefixed with a number if that name is -not unique. It is highly recommended to provide a name, if possible.

    verbose

    logical; an indicator of whether to print additional +not unique. It is highly recommended to provide a name, if possible.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list representing the newly cloned report with up to 4 properties -that describe the report:

    -
    attributes

    Report type along with the URL to retrieve common objects and +that describe the report:

    attributes
    +

    Report type along with the URL to retrieve common objects and joined metadata.

    -
    reportMetadata

    Unique identifiers for groupings and summaries.

    -
    reportTypeMetadata

    Fields in each section of a report type plus filter information for those fields.

    -
    reportExtendedMetadata

    Additional information about summaries and groupings.

    -
    - -

    Salesforce Documentation

    - - +
    reportMetadata
    +

    Unique identifiers for groupings and summaries.

    - +
    reportTypeMetadata
    +

    Fields in each section of a report type plus filter information for those fields.

    -

    See also

    +
    reportExtendedMetadata
    +

    Additional information about summaries and groupings.

    -

    Other Report functions: -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    -

    Examples

    - 
    if (FALSE) {
-# only the 200 most recently viewed reports
-most_recent_reports <- sf_report_list()
-
-# all possible reports in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-
-# id of the report to copy
-this_report_id <- all_reports$Id[1]
+
    +
    +

    Salesforce Documentation

    + -# not providing a name appends " - Copy" to the name of the report being cloned -report_details <- sf_copy_report(this_report_id) +
    + -# example of providing new name to the copied report -report_details <- sf_copy_report(this_report_id, "My New Copy of Report ABC") -} -
    +
    +

    Examples

    + 
    if (FALSE) {
+# only the 200 most recently viewed reports
+most_recent_reports <- sf_report_list()
+
+# all possible reports in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+
+# id of the report to copy
+this_report_id <- all_reports$Id[1]
+
+# not providing a name appends " - Copy" to the name of the report being cloned
+report_details <- sf_copy_report(this_report_id)
+
+# example of providing new name to the copied report
+report_details <- sf_copy_report(this_report_id, "My New Copy of Report ABC")
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create.html b/docs/reference/sf_create.html index 4a2ff098..5418d8b9 100644 --- a/docs/reference/sf_create.html +++ b/docs/reference/sf_create.html @@ -1,92 +1,19 @@ - - - - - - - -Create Records — sf_create • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Records — sf_create • salesforcer - - - - - - - - + + -
    -
    -

    Create Records

    - Source: R/create.R + Source: R/create.R
    -

    [Stable]

    +

    [Stable]

    Adds one or more new records to your organization’s data.

    - 
    sf_create(
-  input_data,
-  object_name,
-  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
-  guess_types = TRUE,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_create(
+  input_data,
+  object_name,
+  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
+  guess_types = TRUE,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    input_data

    named vector, matrix, data.frame, or +

    +

    Arguments

    +
    input_data
    +

    named vector, matrix, data.frame, or tbl_df; data can be coerced into a data.frame. If performing an update, upsert, or delete operation, then one column or -field must be the Id of the record to modify or delete.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +field must be the Id of the record to modify or delete.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    guess_types

    logical; indicating whether or not to use col_guess() +making the request.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    control

    list; a list of parameters for controlling the behavior of +like numeric looking values that must be preserved as strings ("48.0").

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    -

    Note

    - +
    +
    +

    Note

    Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 2
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact", 1:n))
-new_recs1 <- sf_create(new_contacts, object_name = "Contact")
-
-# add control to allow the creation of records that violate a duplicate rules
-new_recs2 <- sf_create(new_contacts, object_name = "Contact", 
-                       DuplicateRuleHeader=list(allowSave=TRUE,
-                                                includeRecordDetails=FALSE,
-                                                runAsCurrentUser=TRUE))
-                                                  
-# example using the Bulk 1.0 API to insert records
-new_recs3 <- sf_create(new_contacts, object_name = "Contact", 
-                       api_type = "Bulk 1.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 2
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact", 1:n))
+new_recs1 <- sf_create(new_contacts, object_name = "Contact")
+
+# add control to allow the creation of records that violate a duplicate rules
+new_recs2 <- sf_create(new_contacts, object_name = "Contact", 
+                       DuplicateRuleHeader=list(allowSave=TRUE,
+                                                includeRecordDetails=FALSE,
+                                                runAsCurrentUser=TRUE))
+                                                  
+# example using the Bulk 1.0 API to insert records
+new_recs3 <- sf_create(new_contacts, object_name = "Contact", 
+                       api_type = "Bulk 1.0")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_attachment.html b/docs/reference/sf_create_attachment.html index bbf8281f..3991d307 100644 --- a/docs/reference/sf_create_attachment.html +++ b/docs/reference/sf_create_attachment.html @@ -1,95 +1,22 @@ - - - - - - - -Create Attachments — sf_create_attachment • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Attachments — sf_create_attachment • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Create Attachments

    - Source: R/attachments.R + Source: R/attachments.R
    -

    [Experimental]

    +

    [Experimental]

    This function will allow you to create attachments (and other blob data, such as Documents) by supplying file paths (absolute or relative) to media that you would like to upload to Salesforce along with accompanying metadata, such as a Description, Keywords, ParentId, FolderId, etc.

    - 
    sf_create_attachment(
-  attachment_input_data,
-  object_name = c("Attachment", "Document"),
-  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_create_attachment(
+  attachment_input_data,
+  object_name = c("Attachment", "Document"),
+  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    attachment_input_data

    named vector, matrix, +

    +

    Arguments

    +
    attachment_input_data
    +

    named vector, matrix, data.frame, or tbl_df; data can be coerced into a data.frame. The input must contain a column entitled 'Body' with an absolute or relative file path (unless creating a Document using a Url) along with other required fields depending on the object.If performing an update operation, then one column or field of the input must be -the Id of the record to modify.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +the Id of the record to modify.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df with details of the created records

    -

    Note

    - +
    +
    +

    Note

    The length of any file name can’t exceed 512 bytes (per Bulk 1.0 API). The SOAP API create call restricts these files to a maximum size of 25 MB. For a file attached to a Solution, the limit is 1.5 MB. The maximum email attachment size is 3 MB. You can only create or update documents to a maximum size of 5 MB. The REST API allows you to insert or update blob data limited to 50 MB of text data or 37.5 MB of base64–encoded data.

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Attachment functions: -check_and_encode_files(), -sf_delete_attachment(), -sf_download_attachment(), -sf_update_attachment()

    - -

    Examples

    - 
    if (FALSE) {
-# upload two PDFs from working directory to a particular record as Attachments
-file_path1 <- here::here("doc1.pdf")
-file_path2 <- here::here("doc2.pdf")
-parent_record_id <- "0036A000002C6MmQAK"
-attachment_details <- tibble(Body = c(file_path1, file_path2), 
-                             ParentId = rep(parent_record_id, 2))
-result <- sf_create_attachment(attachment_details)
-
-# the function supports inserting all blob content, just update the 
-# object_name argument to add the PDF as a Document instead of an Attachment
-document_details <- tibble(Name = "doc1.pdf", 
-                           Description = "Test Document 1", 
-                           Body = file_path1,
-                           FolderId = "00l6A000001EgIwQAK", # replace with your FolderId!
-                           Keywords = "example,test,document")
-result <- sf_create_attachment(document_details, object_name = "Document")
+
    
+    
    
+    
    See also
    
+    
    Other Attachment functions: 
+check_and_encode_files(),
+sf_delete_attachment(),
+sf_download_attachment(),
+sf_update_attachment()
    
+    
    
 
-# the Bulk API can be invoked using api_type="Bulk 1.0" which will automatically 
-# take a data.frame of Attachment info and create a ZIP file with CSV manifest 
-# that is required for that API
-result <- sf_create_attachment(attachment_details, api_type="Bulk 1.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# upload two PDFs from working directory to a particular record as Attachments
+file_path1 <- here::here("doc1.pdf")
+file_path2 <- here::here("doc2.pdf")
+parent_record_id <- "0036A000002C6MmQAK"
+attachment_details <- tibble(Body = c(file_path1, file_path2), 
+                             ParentId = rep(parent_record_id, 2))
+result <- sf_create_attachment(attachment_details)
+
+# the function supports inserting all blob content, just update the 
+# object_name argument to add the PDF as a Document instead of an Attachment
+document_details <- tibble(Name = "doc1.pdf", 
+                           Description = "Test Document 1", 
+                           Body = file_path1,
+                           FolderId = "00l6A000001EgIwQAK", # replace with your FolderId!
+                           Keywords = "example,test,document")
+result <- sf_create_attachment(document_details, object_name = "Document")
+
+# the Bulk API can be invoked using api_type="Bulk 1.0" which will automatically 
+# take a data.frame of Attachment info and create a ZIP file with CSV manifest 
+# that is required for that API
+result <- sf_create_attachment(attachment_details, api_type="Bulk 1.0")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_attachment_bulk_v1.html b/docs/reference/sf_create_attachment_bulk_v1.html index a0fabed3..a8518827 100644 --- a/docs/reference/sf_create_attachment_bulk_v1.html +++ b/docs/reference/sf_create_attachment_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Create Attachments using Bulk 1.0 API — sf_create_attachment_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Attachments using Bulk 1.0 API — sf_create_attachment_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Create Attachments using Bulk 1.0 API

    - Source: R/attachments.R + Source: R/attachments.R
    @@ -188,48 +105,45 @@

    Create Attachments using Bulk 1.0 API

    Create Attachments using Bulk 1.0 API

    - 
    sf_create_attachment_bulk_v1(
-  attachment_input_data,
-  object_name = c("Attachment", "Document"),
-  content_type = "ZIP_CSV",
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_attachment_bulk_v1(
+  attachment_input_data,
+  object_name = c("Attachment", "Document"),
+  content_type = "ZIP_CSV",
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_attachment_rest.html b/docs/reference/sf_create_attachment_rest.html index d1473673..c852e591 100644 --- a/docs/reference/sf_create_attachment_rest.html +++ b/docs/reference/sf_create_attachment_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Create Attachment using REST API — sf_create_attachment_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Attachment using REST API — sf_create_attachment_rest • salesforcer - - - - - - - - + + -
    -
    -

    Create Attachment using REST API

    - Source: R/attachments.R + Source: R/attachments.R
    @@ -188,47 +105,44 @@

    Create Attachment using REST API

    Create Attachment using REST API

    - 
    sf_create_attachment_rest(
-  attachment_input_data,
-  object_name = c("Attachment", "Document"),
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_attachment_rest(
+  attachment_input_data,
+  object_name = c("Attachment", "Document"),
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_attachment_soap.html b/docs/reference/sf_create_attachment_soap.html index e760054d..25be2f2f 100644 --- a/docs/reference/sf_create_attachment_soap.html +++ b/docs/reference/sf_create_attachment_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Create Attachment using SOAP API — sf_create_attachment_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Attachment using SOAP API — sf_create_attachment_soap • salesforcer - - - - - - - - + + -
    -
    -

    Create Attachment using SOAP API

    - Source: R/attachments.R + Source: R/attachments.R
    @@ -188,47 +105,44 @@

    Create Attachment using SOAP API

    Create Attachment using SOAP API

    - 
    sf_create_attachment_soap(
-  attachment_input_data,
-  object_name = c("Attachment", "Document"),
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_attachment_soap(
+  attachment_input_data,
+  object_name = c("Attachment", "Document"),
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_batches_bulk.html b/docs/reference/sf_create_batches_bulk.html index 9d21c8a8..4472edb8 100644 --- a/docs/reference/sf_create_batches_bulk.html +++ b/docs/reference/sf_create_batches_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Add Batches to a Bulk API Job — sf_create_batches_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Add Batches to a Bulk API Job — sf_create_batches_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Add Batches to a Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -190,104 +107,93 @@

    Add Batches to a Bulk API Job

    an already existing Bulk API Job by chunking into temp files

    - 
    sf_create_batches_bulk(
-  job_id,
-  input_data,
-  batch_size = NULL,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_create_batches_bulk(
+  job_id,
+  input_data,
+  batch_size = NULL,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    input_data

    named vector, matrix, data.frame, or -tbl_df; data can be coerced into CSV file for submitting as batch request

    batch_size

    integer; the number of individual records to be included in a -single batch uploaded to the Bulk APIs (1.0 or 2.0).

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    input_data
    +

    named vector, matrix, data.frame, or +tbl_df; data can be coerced into CSV file for submitting as batch request

    +
    batch_size
    +

    integer; the number of individual records to be included in a +single batch uploaded to the Bulk APIs (1.0 or 2.0).

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    a tbl_df containing details of each batch

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-# NOTE THAT YOU MUST FIRST CREATE AN EXTERNAL ID FIELD CALLED My_External_Id 
-# BEFORE RUNNING THIS EXAMPLE
-# inserting 2 records
-my_data <- tibble(Name=c('New Record 1', 'New Record 2'),
-                  My_External_Id__c=c('11111','22222'))
-job_info <- sf_create_job_bulk(operation='insert',
-                               object='Account')
-batches_ind <- sf_create_batches_bulk(job_id = job_info$id,
-                                      input_data = my_data)
-# upserting 3 records
-my_data2 <- tibble(My_External_Id__c=c('11111','22222', '99999'), 
-                  Name=c('Updated_Name1', 'Updated_Name2', 'Upserted_Record')) 
-job_info <- sf_create_job_bulk(operation='upsert',
-                               externalIdFieldName='My_External_Id__c',
-                               object='Account')
-batches_ind <- sf_create_batches_bulk(job_id = job_info$id,
-                                      input_data = my_data2)
-sf_get_job_bulk(job_info$id)                                     
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# NOTE THAT YOU MUST FIRST CREATE AN EXTERNAL ID FIELD CALLED My_External_Id 
+# BEFORE RUNNING THIS EXAMPLE
+# inserting 2 records
+my_data <- tibble(Name=c('New Record 1', 'New Record 2'),
+                  My_External_Id__c=c('11111','22222'))
+job_info <- sf_create_job_bulk(operation='insert',
+                               object='Account')
+batches_ind <- sf_create_batches_bulk(job_id = job_info$id,
+                                      input_data = my_data)
+# upserting 3 records
+my_data2 <- tibble(My_External_Id__c=c('11111','22222', '99999'), 
+                  Name=c('Updated_Name1', 'Updated_Name2', 'Upserted_Record')) 
+job_info <- sf_create_job_bulk(operation='upsert',
+                               externalIdFieldName='My_External_Id__c',
+                               object='Account')
+batches_ind <- sf_create_batches_bulk(job_id = job_info$id,
+                                      input_data = my_data2)
+sf_get_job_bulk(job_info$id)                                     
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_bulk_v1.html b/docs/reference/sf_create_bulk_v1.html index 9d542526..e5b08a62 100644 --- a/docs/reference/sf_create_bulk_v1.html +++ b/docs/reference/sf_create_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Create Records using Bulk 1.0 API — sf_create_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Records using Bulk 1.0 API — sf_create_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Create Records using Bulk 1.0 API

    - Source: R/create.R + Source: R/create.R
    @@ -188,48 +105,45 @@

    Create Records using Bulk 1.0 API

    Create Records using Bulk 1.0 API

    - 
    sf_create_bulk_v1(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_bulk_v1(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_bulk_v2.html b/docs/reference/sf_create_bulk_v2.html index 5858d04e..7706e6d6 100644 --- a/docs/reference/sf_create_bulk_v2.html +++ b/docs/reference/sf_create_bulk_v2.html @@ -1,91 +1,18 @@ - - - - - - - -Create Records using Bulk 2.0 API — sf_create_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Records using Bulk 2.0 API — sf_create_bulk_v2 • salesforcer - - - - - - - - + + -
    -
    -

    Create Records using Bulk 2.0 API

    - Source: R/create.R + Source: R/create.R
    @@ -188,48 +105,45 @@

    Create Records using Bulk 2.0 API

    Create Records using Bulk 2.0 API

    - 
    sf_create_bulk_v2(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_bulk_v2(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_job_bulk.html b/docs/reference/sf_create_job_bulk.html index 725669e2..44978a11 100644 --- a/docs/reference/sf_create_job_bulk.html +++ b/docs/reference/sf_create_job_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Create Bulk API Job — sf_create_job_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Bulk API Job — sf_create_job_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Create Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,159 +105,134 @@

    Create Bulk API Job

    This function initializes a Job in the Salesforce Bulk API

    - 
    sf_create_job_bulk(
-  operation = c("insert", "delete", "upsert", "update", "hardDelete", "query",
-    "queryall"),
-  object_name,
-  soql = NULL,
-  external_id_fieldname = NULL,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"),
-  concurrency_mode = c("Parallel", "Serial"),
-  column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"),
-  control = list(...),
-  ...,
-  line_ending = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_create_job_bulk(
+  operation = c("insert", "delete", "upsert", "update", "hardDelete", "query",
+    "queryall"),
+  object_name,
+  soql = NULL,
+  external_id_fieldname = NULL,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"),
+  concurrency_mode = c("Parallel", "Serial"),
+  column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"),
+  control = list(...),
+  ...,
+  line_ending = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    operation

    character; a string defining the type of operation being +

    +

    Arguments

    +
    operation
    +

    character; a string defining the type of operation being performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", -"query", "queryall").

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    soql

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    external_id_fieldname

    character; string identifying a custom field on the +"query", "queryall").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    external_id_fieldname
    +

    character; string identifying a custom field on the object that has been set as an "External ID" field. This field is used to reference -objects during upserts to determine if the record already exists in Salesforce or not.

    api_type

    character; one of "REST", "SOAP", +objects during upserts to determine if the record already exists in Salesforce or not.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    content_type

    character; being one of 'CSV', 'ZIP_CSV', 'ZIP_XML', or 'ZIP_JSON' to +making the request.

    +
    content_type
    +

    character; being one of 'CSV', 'ZIP_CSV', 'ZIP_XML', or 'ZIP_JSON' to indicate the type of data being passed to the Bulk APIs. For the Bulk 2.0 API the only -valid value (and the default) is 'CSV'.

    concurrency_mode

    character; either "Parallel" or "Serial" that specifies +valid value (and the default) is 'CSV'.

    +
    concurrency_mode
    +

    character; either "Parallel" or "Serial" that specifies whether batches should be completed sequentially or in parallel. Use "Serial" only if lock contentions persist with in "Parallel" mode. Note: this argument is -only used in the Bulk 1.0 API and will be ignored in calls using the Bulk 2.0 API.

    column_delimiter

    character; indicating the column delimiter used for CSV job data. +only used in the Bulk 1.0 API and will be ignored in calls using the Bulk 2.0 API.

    +
    column_delimiter
    +

    character; indicating the column delimiter used for CSV job data. The default value is COMMA. Valid values are: "BACKQUOTE", "CARET", "COMMA", "PIPE", "SEMICOLON", and "TAB", but this package only accepts and uses "COMMA". Also, note that this argument is only used in the Bulk 2.0 API and will be ignored -in calls using the Bulk 1.0 API.

    control

    list; a list of parameters for controlling the behavior of +in calls using the Bulk 1.0 API.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    line_ending

    character; indicating the The line ending used for +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    line_ending
    +

    character; indicating the The line ending used for CSV job data, marking the end of a data row. The default is NULL and determined by the operating system using "CRLF" for Windows machines and "LF" for Unix machines. NOTE: As of readr v1.3.1 all CSV files end with the line feed character ("\n") regardless of the operating system. So it is usually -best to not specify this argument.

    verbose

    logical; an indicator of whether to print additional +best to not specify this argument.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df parameters defining the created job, including id

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    - -

    Examples

    - 
    if (FALSE) {
-# insert into Account
-job_info <- sf_create_job_bulk(operation='insert', object_name='Account')
-
-# delete from Account
-job_info <- sf_create_job_bulk(operation='delete', object_name='Account')
-
-# update into Account
-job_info <- sf_create_job_bulk(operation='update', object_name='Account')
-
-# upsert into Account
-job_info <- sf_create_job_bulk(operation='upsert',
-                               externalIdFieldName='My_External_Id__c',
-                               object_name='Account')
-# insert attachments
-job_info <- sf_create_job_bulk(operation='insert', object_name='Attachment')
+    
    
+    
 
-# query leads
-job_info <- sf_create_job_bulk(operation='query', object_name='Lead')
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# insert into Account
+job_info <- sf_create_job_bulk(operation='insert', object_name='Account')
+
+# delete from Account
+job_info <- sf_create_job_bulk(operation='delete', object_name='Account')
+
+# update into Account
+job_info <- sf_create_job_bulk(operation='update', object_name='Account')
+
+# upsert into Account
+job_info <- sf_create_job_bulk(operation='upsert',
+                               externalIdFieldName='My_External_Id__c',
+                               object_name='Account')
+# insert attachments
+job_info <- sf_create_job_bulk(operation='insert', object_name='Attachment')
+
+# query leads
+job_info <- sf_create_job_bulk(operation='query', object_name='Lead')
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_job_bulk_v1.html b/docs/reference/sf_create_job_bulk_v1.html index 6703e635..62ab6d32 100644 --- a/docs/reference/sf_create_job_bulk_v1.html +++ b/docs/reference/sf_create_job_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Create Job using Bulk 1.0 API — sf_create_job_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Job using Bulk 1.0 API — sf_create_job_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Create Job using Bulk 1.0 API

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,51 +105,86 @@

    Create Job using Bulk 1.0 API

    Create Job using Bulk 1.0 API

    - 
    sf_create_job_bulk_v1(
-  operation = c("insert", "delete", "upsert", "update", "hardDelete", "query",
-    "queryall"),
-  object_name,
-  external_id_fieldname = NULL,
-  content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"),
-  concurrency_mode = c("Parallel", "Serial"),
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_job_bulk_v1(
+  operation = c("insert", "delete", "upsert", "update", "hardDelete", "query",
+    "queryall"),
+  object_name,
+  external_id_fieldname = NULL,
+  content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"),
+  concurrency_mode = c("Parallel", "Serial"),
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Arguments

    +
    operation
    +

    character; a string defining the type of operation being +performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", +"query", "queryall").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    external_id_fieldname
    +

    character; string identifying a custom field on the +object that has been set as an "External ID" field. This field is used to reference +objects during upserts to determine if the record already exists in Salesforce or not.

    +
    content_type
    +

    character; a string indicating the format for +the API request and response. Must be one of 'CSV', 'ZIP_CSV', 'ZIP_XML', or +'ZIP_JSON'.

    +
    concurrency_mode
    +

    character; a string indicating whether the batches +should be processed in parallel or serially (sequentially). Serial processing +is helpful when multiple records may trigger simultaneous edits to another +related record (e.g., updating multiple children all on the same account).

    +
    control
    +

    list; a list of parameters for controlling the behavior of +the API call being used. For more information of what parameters are available +look at the documentation for sf_control.

    +
    ...
    +

    arguments to be used to form the default control argument if it is not supplied directly.

    +
    verbose
    +

    logical; an indicator of whether to print additional +detail for each API call, which is useful for debugging. More specifically, when +set to TRUE the URL, header, and body will be printed for each request, +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    tbl_df; a data frame containing information about the job created.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_job_bulk_v2.html b/docs/reference/sf_create_job_bulk_v2.html index 8a9183de..25afba52 100644 --- a/docs/reference/sf_create_job_bulk_v2.html +++ b/docs/reference/sf_create_job_bulk_v2.html @@ -1,91 +1,18 @@ - - - - - - - -Create Job using Bulk 2.0 API — sf_create_job_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Job using Bulk 2.0 API — sf_create_job_bulk_v2 • salesforcer - - - - - - - - + + -
    -
    -

    Create Job using Bulk 2.0 API

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,51 +105,88 @@

    Create Job using Bulk 2.0 API

    Create Job using Bulk 2.0 API

    - 
    sf_create_job_bulk_v2(
-  operation = c("insert", "delete", "upsert", "update", "query", "queryall"),
-  object_name,
-  soql = NULL,
-  external_id_fieldname = NULL,
-  content_type = "CSV",
-  column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"),
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_job_bulk_v2(
+  operation = c("insert", "delete", "upsert", "update", "query", "queryall"),
+  object_name,
+  soql = NULL,
+  external_id_fieldname = NULL,
+  content_type = "CSV",
+  column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"),
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Arguments

    +
    operation
    +

    character; a string defining the type of operation being +performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", +"query", "queryall").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    external_id_fieldname
    +

    character; string identifying a custom field on the +object that has been set as an "External ID" field. This field is used to reference +objects during upserts to determine if the record already exists in Salesforce or not.

    +
    content_type
    +

    character; a string indicating the format for +the API request and response. Must be 'CSV' because it is the only supported +format for the Bulk 2.0 API.

    +
    column_delimiter
    +

    character; a string indicating which character +should be treated as the delimiter in the CSV file. Must be one of 'COMMA', +'TAB', 'PIPE', 'SEMICOLON', 'CARET', or 'BACKQUOTE'.

    +
    control
    +

    list; a list of parameters for controlling the behavior of +the API call being used. For more information of what parameters are available +look at the documentation for sf_control.

    +
    ...
    +

    arguments to be used to form the default control argument if it is not supplied directly.

    +
    verbose
    +

    logical; an indicator of whether to print additional +detail for each API call, which is useful for debugging. More specifically, when +set to TRUE the URL, header, and body will be printed for each request, +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    tbl_df; a data frame containing information about the job created.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_metadata.html b/docs/reference/sf_create_metadata.html index ecd0d5db..839c9807 100644 --- a/docs/reference/sf_create_metadata.html +++ b/docs/reference/sf_create_metadata.html @@ -1,93 +1,20 @@ - - - - - - - -Create Object or Field Metadata in Salesforce — sf_create_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Object or Field Metadata in Salesforce — sf_create_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Create Object or Field Metadata in Salesforce

    - Source: R/create-metadata.R + Source: R/create-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes a list of Metadata components and sends them to Salesforce for creation

    - 
    sf_create_metadata(
-  metadata_type,
-  metadata,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_create_metadata(
+  metadata_type,
+  metadata,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    metadata_type

    character; string on what type of metadata to create.

    metadata

    list; metadata components to be created formatted as -XML before being sent via API.

    control

    list; a list of parameters for controlling the behavior of +

    +

    Arguments

    +
    metadata_type
    +

    character; string on what type of metadata to create.

    +
    metadata
    +

    list; metadata components to be created formatted as +XML before being sent via API.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df containing the creation result for each submitted metadata component

    -

    See also

    - -

    Salesforce Documentation

    - -

    Examples

    - 
    if (FALSE) {
-# read the metadata of the existing Account object
-# we will use this object as a template to create a custom version
-metadata_info <- sf_read_metadata(metadata_type='CustomObject',
-                                  object_names=c('Account'))
-custom_metadata <- metadata_info[[1]]
-# remove default actionOverrides, this cannot be set during creation
-custom_metadata[which(names(custom_metadata) %in% c("actionOverrides"))] <- NULL
-# remove fields since its a custom object and the standard ones no longer exist
-custom_metadata[which(names(custom_metadata) %in% c("fields"))] <- NULL
-# remove views so that we get the Standard List Views
-custom_metadata[which(names(custom_metadata) %in% c("listViews"))] <- NULL
-# remove links so that we get the Standard Web Links
-custom_metadata[which(names(custom_metadata) %in% c("webLinks"))] <- NULL
-# now make some adjustments to customize the object
-this_label <- 'Custom_Account43'
-custom_metadata$fullName <- paste0(this_label, '__c')
-custom_metadata$label <- this_label
-custom_metadata$pluralLabel <- paste0(this_label, 's')
-custom_metadata$nameField <- list(displayFormat='AN-{0000}',
-                                  label='Account Number',
-                                  type='AutoNumber')
-custom_metadata$fields <- list(fullName="Phone__c",
-                               label="Phone",
-                               type="Phone")
-# set the deployment status, this must be set before creation
-custom_metadata$deploymentStatus <- 'Deployed'
-# make a description to identify this easily in the UI setup tab
-custom_metadata$description <- 'created by the Metadata API'
-new_custom_object <- sf_create_metadata(metadata_type = 'CustomObject',
-                                        metadata = custom_metadata, 
-                                        verbose = TRUE)
+    
    
+    
    
+    
    See also
    
+    
    Salesforce Documentation
    
+    
    
 
-# adding custom fields to our object 
-# input formatted as a list
-custom_fields <- list(list(fullName='Custom_Account43__c.CustomField66__c',
-                           label='CustomField66',
-                           length=100,
-                           type='Text'),
-                      list(fullName='Custom_Account43__c.CustomField77__c',
-                           label='CustomField77',
-                           length=100,
-                           type='Text'))
-# formatted as a data.frame
-custom_fields <- data.frame(fullName=c('Custom_Account43__c.CustomField88__c',
-                                       'Custom_Account43__c.CustomField99__c'),
-                            label=c('Test Field1', 'Test Field2'),
-                            length=c(44,45),
-                            type=c('Text', 'Text'))
-new_custom_fields <- sf_create_metadata(metadata_type = 'CustomField', 
-                                        metadata = custom_fields)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# read the metadata of the existing Account object
+# we will use this object as a template to create a custom version
+metadata_info <- sf_read_metadata(metadata_type='CustomObject',
+                                  object_names=c('Account'))
+custom_metadata <- metadata_info[[1]]
+# remove default actionOverrides, this cannot be set during creation
+custom_metadata[which(names(custom_metadata) %in% c("actionOverrides"))] <- NULL
+# remove fields since its a custom object and the standard ones no longer exist
+custom_metadata[which(names(custom_metadata) %in% c("fields"))] <- NULL
+# remove views so that we get the Standard List Views
+custom_metadata[which(names(custom_metadata) %in% c("listViews"))] <- NULL
+# remove links so that we get the Standard Web Links
+custom_metadata[which(names(custom_metadata) %in% c("webLinks"))] <- NULL
+# now make some adjustments to customize the object
+this_label <- 'Custom_Account43'
+custom_metadata$fullName <- paste0(this_label, '__c')
+custom_metadata$label <- this_label
+custom_metadata$pluralLabel <- paste0(this_label, 's')
+custom_metadata$nameField <- list(displayFormat='AN-{0000}',
+                                  label='Account Number',
+                                  type='AutoNumber')
+custom_metadata$fields <- list(fullName="Phone__c",
+                               label="Phone",
+                               type="Phone")
+# set the deployment status, this must be set before creation
+custom_metadata$deploymentStatus <- 'Deployed'
+# make a description to identify this easily in the UI setup tab
+custom_metadata$description <- 'created by the Metadata API'
+new_custom_object <- sf_create_metadata(metadata_type = 'CustomObject',
+                                        metadata = custom_metadata, 
+                                        verbose = TRUE)
+
+# adding custom fields to our object 
+# input formatted as a list
+custom_fields <- list(list(fullName='Custom_Account43__c.CustomField66__c',
+                           label='CustomField66',
+                           length=100,
+                           type='Text'),
+                      list(fullName='Custom_Account43__c.CustomField77__c',
+                           label='CustomField77',
+                           length=100,
+                           type='Text'))
+# formatted as a data.frame
+custom_fields <- data.frame(fullName=c('Custom_Account43__c.CustomField88__c',
+                                       'Custom_Account43__c.CustomField99__c'),
+                            label=c('Test Field1', 'Test Field2'),
+                            length=c(44,45),
+                            type=c('Text', 'Text'))
+new_custom_fields <- sf_create_metadata(metadata_type = 'CustomField', 
+                                        metadata = custom_fields)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_report.html b/docs/reference/sf_create_report.html index bb4a2e81..7a19bcdb 100644 --- a/docs/reference/sf_create_report.html +++ b/docs/reference/sf_create_report.html @@ -1,96 +1,23 @@ - - - - - - - -Create a report — sf_create_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a report — sf_create_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Create a report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Create a new report using a POST request. To create a report, you only have to specify a name and report type to create a new report; all other metadata properties are optional. It is recommended to use the metadata from existing reports pulled -using sf_describe_report as a guide on how to specify the properties +using sf_describe_report as a guide on how to specify the properties of a new report.

    - 
    sf_create_report(
-  name = NULL,
-  report_type = NULL,
-  report_metadata = NULL,
-  verbose = FALSE
-)
    +
    + 
    sf_create_report(
+  name = NULL,
+  report_type = NULL,
+  report_metadata = NULL,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    name

    character; a user-specified name for the report.

    report_type

    character; a character representing the type of +

    +

    Arguments

    +
    name
    +

    character; a user-specified name for the report.

    +
    report_type
    +

    character; a character representing the type of report to retrieve the metadata information on. A list of valid report types that can be created using this function will be available in the -reportTypes.type column of results returned sf_list_report_types. +reportTypes.type column of results returned sf_list_report_types. (e.g. AccountList, AccountContactRole, OpportunityHistory, -etc.)

    report_metadata

    list; a list representing the properties to create +etc.)

    +
    report_metadata
    +

    list; a list representing the properties to create the report with. The names of the list must be one or more of the 3 accepted metadata properties: reportMetadata, reportTypeMetadata, -reportExtendedMetadata.

    verbose

    logical; an indicator of whether to print additional +reportExtendedMetadata.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list representing the newly cloned report with up to 4 properties -that describe the report:

    -
    attributes

    Report type along with the URL to retrieve common objects and +that describe the report:

    attributes
    +

    Report type along with the URL to retrieve common objects and joined metadata.

    -
    reportMetadata

    Unique identifiers for groupings and summaries.

    -
    reportTypeMetadata

    Fields in each section of a report type plus filter information for those fields.

    -
    reportExtendedMetadata

    Additional information about summaries and groupings.

    - -
    - -

    Salesforce Documentation

    - - - +
    reportMetadata
    +

    Unique identifiers for groupings and summaries.

    -

    See also

    +
    reportTypeMetadata
    +

    Fields in each section of a report type plus filter information for those fields.

    -

    Other Report functions: -sf_copy_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    +
    reportExtendedMetadata
    +

    Additional information about summaries and groupings.

    -

    Examples

    - 
    if (FALSE) {
-# creating a blank report using just the name and type
-my_new_report <- sf_create_report("Top Accounts Report", "AccountList")
 
-# creating a report with additional metadata by grabbing an existing report
-# and modifying it slightly (only the name in this case)
-
-# first, grab all possible reports in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-
-# second, get the id of the report to copy
-this_report_id <- all_reports$Id[1]
+
    +
    +

    Salesforce Documentation

    + -# third, pull down its metadata and update the name -report_describe_list <- sf_describe_report(this_report_id) -report_describe_list$reportMetadata$name <- "TEST API Report Creation" +
    + -# fourth, create the report by passing the metadata -my_new_report <- sf_create_report(report_metadata=report_describe_list) -} -
    +
    +

    Examples

    + 
    if (FALSE) {
+# creating a blank report using just the name and type
+my_new_report <- sf_create_report("Top Accounts Report", "AccountList")
+
+# creating a report with additional metadata by grabbing an existing report
+# and modifying it slightly (only the name in this case)
+
+# first, grab all possible reports in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+
+# second, get the id of the report to copy
+this_report_id <- all_reports$Id[1]
+
+# third, pull down its metadata and update the name
+report_describe_list <- sf_describe_report(this_report_id)
+report_describe_list$reportMetadata$name <- "TEST API Report Creation"
+
+# fourth, create the report by passing the metadata
+my_new_report <- sf_create_report(report_metadata=report_describe_list)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_rest.html b/docs/reference/sf_create_rest.html index 81d16452..2ec1f5e6 100644 --- a/docs/reference/sf_create_rest.html +++ b/docs/reference/sf_create_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Create Records using REST API — sf_create_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Records using REST API — sf_create_rest • salesforcer - - - - - - - - + + -
    -
    -

    Create Records using REST API

    - Source: R/create.R + Source: R/create.R
    @@ -188,48 +105,45 @@

    Create Records using REST API

    Create Records using REST API

    - 
    sf_create_rest(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_rest(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_create_soap.html b/docs/reference/sf_create_soap.html index 28d10c51..9f247230 100644 --- a/docs/reference/sf_create_soap.html +++ b/docs/reference/sf_create_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Create Records using SOAP API — sf_create_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create Records using SOAP API — sf_create_soap • salesforcer - - - - - - - - + + -
    -
    -

    Create Records using SOAP API

    - Source: R/create.R + Source: R/create.R
    @@ -188,48 +105,45 @@

    Create Records using SOAP API

    Create Records using SOAP API

    - 
    sf_create_soap(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_create_soap(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_components_describe.html b/docs/reference/sf_dashboard_components_describe.html index eb402d40..76a52c28 100644 --- a/docs/reference/sf_dashboard_components_describe.html +++ b/docs/reference/sf_dashboard_components_describe.html @@ -1,91 +1,18 @@ - - - - - - - -Describe dashboard components — sf_dashboard_components_describe • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe dashboard components — sf_dashboard_components_describe • salesforcer - - - - - - - - + + -
    -
    -

    Describe dashboard components

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_components_describe(dashboard_id, component_ids = c(character(0)))
    - -

    Arguments

    - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    component_ids

    character; a vector of Unique Salesforce Ids of a -dashboard component.

    - -

    Value

    +
    + 
    sf_dashboard_components_describe(dashboard_id, component_ids = c(character(0)))
    +
    +
    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    component_ids
    +

    character; a vector of Unique Salesforce Ids of a +dashboard component.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_copy.html b/docs/reference/sf_dashboard_copy.html index a133683b..184d46e0 100644 --- a/docs/reference/sf_dashboard_copy.html +++ b/docs/reference/sf_dashboard_copy.html @@ -1,91 +1,18 @@ - - - - - - - -Copy a dashboard — sf_dashboard_copy • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Copy a dashboard — sf_dashboard_copy • salesforcer - - - - - - - - + + -
    -
    -

    Copy a dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_copy(dashboard_id, report_folder_id)
    - -

    Arguments

    - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    - -

    Value

    +
    + 
    sf_dashboard_copy(dashboard_id, report_folder_id)
    +
    +
    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_delete.html b/docs/reference/sf_dashboard_delete.html index f6ca2d44..bfad253a 100644 --- a/docs/reference/sf_dashboard_delete.html +++ b/docs/reference/sf_dashboard_delete.html @@ -1,91 +1,18 @@ - - - - - - - -Delete a dashboard — sf_dashboard_delete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete a dashboard — sf_dashboard_delete • salesforcer - - - - - - - - + + -
    -
    -

    Delete a dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_delete(dashboard_id)
    - -

    Arguments

    - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    - -

    Value

    +
    + 
    sf_dashboard_delete(dashboard_id)
    +
    +
    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    +
    +

    Value

    logical

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_describe.html b/docs/reference/sf_dashboard_describe.html index 15b29422..905b3831 100644 --- a/docs/reference/sf_dashboard_describe.html +++ b/docs/reference/sf_dashboard_describe.html @@ -1,93 +1,20 @@ - - - - - - - -Describe a dashboard — sf_dashboard_describe • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe a dashboard — sf_dashboard_describe • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Describe a dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    Returns metadata for the specified dashboard, including dashboard components, filters, layout, and the running user.

    - 
    sf_dashboard_describe(dashboard_id, as_tbl = TRUE, verbose = FALSE)
    +
    + 
    sf_dashboard_describe(dashboard_id, as_tbl = TRUE, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list or tbl_df depending on the value of argument as_tbl

    -

    See also

    - -
    - -
    +
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_filter_operators_list.html b/docs/reference/sf_dashboard_filter_operators_list.html index b0fd50c0..0cdc8fd1 100644 --- a/docs/reference/sf_dashboard_filter_operators_list.html +++ b/docs/reference/sf_dashboard_filter_operators_list.html @@ -1,91 +1,18 @@ - - - - - - - -List dashboard filter operators — sf_dashboard_filter_operators_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List dashboard filter operators — sf_dashboard_filter_operators_list • salesforcer - - - - - - - - + + -
    -
    -

    List dashboard filter operators

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_filter_operators_list()
    - - -

    Value

    +
    + 
    sf_dashboard_filter_operators_list()
    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_filter_options_analysis.html b/docs/reference/sf_dashboard_filter_options_analysis.html index a8f03b31..bca7e0fa 100644 --- a/docs/reference/sf_dashboard_filter_options_analysis.html +++ b/docs/reference/sf_dashboard_filter_options_analysis.html @@ -1,91 +1,18 @@ - - - - - - - -Get an analysis of the filter options for a dashboard — sf_dashboard_filter_options_analysis • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get an analysis of the filter options for a dashboard — sf_dashboard_filter_options_analysis • salesforcer - - - - - - - - + + -
    -
    -

    Get an analysis of the filter options for a dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_filter_options_analysis(
-  dashboard_id,
-  filter_columns = list(),
-  options = list()
-)
    +
    + 
    sf_dashboard_filter_options_analysis(
+  dashboard_id,
+  filter_columns = list(),
+  options = list()
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    filter_columns

    list; a list of fields from the source report +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    filter_columns
    +

    list; a list of fields from the source report which you check filter values against. Each object in the array has these -properties:...

    options

    list; a list of objects describing a dashboard filter. -Each object has these properties:...

    - -

    Value

    - +properties:...

    +
    options
    +

    list; a list of objects describing a dashboard filter. +Each object has these properties:...

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_refresh.html b/docs/reference/sf_dashboard_refresh.html index b0d2b6e2..2166666e 100644 --- a/docs/reference/sf_dashboard_refresh.html +++ b/docs/reference/sf_dashboard_refresh.html @@ -1,91 +1,18 @@ - - - - - - - -Refresh an existing dashboard — sf_dashboard_refresh • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Refresh an existing dashboard — sf_dashboard_refresh • salesforcer - - - - - - - - + + -
    -
    -

    Refresh an existing dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_refresh(dashboard_id, dashboard_filters = c(character(0)))
    +
    + 
    sf_dashboard_refresh(dashboard_id, dashboard_filters = c(character(0)))
    +
    -

    Arguments

    - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    dashboard_filters

    character; Dashboard results are always unfiltered, unless you +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    dashboard_filters
    +

    character; Dashboard results are always unfiltered, unless you have specified filter parameters in your request. Use this argument to include up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using sf_dashboard_describe.

    - -

    Value

    - +from the dashboard metadata using sf_dashboard_describe.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_results.html b/docs/reference/sf_dashboard_results.html index 2b1618a0..e96058b6 100644 --- a/docs/reference/sf_dashboard_results.html +++ b/docs/reference/sf_dashboard_results.html @@ -1,94 +1,21 @@ - - - - - - - -Get the results of an existing dashboard — sf_dashboard_results • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get the results of an existing dashboard — sf_dashboard_results • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get the results of an existing dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    This function allows for pulling specific data from a dashboard. There is a -convenience function (sf_get_dashboard_data) to get the dashboard data +convenience function (sf_get_dashboard_data) to get the dashboard data in a tabular format returned as a tbl_df.

    - 
    sf_dashboard_results(
-  dashboard_id,
-  running_user = NULL,
-  dashboard_filters = c(character(0))
-)
    +
    + 
    sf_dashboard_results(
+  dashboard_id,
+  running_user = NULL,
+  dashboard_filters = c(character(0))
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    running_user

    character; the Salesforce Id that should be assigned +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    running_user
    +

    character; the Salesforce Id that should be assigned as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not -allowed to change the running User, or if the selected running User is invalid.

    dashboard_filters

    character; Dashboard results are always unfiltered, unless you +allowed to change the running User, or if the selected running User is invalid.

    +
    dashboard_filters
    +

    character; Dashboard results are always unfiltered, unless you have specified filter parameters in your request. Use this argument to include up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using sf_dashboard_describe.

    - -

    Value

    - +from the dashboard metadata using sf_dashboard_describe.

    +
    +
    +

    Value

    tbl_df

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_set_sticky_filter.html b/docs/reference/sf_dashboard_set_sticky_filter.html index 8a0d88ea..a70bc692 100644 --- a/docs/reference/sf_dashboard_set_sticky_filter.html +++ b/docs/reference/sf_dashboard_set_sticky_filter.html @@ -1,59 +1,5 @@ - - - - - - - -Set a sticky dashboard filter — sf_dashboard_set_sticky_filter • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Set a sticky dashboard filter — sf_dashboard_set_sticky_filter • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Set a sticky dashboard filter

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    Set a default filter value which gets applied to a dashboard when you open it. The default filter value you specify only applies to you (other people won’t see it when they open the dashboard). If you change the filter value @@ -206,60 +123,52 @@

    Set a sticky dashboard filter

    yourself, not for other users.

    - 
    sf_dashboard_set_sticky_filter(
-  dashboard_id,
-  dashboard_filters = c(character(0))
-)
    +
    + 
    sf_dashboard_set_sticky_filter(
+  dashboard_id,
+  dashboard_filters = c(character(0))
+)
    +
    -

    Arguments

    - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    dashboard_filters

    character; Dashboard results are always unfiltered, unless you +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    dashboard_filters
    +

    character; Dashboard results are always unfiltered, unless you have specified filter parameters in your request. Use this argument to include up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using sf_dashboard_describe.

    - -

    Value

    - +from the dashboard metadata using sf_dashboard_describe.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_status.html b/docs/reference/sf_dashboard_status.html index 22a0e734..3e31997a 100644 --- a/docs/reference/sf_dashboard_status.html +++ b/docs/reference/sf_dashboard_status.html @@ -1,91 +1,18 @@ - - - - - - - -Get the status of a dashboard — sf_dashboard_status • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get the status of a dashboard — sf_dashboard_status • salesforcer - - - - - - - - + + -
    -
    -

    Get the status of a dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_status(
-  dashboard_id,
-  running_user = NULL,
-  dashboard_filters = c(character(0))
-)
    +
    + 
    sf_dashboard_status(
+  dashboard_id,
+  running_user = NULL,
+  dashboard_filters = c(character(0))
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    running_user

    character; the Salesforce Id that should be assigned +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    running_user
    +

    character; the Salesforce Id that should be assigned as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not -allowed to change the running User, or if the selected running User is invalid.

    dashboard_filters

    character; Dashboard results are always unfiltered, unless you +allowed to change the running User, or if the selected running User is invalid.

    +
    dashboard_filters
    +

    character; Dashboard results are always unfiltered, unless you have specified filter parameters in your request. Use this argument to include up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using sf_dashboard_describe.

    - -

    Value

    - +from the dashboard metadata using sf_dashboard_describe.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboard_update.html b/docs/reference/sf_dashboard_update.html index e04f66a3..fa50a8db 100644 --- a/docs/reference/sf_dashboard_update.html +++ b/docs/reference/sf_dashboard_update.html @@ -1,91 +1,18 @@ - - - - - - - -Update a dashboard — sf_dashboard_update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update a dashboard — sf_dashboard_update • salesforcer - - - - - - - - + + -
    -
    -

    Update a dashboard

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_dashboard_update(dashboard_id, body)
    +
    + 
    sf_dashboard_update(dashboard_id, body)
    +
    -

    Arguments

    - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_dashboards_list.html b/docs/reference/sf_dashboards_list.html index ca618772..8f19017e 100644 --- a/docs/reference/sf_dashboards_list.html +++ b/docs/reference/sf_dashboards_list.html @@ -1,92 +1,19 @@ - - - - - - - -List dashboards — sf_dashboards_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List dashboards — sf_dashboards_list • salesforcer - - - - - - - - + + -
    -
    -

    List dashboards

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    Returns a list of recently used dashboards

    - 
    sf_dashboards_list(as_tbl = TRUE, verbose = FALSE)
    +
    + 
    sf_dashboards_list(as_tbl = TRUE, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list or tbl_df depending on the value of argument as_tbl

    -

    See also

    - -
    - -
    +
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete.html b/docs/reference/sf_delete.html index c7bb8149..5a56ac45 100644 --- a/docs/reference/sf_delete.html +++ b/docs/reference/sf_delete.html @@ -1,92 +1,19 @@ - - - - - - - -Delete Records — sf_delete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete Records — sf_delete • salesforcer - - - - - - - - + + -
    -
    -

    Delete Records

    - Source: R/delete.R + Source: R/delete.R
    -

    [Stable]

    +

    [Stable]

    Deletes one or more records from your organization’s data.

    - 
    sf_delete(
-  ids,
-  object_name = NULL,
-  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
-  guess_types = TRUE,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_delete(
+  ids,
+  object_name = NULL,
+  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
+  guess_types = TRUE,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ids

    vector, matrix, data.frame, or +

    +

    Arguments

    +
    ids
    +

    vector, matrix, data.frame, or tbl_df; if not a vector, there must be a column called Id (case -insensitive) that can be passed in the request.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +insensitive) that can be passed in the request.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    guess_types

    logical; indicating whether or not to use col_guess() +making the request.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    control

    list; a list of parameters for controlling the behavior of +like numeric looking values that must be preserved as strings ("48.0").

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    -

    Note

    - +
    +
    +

    Note

    Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 3
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact", 1:n))
-new_records <- sf_create(new_contacts, object_name="Contact")
-deleted_first <- sf_delete(new_records$id[1], object_name = "Contact")  
-
-# add the control to do an "All or None" deletion of the remaining records
-deleted_rest <- sf_delete(new_records$id[2:3], object_name = "Contact", 
-                          AllOrNoneHeader = list(allOrNone = TRUE))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 3
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact", 1:n))
+new_records <- sf_create(new_contacts, object_name="Contact")
+deleted_first <- sf_delete(new_records$id[1], object_name = "Contact")  
+
+# add the control to do an "All or None" deletion of the remaining records
+deleted_rest <- sf_delete(new_records$id[2:3], object_name = "Contact", 
+                          AllOrNoneHeader = list(allOrNone = TRUE))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_attachment.html b/docs/reference/sf_delete_attachment.html index fe34cbec..046eba60 100644 --- a/docs/reference/sf_delete_attachment.html +++ b/docs/reference/sf_delete_attachment.html @@ -1,95 +1,22 @@ - - - - - - - -Delete Attachments — sf_delete_attachment • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete Attachments — sf_delete_attachment • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Delete Attachments

    - Source: R/attachments.R + Source: R/attachments.R
    -

    [Experimental]

    -

    This function is a wrapper around sf_delete that accepts a list +

    [Experimental]

    +

    This function is a wrapper around sf_delete that accepts a list of Ids and assumes that they are in the Attachment object and should be deleted. This function is solely provided as a convenience and to provide the last attachment function to parallel the CRUD functionality for all other records.

    - 
    sf_delete_attachment(
-  ids,
-  object_name = c("Attachment"),
-  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_delete_attachment(
+  ids,
+  object_name = c("Attachment"),
+  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    ids

    vector, matrix, data.frame, or +

    +

    Arguments

    +
    ids
    +

    vector, matrix, data.frame, or tbl_df; if not a vector, there must be a column called Id (case -insensitive) that can be passed in the request.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +insensitive) that can be passed in the request.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df with details of the deleted records

    -

    Note

    - +
    +
    +

    Note

    Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.

    -

    See also

    - -

    Other Attachment functions: -check_and_encode_files(), -sf_create_attachment(), -sf_download_attachment(), -sf_update_attachment()

    - -

    Examples

    - 
    if (FALSE) {
-# upload a PDF to a particular record as an Attachment
-file_path <- system.file("extdata",
-                         "data-wrangling-cheatsheet.pdf",
-                         package = "salesforcer")
-parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId!
-attachment_details <- tibble(Body = file_path, ParentId = parent_record_id)
-create_result <- sf_create_attachment(attachment_details)
+    
    
+    
    
+    
    See also
    
+    
    Other Attachment functions: 
+check_and_encode_files(),
+sf_create_attachment(),
+sf_download_attachment(),
+sf_update_attachment()
    
+    
    
 
-# now delete the attachment
-# note that the function below is just running the following!
-# sf_delete(ids = create_result$id)
-sf_delete_attachment(ids = create_result$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# upload a PDF to a particular record as an Attachment
+file_path <- system.file("extdata",
+                         "data-wrangling-cheatsheet.pdf",
+                         package = "salesforcer")
+parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId!
+attachment_details <- tibble(Body = file_path, ParentId = parent_record_id)
+create_result <- sf_create_attachment(attachment_details)
+
+# now delete the attachment
+# note that the function below is just running the following!
+# sf_delete(ids = create_result$id)
+sf_delete_attachment(ids = create_result$id)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_bulk_v1.html b/docs/reference/sf_delete_bulk_v1.html index 9a52acb6..44cfd2fc 100644 --- a/docs/reference/sf_delete_bulk_v1.html +++ b/docs/reference/sf_delete_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Delete records using Bulk 1.0 API — sf_delete_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete records using Bulk 1.0 API — sf_delete_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Delete records using Bulk 1.0 API

    - Source: R/delete.R + Source: R/delete.R
    @@ -188,48 +105,45 @@

    Delete records using Bulk 1.0 API

    Delete records using Bulk 1.0 API

    - 
    sf_delete_bulk_v1(
-  ids,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_delete_bulk_v1(
+  ids,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_bulk_v2.html b/docs/reference/sf_delete_bulk_v2.html index bf159757..9700a115 100644 --- a/docs/reference/sf_delete_bulk_v2.html +++ b/docs/reference/sf_delete_bulk_v2.html @@ -1,91 +1,18 @@ - - - - - - - -Delete records using Bulk 2.0 API — sf_delete_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete records using Bulk 2.0 API — sf_delete_bulk_v2 • salesforcer - - - - - - - - + + -
    -
    -

    Delete records using Bulk 2.0 API

    - Source: R/delete.R + Source: R/delete.R
    @@ -188,48 +105,45 @@

    Delete records using Bulk 2.0 API

    Delete records using Bulk 2.0 API

    - 
    sf_delete_bulk_v2(
-  ids,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_delete_bulk_v2(
+  ids,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_job_bulk.html b/docs/reference/sf_delete_job_bulk.html index c00c71c1..cb15b8c7 100644 --- a/docs/reference/sf_delete_job_bulk.html +++ b/docs/reference/sf_delete_job_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Delete Bulk API Job — sf_delete_job_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete Bulk API Job — sf_delete_job_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Delete Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,67 +105,58 @@

    Delete Bulk API Job

    Delete Bulk API Job

    - 
    sf_delete_job_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
    +
    + 
    sf_delete_job_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - - -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk('insert', 'Account')
-sf_abort_job_bulk(job_info$id)
-sf_delete_job_bulk(job_info$id)
-}
-
    +along with additional diagnostic information where available.

    +
    + +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk('insert', 'Account')
+sf_abort_job_bulk(job_info$id)
+sf_delete_job_bulk(job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_metadata.html b/docs/reference/sf_delete_metadata.html index 66a03c7d..426bc75a 100644 --- a/docs/reference/sf_delete_metadata.html +++ b/docs/reference/sf_delete_metadata.html @@ -1,92 +1,19 @@ - - - - - - - -Delete Object or Field Metadata in Salesforce — sf_delete_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete Object or Field Metadata in Salesforce — sf_delete_metadata • salesforcer - - - - - - - - + + -
    -
    -

    Delete Object or Field Metadata in Salesforce

    - Source: R/delete-metadata.R + Source: R/delete-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes a request of named elements in Salesforce and deletes them.

    - 
    sf_delete_metadata(
-  metadata_type,
-  object_names,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_delete_metadata(
+  metadata_type,
+  object_names,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    metadata_type

    character; string on what type of metadata to create.

    object_names

    a character vector of names that we wish to read metadata for

    control

    list; a list of parameters for controlling the behavior of +

    +

    Arguments

    +
    metadata_type
    +

    character; string on what type of metadata to create.

    +
    object_names
    +

    a character vector of names that we wish to read metadata for

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A data.frame containing the creation result for each submitted metadata component

    -

    See also

    - -

    sf_list_metadata, Salesforce Documentation

    +
    + -

    Examples

    - 
    if (FALSE) {
-metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', 
-                                    object_names = c('Custom_Account25__c'))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', 
+                                    object_names = c('Custom_Account25__c'))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_report.html b/docs/reference/sf_delete_report.html index 836291ac..c24c31e8 100644 --- a/docs/reference/sf_delete_report.html +++ b/docs/reference/sf_delete_report.html @@ -1,93 +1,20 @@ - - - - - - - -Delete a report — sf_delete_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete a report — sf_delete_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Delete a report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Delete a report by sending a DELETE request to the Report resource. Deleted reports are moved to the Recycle Bin.

    - 
    sf_delete_report(report_id, verbose = FALSE)
    +
    + 
    sf_delete_report(report_id, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    logical indicating whether the report was deleted. This function will return TRUE if successful in deleting the report.

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-# first, grab all possible reports in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-
-# second, get the id of the report to delete
-this_report_id <- all_reports$Id[1]
+
    
+    
 
-# third, delete that report using its Id
-success <- sf_delete_report(this_report_id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# first, grab all possible reports in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+
+# second, get the id of the report to delete
+this_report_id <- all_reports$Id[1]
+
+# third, delete that report using its Id
+success <- sf_delete_report(this_report_id)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_report_instance.html b/docs/reference/sf_delete_report_instance.html index dbf59505..d003d164 100644 --- a/docs/reference/sf_delete_report_instance.html +++ b/docs/reference/sf_delete_report_instance.html @@ -1,93 +1,20 @@ - - - - - - - -Delete a report instance — sf_delete_report_instance • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete a report instance — sf_delete_report_instance • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Delete a report instance

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    If the given report instance has a status of Success or Error, delete the report instance.

    - 
    sf_delete_report_instance(report_id, report_instance_id, verbose = FALSE)
    +
    + 
    sf_delete_report_instance(report_id, report_instance_id, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    report_instance_id

    character; the Salesforce Id assigned to a +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    report_instance_id
    +

    character; the Salesforce Id assigned to a created analytics report instance (an asynchronous run). It will start with -"0LG".

    verbose

    logical; an indicator of whether to print additional +"0LG".

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    logical indicating whether the report instance was deleted. This function will return TRUE if successful in deleting the report instance.

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report Instance functions: -sf_get_report_instance_results(), -sf_list_report_instances()

    - -

    Examples

    - 
    if (FALSE) {
-# first, get the Id of a report in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-this_report_id <- all_reports$Id[1]
-
-# second, ensure that report has been executed at least once asynchronously
-results <- sf_execute_report(this_report_id, async=TRUE)
+
    
+    
    
+    
    See also
    
+    
    Other Report Instance functions: 
+sf_get_report_instance_results(),
+sf_list_report_instances()
    
+    
    
 
-# check if that report has succeeded, if so (or if it errored), then delete
-instance_list <- sf_list_report_instances(this_report_id)
-instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# first, get the Id of a report in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+this_report_id <- all_reports$Id[1]
+
+# second, ensure that report has been executed at least once asynchronously
+results <- sf_execute_report(this_report_id, async=TRUE)
+
+# check if that report has succeeded, if so (or if it errored), then delete
+instance_list <- sf_list_report_instances(this_report_id)
+instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_rest.html b/docs/reference/sf_delete_rest.html index 1048ddde..249025a0 100644 --- a/docs/reference/sf_delete_rest.html +++ b/docs/reference/sf_delete_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Delete records using REST API — sf_delete_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete records using REST API — sf_delete_rest • salesforcer - - - - - - - - + + -
    -
    -

    Delete records using REST API

    - Source: R/delete.R + Source: R/delete.R
    @@ -188,48 +105,45 @@

    Delete records using REST API

    Delete records using REST API

    - 
    sf_delete_rest(
-  ids,
-  object_name = NULL,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_delete_rest(
+  ids,
+  object_name = NULL,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_delete_soap.html b/docs/reference/sf_delete_soap.html index 45bbc60f..e1d11da0 100644 --- a/docs/reference/sf_delete_soap.html +++ b/docs/reference/sf_delete_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Delete records using SOAP API — sf_delete_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete records using SOAP API — sf_delete_soap • salesforcer - - - - - - - - + + -
    -
    -

    Delete records using SOAP API

    - Source: R/delete.R + Source: R/delete.R
    @@ -188,48 +105,45 @@

    Delete records using SOAP API

    Delete records using SOAP API

    - 
    sf_delete_soap(
-  ids,
-  object_name = NULL,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_delete_soap(
+  ids,
+  object_name = NULL,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_describe_metadata.html b/docs/reference/sf_describe_metadata.html index f1949543..30cd6918 100644 --- a/docs/reference/sf_describe_metadata.html +++ b/docs/reference/sf_describe_metadata.html @@ -1,92 +1,19 @@ - - - - - - - -Describe the Metadata in an Organization — sf_describe_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe the Metadata in an Organization — sf_describe_metadata • salesforcer - - - - - - - - + + -
    -
    -

    Describe the Metadata in an Organization

    - Source: R/describe-metadata.R + Source: R/describe-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function returns details about the organization metadata

    - 
    sf_describe_metadata(verbose = FALSE)
    +
    + 
    sf_describe_metadata(verbose = FALSE)
    +
    -

    Arguments

    - - - - - - -
    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    + + -

    Examples

    - 
    if (FALSE) {
-# describe metadata for the organization associated with the session
-metadata_info <- sf_describe_metadata()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# describe metadata for the organization associated with the session
+metadata_info <- sf_describe_metadata()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_describe_object_fields.html b/docs/reference/sf_describe_object_fields.html index 839a0c41..5aa02462 100644 --- a/docs/reference/sf_describe_object_fields.html +++ b/docs/reference/sf_describe_object_fields.html @@ -1,93 +1,20 @@ - - - - - - - -Describe Object Fields — sf_describe_object_fields • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe Object Fields — sf_describe_object_fields • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Describe Object Fields

    - Source: R/read-metadata.R + Source: R/read-metadata.R
    -

    [Stable]

    +

    [Stable]

    This function takes the name of an object in Salesforce and returns a description of the fields on that object by returning a tibble with one row per field.

    - 
    sf_describe_object_fields(object_name)
    - -

    Arguments

    - - - - - - -
    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    - -

    Value

    +
    + 
    sf_describe_object_fields(object_name)
    +
    +
    +

    Arguments

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    +
    +

    Value

    A tbl_df containing one row per field for the requested object.

    -

    Note

    - +
    +
    +

    Note

    The tibble only contains the fields that the user can view, as defined by the user's field-level security settings.

    +
    -

    Examples

    - 
    if (FALSE) {
-acct_fields <- sf_describe_object_fields('Account')
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+acct_fields <- sf_describe_object_fields('Account')
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_describe_objects.html b/docs/reference/sf_describe_objects.html index 7be9ddd6..b8795bc2 100644 --- a/docs/reference/sf_describe_objects.html +++ b/docs/reference/sf_describe_objects.html @@ -1,92 +1,19 @@ - - - - - - - -SObject Basic Information — sf_describe_objects • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SObject Basic Information — sf_describe_objects • salesforcer - - - - - - - - + + -
    -
    -

    SObject Basic Information

    - Source: R/describe.R + Source: R/describe.R
    -

    [Stable]

    +

    [Stable]

    Describes the individual metadata for the specified object.

    - 
    sf_describe_objects(
-  object_names,
-  api_type = c("SOAP", "REST"),
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_describe_objects(
+  object_names,
+  api_type = c("SOAP", "REST"),
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    object_names

    character; the name of one or more Salesforce objects -that the function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    object_names
    +

    character; the name of one or more Salesforce objects +that the function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list

    -

    See also

    - -

    REST API Documentation, REST API Example

    - -

    Examples

    - 
    if (FALSE) {
-account_metadata <- sf_describe_objects("Account")
-account_metadata_SOAP <- sf_describe_objects("Account", api_type="SOAP")
-multiple_objs_metadata <- sf_describe_objects(c("Contact", "Lead"))
+    
    
+    
 
-account_metadata_REST <- sf_describe_objects("Account", api_type="REST")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+account_metadata <- sf_describe_objects("Account")
+account_metadata_SOAP <- sf_describe_objects("Account", api_type="SOAP")
+multiple_objs_metadata <- sf_describe_objects(c("Contact", "Lead"))
+
+account_metadata_REST <- sf_describe_objects("Account", api_type="REST")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_describe_report.html b/docs/reference/sf_describe_report.html index 91a5d297..1d333c01 100644 --- a/docs/reference/sf_describe_report.html +++ b/docs/reference/sf_describe_report.html @@ -1,93 +1,20 @@ - - - - - - - -Describe a report — sf_describe_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe a report — sf_describe_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Describe a report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Retrieves report, report type, and related metadata for a tabular, summary, or matrix report.

    - 
    sf_describe_report(report_id, verbose = FALSE)
    +
    + 
    sf_describe_report(report_id, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    list containing up to 4 properties that describe the report:

    attributes
    +

    Report type along with the URL to retrieve common objects and joined metadata.

    -

    Value

    +
    reportMetadata
    +

    Unique identifiers for groupings and summaries.

    -

    list containing up to 4 properties that describe the report:

    -
    attributes

    Report type along with the URL to retrieve common objects and joined metadata.

    -
    reportMetadata

    Unique identifiers for groupings and summaries.

    -
    reportTypeMetadata

    Fields in each section of a report type plus filter information for those fields.

    -
    reportExtendedMetadata

    Additional information about summaries and groupings.

    +
    reportTypeMetadata
    +

    Fields in each section of a report type plus filter information for those fields.

    -
    +
    reportExtendedMetadata
    +

    Additional information about summaries and groupings.

    -

    Details

    +
    +
    +

    Details

    -
      -

    • Report metadata gives information about the report as a whole. Tells you such things as, the report type, format, the fields that are summaries, row or column groupings, filters saved to the report, and so on.

      • +

      • Report metadata gives information about the report as a whole. Tells you such things as, the report type, format, the fields that are summaries, row or column groupings, filters saved to the report, and so on.

      • Report type metadata tells you about all the fields available in the report type, those you can filter, and by what filter criteria.

      • Report extended metadata tells you about the fields that are summaries, groupings, and contain record details in the report.

        • -
      - -

      Salesforce Documentation

      - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-# pull a list of up to 200 recent reports
-# (for a full list you must use sf_query on the Report object)
-reports <- sf_list_reports()
-
-# id for the first report
-reports[[1,"id"]]
+
    
+    
 
-# describe that report type
-described_report <- sf_describe_report_type(unique_report_types[[1,"id"]])
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# pull a list of up to 200 recent reports
+# (for a full list you must use sf_query on the Report object)
+reports <- sf_list_reports()
+
+# id for the first report
+reports[[1,"id"]]
+
+# describe that report type
+described_report <- sf_describe_report_type(unique_report_types[[1,"id"]])
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_describe_report_type.html b/docs/reference/sf_describe_report_type.html index 773ea26d..6ee62c3d 100644 --- a/docs/reference/sf_describe_report_type.html +++ b/docs/reference/sf_describe_report_type.html @@ -1,92 +1,19 @@ - - - - - - - -Describe a report type — sf_describe_report_type • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe a report type — sf_describe_report_type • salesforcer - - - - - - - - + + -
    -
    -

    Describe a report type

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Return metadata about a report type.

    - 
    sf_describe_report_type(report_type, verbose = FALSE)
    +
    + 
    sf_describe_report_type(report_type, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_type

    character; a character representing the type of +

    +

    Arguments

    +
    report_type
    +

    character; a character representing the type of report to retrieve the metadata information on. A list of valid report types that can be described using this function will be available in the -reportTypes.type column of results returned sf_list_report_types. +reportTypes.type column of results returned sf_list_report_types. (e.g. AccountList, AccountContactRole, OpportunityHistory, -etc.)

    verbose

    logical; an indicator of whether to print additional +etc.)

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - -

    list containing up to 4 properties that describe the report:

    -
    attributes

    Report type along with the URL to retrieve common objects and +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    list containing up to 4 properties that describe the report:

    attributes
    +

    Report type along with the URL to retrieve common objects and joined metadata.

    -
    reportMetadata

    Unique identifiers for groupings and summaries.

    -
    reportTypeMetadata

    Fields in each section of a report type plus filter information for those fields.

    -
    reportExtendedMetadata

    Additional information about summaries and groupings.

    - -
    -

    Salesforce Documentation

    +
    reportMetadata
    +

    Unique identifiers for groupings and summaries.

    - - - +
    reportTypeMetadata
    +

    Fields in each section of a report type plus filter information for those fields.

    -

    See also

    +
    reportExtendedMetadata
    +

    Additional information about summaries and groupings.

    -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    -

    Examples

    - 
    if (FALSE) {
-reports <- sf_list_report_types()
-unique_report_types <- reports %>% distinct(reportTypes.type)
+
    
+    
    
+    
    Salesforce Documentation
    
+    
 
-# first unique report type
-unique_report_types[[1,1]]
+
    
+    
 
-# describe that report type
-described_report <- sf_describe_report_type(unique_report_types[[1,1]])
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+reports <- sf_list_report_types()
+unique_report_types <- reports %>% distinct(reportTypes.type)
+
+# first unique report type
+unique_report_types[[1,1]]
+
+# describe that report type
+described_report <- sf_describe_report_type(unique_report_types[[1,1]])
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_download_attachment.html b/docs/reference/sf_download_attachment.html index 80e6c04c..2cc9bb1e 100644 --- a/docs/reference/sf_download_attachment.html +++ b/docs/reference/sf_download_attachment.html @@ -1,93 +1,20 @@ - - - - - - - -Download an Attachment — sf_download_attachment • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Download an Attachment — sf_download_attachment • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Download an Attachment

    - Source: R/attachments.R + Source: R/attachments.R
    -

    [Stable]

    +

    [Stable]

    This function will allow you to download an attachment to disk based on the attachment body, file name, and path.

    - 
    sf_download_attachment(
-  body,
-  name = NULL,
-  sf_id = NULL,
-  object_name = c("Attachment", "Document"),
-  path = "."
-)
    +
    + 
    sf_download_attachment(
+  body,
+  name = NULL,
+  sf_id = NULL,
+  object_name = c("Attachment", "Document"),
+  path = "."
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    body

    character; a URL path to the body of the attachment in -Salesforce, typically retrieved by sf_query on the Attachment -object. Alternatively, you can specify the Salesforce Id of the Attachment.

    name

    character; the name of the file you would like to save the +

    +

    Arguments

    +
    body
    +

    character; a URL path to the body of the attachment in +Salesforce, typically retrieved by sf_query on the Attachment +object. Alternatively, you can specify the Salesforce Id of the Attachment.

    +
    name
    +

    character; the name of the file you would like to save the content to. Note that you should include the file extension in this name and if this argument is left NULL, then a query will be made to determine the name and file extension needed. This process may result in a slower download process, so attempt to provide the body and name arguments -whenever possible for the best performance.

    sf_id

    character; a Salesforce generated Id that uniquely -identifies a record.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    path

    character; a directory path where to create file, defaults -to the current directory.

    - -

    Value

    - +whenever possible for the best performance.

    +
    sf_id
    +

    character; a Salesforce generated Id that uniquely +identifies a record.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    path
    +

    character; a directory path where to create file, defaults +to the current directory.

    +
    +
    +

    Value

    character; invisibly return the file path of the downloaded content

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Attachment functions: -check_and_encode_files(), -sf_create_attachment(), -sf_delete_attachment(), -sf_update_attachment()

    - -

    Examples

    - 
    if (FALSE) {
-# downloading all attachments for a Parent record
-# if your attachment name doesn't include the extension, then you can use the 
-# ContentType column to append it to the Name, if needed
-queried_attachments <- sf_query("SELECT Id, Body, Name, ContentType 
-                                 FROM Attachment 
-                                 WHERE ParentId = '0016A0000035mJ5'")
-mapply(sf_download_attachment, queried_attachments$Body, queried_attachments$Name)
+
    
+    
    
+    
    See also
    
+    
    Other Attachment functions: 
+check_and_encode_files(),
+sf_create_attachment(),
+sf_delete_attachment(),
+sf_update_attachment()
    
+    
    
 
-# downloading an attachment by its Id
-# (the file name will be the same as it exists in Salesforce)
-sf_download_attachment(sf_id = queried_attachments$Id[1])
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# downloading all attachments for a Parent record
+# if your attachment name doesn't include the extension, then you can use the 
+# ContentType column to append it to the Name, if needed
+queried_attachments <- sf_query("SELECT Id, Body, Name, ContentType 
+                                 FROM Attachment 
+                                 WHERE ParentId = '0016A0000035mJ5'")
+mapply(sf_download_attachment, queried_attachments$Body, queried_attachments$Name)
+
+# downloading an attachment by its Id
+# (the file name will be the same as it exists in Salesforce)
+sf_download_attachment(sf_id = queried_attachments$Id[1])
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_empty_recycle_bin.html b/docs/reference/sf_empty_recycle_bin.html index 545b7ad7..1c794f2a 100644 --- a/docs/reference/sf_empty_recycle_bin.html +++ b/docs/reference/sf_empty_recycle_bin.html @@ -1,92 +1,19 @@ - - - - - - - -Empty Recycle Bin — sf_empty_recycle_bin • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Empty Recycle Bin — sf_empty_recycle_bin • salesforcer - - - - - - - - + + -
    -
    -

    Empty Recycle Bin

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Delete records from the recycle bin immediately and permanently.

    - 
    sf_empty_recycle_bin(ids, api_type = c("SOAP"), verbose = FALSE)
    +
    + 
    sf_empty_recycle_bin(ids, api_type = c("SOAP"), verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    ids

    vector, matrix, data.frame, or +

    +

    Arguments

    +
    ids
    +

    vector, matrix, data.frame, or tbl_df; if not a vector, there must be a column called Id (case-insensitive) -that can be passed in the request

    api_type

    character; one of "REST", "SOAP", +that can be passed in the request

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    -

    Details

    - -

    When emptying recycle bins, consider the following rules and guidelines:

      -

    • The logged in user can delete any record that he or she can query in their Recycle Bin, or the recycle bins of any subordinates. If the logged in user has Modify All Data permission, he or she can query and delete records from any Recycle Bin in the organization.

      • +
    +
    +

    Details

    +

    When emptying recycle bins, consider the following rules and guidelines:

    • The logged in user can delete any record that he or she can query in their Recycle Bin, or the recycle bins of any subordinates. If the logged in user has Modify All Data permission, he or she can query and delete records from any Recycle Bin in the organization.

    • Do not include the IDs of any records that will be cascade deleted, or an error will occur.

    • Once records are deleted using this call, they cannot be undeleted using link{sf_undelete}

    • After records are deleted from the Recycle Bin using this call, they can be queried using the queryall argument for some time. Typically this time is 24 hours, but may be shorter or longer.

      • -
    - -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_emptyrecyclebin.htm

    - -

    Examples

    - 
    if (FALSE) {
-new_contact <- c(FirstName = "Test", LastName = "Contact")
-new_records <- sf_create(new_contact, object_name = "Contact")
-delete <- sf_delete(new_records$id[1],
-                    AllOrNoneHeader = list(allOrNone = TRUE))
-is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'",
-                       new_records$id[1]),
-                       queryall = TRUE)
-hard_deleted <- sf_empty_recycle_bin(new_records$id[1])
+
    
+    
 
-# confirm that the record really is gone (can't be deleted)
-undelete <- sf_undelete(new_records$id[1])
-# if you use queryall you still will find the record for ~24hrs
-is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", 
-                               new_records$id[1]), queryall = TRUE)
-                               
-# As of v48.0 (Spring 2020) you can query the Ids of all records in the Recycle 
-# Bin, which makes it easier to clear the entire bin because you can grab the 
-# Ids of the records first
-records_in_bin <- sf_query("SELECT Record FROM DeleteEvent")
-records_emptied_from_bin <- sf_delete(records_in_bin$Record)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+new_contact <- c(FirstName = "Test", LastName = "Contact")
+new_records <- sf_create(new_contact, object_name = "Contact")
+delete <- sf_delete(new_records$id[1],
+                    AllOrNoneHeader = list(allOrNone = TRUE))
+is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'",
+                       new_records$id[1]),
+                       queryall = TRUE)
+hard_deleted <- sf_empty_recycle_bin(new_records$id[1])
+
+# confirm that the record really is gone (can't be deleted)
+undelete <- sf_undelete(new_records$id[1])
+# if you use queryall you still will find the record for ~24hrs
+is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'", 
+                               new_records$id[1]), queryall = TRUE)
+                               
+# As of v48.0 (Spring 2020) you can query the Ids of all records in the Recycle 
+# Bin, which makes it easier to clear the entire bin because you can grab the 
+# Ids of the records first
+records_in_bin <- sf_query("SELECT Record FROM DeleteEvent")
+records_emptied_from_bin <- sf_delete(records_in_bin$Record)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_end_job_bulk.html b/docs/reference/sf_end_job_bulk.html index a2edc818..87657f37 100644 --- a/docs/reference/sf_end_job_bulk.html +++ b/docs/reference/sf_end_job_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -End Bulk API Job — sf_end_job_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -End Bulk API Job — sf_end_job_bulk • salesforcer - - - - - - - - + + -
    -
    -

    End Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,73 +105,66 @@

    End Bulk API Job

    End Bulk API Job

    - 
    sf_end_job_bulk(
-  job_id,
-  end_type = c("Closed", "UploadComplete", "Aborted"),
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_end_job_bulk(
+  job_id,
+  end_type = c("Closed", "UploadComplete", "Aborted"),
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    end_type

    character; taking a value of "Closed" or "Aborted" indicating -how the bulk job should be ended

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    end_type
    +

    character; taking a value of "Closed" or "Aborted" indicating +how the bulk job should be ended

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Note

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    logical; returns TRUE if the job was able to be ended; +otherwise, an error message is printed

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_execute_report.html b/docs/reference/sf_execute_report.html index 54cd57e1..b0aefecb 100644 --- a/docs/reference/sf_execute_report.html +++ b/docs/reference/sf_execute_report.html @@ -1,98 +1,25 @@ - - - - - - - -Execute a report — sf_execute_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Execute a report — sf_execute_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Execute a report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Get summary data with or without details by running a report synchronously or asynchronously through the API. When you run a report, the API returns data for the same number of records that are available when the report is run in the Salesforce user interface. Include the filters argument in your request to get specific results on the fly by passing dynamic filters, groupings, and aggregates in the report metadata. Finally, you may want to -use sf_run_report.

    +use sf_run_report.

    - 
    sf_execute_report(
-  report_id,
-  async = FALSE,
-  include_details = TRUE,
-  labels = TRUE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  as_tbl = TRUE,
-  report_metadata = NULL,
-  verbose = FALSE
-)
    +
    + 
    sf_execute_report(
+  report_id,
+  async = FALSE,
+  include_details = TRUE,
+  labels = TRUE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  as_tbl = TRUE,
+  report_metadata = NULL,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    async

    logical; an indicator, by default set to TRUE, which +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    async
    +

    logical; an indicator, by default set to TRUE, which executes the report asynchronously. If executed asynchronously, this function will return a list of attributes of the created report instance. The results can be pulled down by providing the report id and instance id to -the function sf_get_report_instance_results. Refer to the details -of the documentation on why executing a report asynchronously is preferred.

    include_details

    logical; an indicator applying to a synchronous -indicating whether the run should return summary data with details.

    labels

    logical; an indicator of whether the returned data should +the function sf_get_report_instance_results. Refer to the details +of the documentation on why executing a report asynchronously is preferred.

    +
    include_details
    +

    logical; an indicator applying to a synchronous +indicating whether the run should return summary data with details.

    +
    labels
    +

    logical; an indicator of whether the returned data should be the label (i.e. formatted value) or the actual value. By default, the labels are returned because these are what appear in the Salesforce dashboard and more closely align with the column names. For example, "Account.Name" label may be "Account B" and the value 0016A0000035mJEQAY. The former -(label) more accurately reflects the "Account.Name".

    guess_types

    logical; indicating whether or not to use col_guess() +(label) more accurately reflects the "Account.Name".

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    report_metadata

    list; a list with one element named +character.

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    report_metadata
    +

    list; a list with one element named "reportMetadata" having additional list elements underneath. All possible elements of reportMetadata are documented -HERE, +HERE, but you will most commonly only need to specify the following 3 elements to -filter or query the results of an existing report:

    -
    reportFormat

    A character specifying the format of the report +filter or query the results of an existing report:

    reportFormat
    +

    A character specifying the format of the report with possible values: "TABULAR", "SUMMARY", "MATRIX", or "MULTI_BLOCK".

    -
    reportBooleanFilter

    A character denoting how the individuals + +

    reportBooleanFilter
    +

    A character denoting how the individuals filters specified in reportFilters should be combined. For example, -"(1OR4)AND2AND3"

    . -
    reportFilters

    A list of reportFilter specifications. Each must +"(1OR4)AND2AND3"

    +. +
    reportFilters
    +

    A list of reportFilter specifications. Each must be a list with 3 elements: 1) column, 2) operator, and 3) value. You can find out how certain field types can be filtered by reviewing the results -of sf_list_report_filter_operators.

    +of sf_list_report_filter_operators.

    -
    verbose

    logical; an indicator of whether to print additional + + +

    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df by default, but a list when as_tbl=FALSE, which means that the content from the API is converted from JSON to a list with no other post-processing.

    -

    Details

    - +
    +
    +

    Details

    Run a report synchronously if you expect it to finish running quickly. Otherwise, we recommend that you run reports through the API asynchronously -for these reasons:

      -

    • Long running reports have a lower risk of reaching the timeout limit +for these reasons:

      • Long running reports have a lower risk of reaching the timeout limit when run asynchronously.

      • The 2-minute overall Salesforce API timeout limit doesn’t apply to asynchronous runs.

        • @@ -316,108 +220,100 @@

        Details number of asynchronous run requests at a time.

      • Since the results of an asynchronously run report are stored for a 24-hr rolling period, they’re available for recurring access.

        • -

      - -

      Before you filter a report, it helpful to check the following properties in the metadata +

    Before you filter a report, it helpful to check the following properties in the metadata that tell you if a field can be filtered, the values and criteria you can filter -by, and filters that already exist in the report:

      -

    • filterable

      • +by, and filters that already exist in the report:

      • filterable

      • filterValues

      • dataTypeFilterOperatorMap

      • reportFilters

        • -
      - -

      Salesforce Documentation

      - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-# first, get the Id of a report in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-this_report_id <- all_reports$Id[1]
-
-# then execute a synchronous report that will wait for the results
-results <- sf_execute_report(this_report_id)
-
-# alternatively, you can execute an async report and then grab its results when done
-#   - The benefit of an async report is that the results will be stored for up to
-#     24 hours for faster recall, if needed
-results <- sf_execute_report(this_report_id, async=TRUE)
-
-# check if completed and proceed if the status is "Success"
-instance_list <- sf_list_report_instances(report_id)
-instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
-if(instance_status == "Success"){
-  results <- sf_get_report_instance_results(report_id, results$id)
-}
+
    
+    
 
-# Note: For more complex execution use the report_metadata argument.
-# This can be done by building the list from scratch based on Salesforce 
-# documentation (not recommended) or pulling down the existing reportMetadata 
-# property of the report and modifying the list slightly (recommended). 
-# In addition, for relatively simple changes, you can leverage the convenience 
-# function sf_report_wrapper() which makes it easier to retrieve report results
-report_details <- sf_describe_report(this_report_id)
-report_metadata <- list(reportMetadata = report_details$reportMetadata)
-report_metadata$reportMetadata$showGrandTotal <- FALSE
-report_metadata$reportMetadata$showSubtotals <- FALSE
-fields <- sf_execute_report(this_report_id,
-                            report_metadata = report_metadata)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# first, get the Id of a report in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+this_report_id <- all_reports$Id[1]
+
+# then execute a synchronous report that will wait for the results
+results <- sf_execute_report(this_report_id)
+
+# alternatively, you can execute an async report and then grab its results when done
+#   - The benefit of an async report is that the results will be stored for up to
+#     24 hours for faster recall, if needed
+results <- sf_execute_report(this_report_id, async=TRUE)
+
+# check if completed and proceed if the status is "Success"
+instance_list <- sf_list_report_instances(report_id)
+instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
+if(instance_status == "Success"){
+  results <- sf_get_report_instance_results(report_id, results$id)
+}
+
+# Note: For more complex execution use the report_metadata argument.
+# This can be done by building the list from scratch based on Salesforce 
+# documentation (not recommended) or pulling down the existing reportMetadata 
+# property of the report and modifying the list slightly (recommended). 
+# In addition, for relatively simple changes, you can leverage the convenience 
+# function sf_report_wrapper() which makes it easier to retrieve report results
+report_details <- sf_describe_report(this_report_id)
+report_metadata <- list(reportMetadata = report_details$reportMetadata)
+report_metadata$reportMetadata$showGrandTotal <- FALSE
+report_metadata$reportMetadata$showSubtotals <- FALSE
+fields <- sf_execute_report(this_report_id,
+                            report_metadata = report_metadata)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_find_duplicates.html b/docs/reference/sf_find_duplicates.html index adb1f39c..aa4785e9 100644 --- a/docs/reference/sf_find_duplicates.html +++ b/docs/reference/sf_find_duplicates.html @@ -1,92 +1,19 @@ - - - - - - - -Find Duplicate Records — sf_find_duplicates • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Find Duplicate Records — sf_find_duplicates • salesforcer - - - - - - - - + + -
    -
    -

    Find Duplicate Records

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Performs rule-based searches for duplicate records.

    - 
    sf_find_duplicates(
-  search_criteria,
-  object_name,
-  include_record_details = FALSE,
-  guess_types = TRUE,
-  verbose = FALSE
-)
    +
    + 
    sf_find_duplicates(
+  search_criteria,
+  object_name,
+  include_record_details = FALSE,
+  guess_types = TRUE,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    search_criteria

    list; a list of fields and their values that would -constitute a match. For example, list(FirstName="Marc", Company="Salesforce")

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    include_record_details

    logical; get fields and values for records +

    +

    Arguments

    +
    search_criteria
    +

    list; a list of fields and their values that would +constitute a match. For example, list(FirstName="Marc", Company="Salesforce")

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    include_record_details
    +

    logical; get fields and values for records detected as duplicates by setting this property to TRUE. Get only record IDs for records detected as duplicates by setting this property to -FALSE.

    guess_types

    logical; indicating whether or not to use col_guess() +FALSE.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    verbose

    logical; an indicator of whether to print additional +like numeric looking values that must be preserved as strings ("48.0").

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records found to be duplicates by the match rules

    -

    Note

    - +
    +
    +

    Note

    You must have active duplicate rules for the supplied object before running this function. The object_name argument refers to using that object's duplicate rules on the search criteria to determine which records in other objects are duplicates.

    +
    -

    Examples

    - 
    if (FALSE) {
-# use the duplicate rules associated with the Lead object on the search 
-# criteria (email) in order to find duplicates
-found_dupes <- sf_find_duplicates(search_criteria =
-                                    list(Email="bond_john@grandhotels.com"),
-                                  object_name = "Lead")
-                                  
-# now look for duplicates on email using the Contact object's rules
-found_dupes <- sf_find_duplicates(search_criteria = 
-                                    list(Email="bond_john@grandhotels.com"),
-                                  object_name = "Contact")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# use the duplicate rules associated with the Lead object on the search 
+# criteria (email) in order to find duplicates
+found_dupes <- sf_find_duplicates(search_criteria =
+                                    list(Email="bond_john@grandhotels.com"),
+                                  object_name = "Lead")
+                                  
+# now look for duplicates on email using the Contact object's rules
+found_dupes <- sf_find_duplicates(search_criteria = 
+                                    list(Email="bond_john@grandhotels.com"),
+                                  object_name = "Contact")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_find_duplicates_by_id.html b/docs/reference/sf_find_duplicates_by_id.html index 7069b8af..1c86b159 100644 --- a/docs/reference/sf_find_duplicates_by_id.html +++ b/docs/reference/sf_find_duplicates_by_id.html @@ -1,92 +1,19 @@ - - - - - - - -Find Duplicate Records By Id — sf_find_duplicates_by_id • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Find Duplicate Records By Id — sf_find_duplicates_by_id • salesforcer - - - - - - - - + + -
    -
    -

    Find Duplicate Records By Id

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Performs rule-based searches for duplicate records.

    - 
    sf_find_duplicates_by_id(
-  sf_id,
-  include_record_details = FALSE,
-  guess_types = TRUE,
-  verbose = FALSE
-)
    +
    + 
    sf_find_duplicates_by_id(
+  sf_id,
+  include_record_details = FALSE,
+  guess_types = TRUE,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    sf_id

    character; a Salesforce generated Id that uniquely -identifies a record.

    include_record_details

    logical; get fields and values for records +

    +

    Arguments

    +
    sf_id
    +

    character; a Salesforce generated Id that uniquely +identifies a record.

    +
    include_record_details
    +

    logical; get fields and values for records detected as duplicates by setting this property to TRUE. Get only record IDs for records detected as duplicates by setting this property to -FALSE.

    guess_types

    logical; indicating whether or not to use col_guess() +FALSE.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    verbose

    logical; an indicator of whether to print additional +like numeric looking values that must be preserved as strings ("48.0").

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records found to be duplicates by the match rules

    -

    Note

    - +
    +
    +

    Note

    You must have active duplicate rules for the supplied object before running this function. This function uses the duplicate rules for the object that has the same type as the input record IDs. For example, if the record Id represents an Account, this function uses the duplicate rules associated with the Account object.

    +
    -

    Examples

    - 
    if (FALSE) {
-# use the duplicate rules associated with the object that this record 
-# belongs to in order to find duplicates
-found_dupes <- sf_find_duplicates_by_id(sf_id = "00Q6A00000aABCnZZZ")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# use the duplicate rules associated with the object that this record 
+# belongs to in order to find duplicates
+found_dupes <- sf_find_duplicates_by_id(sf_id = "00Q6A00000aABCnZZZ")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_format_date.html b/docs/reference/sf_format_date.html index 6854c0c7..0ff93a4c 100644 --- a/docs/reference/sf_format_date.html +++ b/docs/reference/sf_format_date.html @@ -1,91 +1,18 @@ - - - - - - - -Format Dates for Create and Update operations — sf_format_date • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Format Dates for Create and Update operations — sf_format_date • salesforcer - - - - - - - - + + -
    -
    -

    Format Dates for Create and Update operations

    - Source: R/utils-datatypes.R + Source: R/utils-datatypes.R
    @@ -188,44 +105,53 @@

    Format Dates for Create and Update operations

    Format Dates for Create and Update operations

    - 
    sf_format_date(x)
    - - -

    Note

    +
    + 
    sf_format_date(x)
    +
    +
    +

    Arguments

    +
    x
    +

    a value representing a datetime

    +
    +
    +

    Value

    +

    character; a date string with the time set to midnight in the +user's system timezone and then formatted in ISO8601 per the requirements of +the Salesforce APIs.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    -

    See also

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_date_format.htm

    +
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_format_datetime.html b/docs/reference/sf_format_datetime.html index 9cd1b7ef..b2a669fb 100644 --- a/docs/reference/sf_format_datetime.html +++ b/docs/reference/sf_format_datetime.html @@ -1,91 +1,18 @@ - - - - - - - -Format Datetimes for Create and Update operations — sf_format_datetime • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Format Datetimes for Create and Update operations — sf_format_datetime • salesforcer - - - - - - - - + + -
    -
    -

    Format Datetimes for Create and Update operations

    - Source: R/utils-datatypes.R + Source: R/utils-datatypes.R
    @@ -188,44 +105,54 @@

    Format Datetimes for Create and Update operations

    Format Datetimes for Create and Update operations

    - 
    sf_format_datetime(x)
    - - -

    Note

    +
    + 
    sf_format_datetime(x)
    +
    +
    +

    Arguments

    +
    x
    +

    an object, potentially, representing a datetime that should be converted +to the Salesforce standard.

    +
    +
    +

    Value

    +

    character; an object where any values that appear to be a date +or date time are reformatted as an ISO8601 string per the requirements of the +Salesforce APIs.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    -

    See also

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_date_format.htm

    +
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_format_time.html b/docs/reference/sf_format_time.html new file mode 100644 index 00000000..e05abda1 --- /dev/null +++ b/docs/reference/sf_format_time.html @@ -0,0 +1,198 @@ + +Format all Date and Datetime values in an object — sf_format_time • salesforcer + + +
    +
    + + + +
    +
    +
    +

    Format all Date and Datetime values in an object

    + Source: R/utils-datatypes.R + +
    + +
    +

    Format all Date and Datetime values in an object

    +
    + +
    + 
    sf_format_time(x)
+
+# S3 method for list
+sf_format_time(x)
+
+# S3 method for data.frame
+sf_format_time(x)
+
+# S3 method for Date
+sf_format_time(x)
+
+# S3 method for POSIXct
+sf_format_time(x)
+
+# S3 method for POSIXlt
+sf_format_time(x)
+
+# S3 method for POSIXt
+sf_format_time(x)
+
+# S3 method for character
+sf_format_time(x)
+
+# S3 method for numeric
+sf_format_time(x)
+
+# S3 method for logical
+sf_format_time(x)
+
+# S3 method for `NULL`
+sf_format_time(x)
+
+# S3 method for AsIs
+sf_format_time(x)
    +
    + +
    +

    Arguments

    +
    x
    +

    data which may or may not have values, elements, columns that +represent a datetime. If so, each of those are cast to the ISO8601 standard +per the requirements of Salesforce APIs.

    +
    +
    +

    Value

    +

    the same data object with datetime values formatted.

    +
    +
    +

    Note

    +

    This function is meant to be used internally. Only use when debugging.

    +
    + + +
    + +
    + + +
    +

    Developed by Steven M. Mortimer.

    +
    + +
    +

    Site built with pkgdown 2.0.1.

    +
    + +
    + + + + diff --git a/docs/reference/sf_get_all_jobs_bulk.html b/docs/reference/sf_get_all_jobs_bulk.html index 95969a93..051a3a57 100644 --- a/docs/reference/sf_get_all_jobs_bulk.html +++ b/docs/reference/sf_get_all_jobs_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Get All Bulk API Jobs — sf_get_all_jobs_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get All Bulk API Jobs — sf_get_all_jobs_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Get All Bulk API Jobs

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,97 +105,86 @@

    Get All Bulk API Jobs

    This function retrieves details about all Bulk jobs in the org.

    - 
    sf_get_all_jobs_bulk(
-  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL),
-  next_records_url = NULL,
-  api_type = c("Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_get_all_jobs_bulk(
+  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL),
+  next_records_url = NULL,
+  api_type = c("Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    parameterized_search_list

    list; a list of parameters to be added as part +

    +

    Arguments

    +
    parameterized_search_list
    +

    list; a list of parameters to be added as part of the URL query string (i.e. after a question mark ("?") so that the result only returns information about jobs that meet that specific criteria. For more information, read the note below and/or the Salesforce documentation -here.

    next_records_url

    character (leave as NULL); a string used internally -by the function to paginate through to more records until complete

    api_type

    character; one of "REST", "SOAP", +here.

    +
    next_records_url
    +

    character (leave as NULL); a string used internally +by the function to paginate through to more records until complete

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of parameters defining the details of all bulk jobs

    -

    Note

    - -

    parameterized_search_list elements that can be set to filter the results:

      -

    • isPkChunkingEnabledA logical either TRUE or FALSE. TRUE only returns +

    +
    +

    Note

    +

    parameterized_search_list elements that can be set to filter the results:

    • isPkChunkingEnabledA logical either TRUE or FALSE. TRUE only returns information about jobs where PK Chunking has been enabled.

    • jobTypeA character string to return jobs matching the specified type. Must be one of: "BigObjectIngest", "Classic", "V2QIngest". Classic corresponds to Bulk 1.0 API jobs and V2Ingest corresponds to the Bulk 2.0 API jobs.

      • -
    - -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk('insert', 'Account')
-all_jobs_info <- sf_get_all_jobs_bulk()
-# just the Bulk API 1.0 jobs
-all_jobs_info <- sf_get_all_jobs_bulk(parameterized_search_list=list(jobType='Classic'))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk('insert', 'Account')
+all_jobs_info <- sf_get_all_jobs_bulk()
+# just the Bulk API 1.0 jobs
+all_jobs_info <- sf_get_all_jobs_bulk(parameterized_search_list=list(jobType='Classic'))
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_all_query_jobs_bulk.html b/docs/reference/sf_get_all_query_jobs_bulk.html index 26b523e5..5e8f434d 100644 --- a/docs/reference/sf_get_all_query_jobs_bulk.html +++ b/docs/reference/sf_get_all_query_jobs_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Get All Bulk API Query Jobs — sf_get_all_query_jobs_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get All Bulk API Query Jobs — sf_get_all_query_jobs_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Get All Bulk API Query Jobs

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,52 +105,44 @@

    Get All Bulk API Query Jobs

    This function retrieves details about all Bulk query jobs in the org.

    - 
    sf_get_all_query_jobs_bulk(
-  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL,
-    concurrencyMode = NULL),
-  next_records_url = NULL,
-  api_type = c("Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_get_all_query_jobs_bulk(
+  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL,
+    concurrencyMode = NULL),
+  next_records_url = NULL,
+  api_type = c("Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    parameterized_search_list

    list; a list of parameters to be added as part +

    +

    Arguments

    +
    parameterized_search_list
    +

    list; a list of parameters to be added as part of the URL query string (i.e. after a question mark ("?") so that the result only returns information about jobs that meet that specific criteria. For more information, read the note below and/or the Salesforce documentation -here.

    next_records_url

    character (leave as NULL); a string used internally -by the function to paginate through to more records until complete

    api_type

    character; one of "REST", "SOAP", +here.

    +
    next_records_url
    +

    character (leave as NULL); a string used internally +by the function to paginate through to more records until complete

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of parameters defining the details of all bulk jobs

    -

    Note

    - -

    parameterized_search_list elements that can be set to filter the results:

      -

    • isPkChunkingEnabledA logical either TRUE or FALSE. TRUE only returns +

    +
    +

    Note

    +

    parameterized_search_list elements that can be set to filter the results:

    • isPkChunkingEnabledA logical either TRUE or FALSE. TRUE only returns information about jobs where PK Chunking has been enabled.

    • jobTypeA character string to return jobs matching the specified type. Must be one of: "BigObjectIngest", "Classic", "V2Query". Classic corresponds @@ -241,50 +150,47 @@

      Note

    • concurrencyModeA character string to return jobs matching the specified concurrency mode. Must be one of: "serial" or "parallel", but only "serial" is currently supported.

      • -
    - -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/get_all_jobs.htm

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk('insert', 'Account')
-all_query_jobs_info <- sf_get_all_query_jobs_bulk()
-# just the Bulk API 2.0 query jobs
-all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='V2Query'))
-# just the Bulk API 1.0 query jobs
-all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='Classic'))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk('insert', 'Account')
+all_query_jobs_info <- sf_get_all_query_jobs_bulk()
+# just the Bulk API 2.0 query jobs
+all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='V2Query'))
+# just the Bulk API 1.0 query jobs
+all_query_jobs_info <- sf_get_all_query_jobs_bulk(parameterized_search_list=list(jobType='Classic'))
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_dashboard_data.html b/docs/reference/sf_get_dashboard_data.html index 0df1695d..75848e7d 100644 --- a/docs/reference/sf_get_dashboard_data.html +++ b/docs/reference/sf_get_dashboard_data.html @@ -1,91 +1,18 @@ - - - - - - - -Get dashboard data in a tabular format — sf_get_dashboard_data • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get dashboard data in a tabular format — sf_get_dashboard_data • salesforcer - - - - - - - - + + -
    -
    -

    Get dashboard data in a tabular format

    - Source: R/analytics-dashboard.R + Source: R/analytics-dashboard.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_get_dashboard_data(
-  dashboard_id,
-  running_user = NULL,
-  dashboard_filters = c(character(0))
-)
    +
    + 
    sf_get_dashboard_data(
+  dashboard_id,
+  running_user = NULL,
+  dashboard_filters = c(character(0))
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    dashboard_id

    character; the Salesforce Id assigned to a created -dashboard. It will start with "01Z".

    running_user

    character; the Salesforce Id that should be assigned +

    +

    Arguments

    +
    dashboard_id
    +

    character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

    +
    running_user
    +

    character; the Salesforce Id that should be assigned as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not -allowed to change the running User, or if the selected running User is invalid.

    dashboard_filters

    character; Dashboard results are always unfiltered, unless you +allowed to change the running User, or if the selected running User is invalid.

    +
    dashboard_filters
    +

    character; Dashboard results are always unfiltered, unless you have specified filter parameters in your request. Use this argument to include up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using sf_dashboard_describe.

    - -

    Value

    - +from the dashboard metadata using sf_dashboard_describe.

    +
    +
    +

    Value

    tbl_df

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_deleted.html b/docs/reference/sf_get_deleted.html index 1cc79078..7c0665ff 100644 --- a/docs/reference/sf_get_deleted.html +++ b/docs/reference/sf_get_deleted.html @@ -1,93 +1,20 @@ - - - - - - - -Get Deleted Records from a Timeframe — sf_get_deleted • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get Deleted Records from a Timeframe — sf_get_deleted • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get Deleted Records from a Timeframe

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Retrieves the list of individual records that have been deleted within the given timespan for the specified object.

    - 
    sf_get_deleted(object_name, start, end, verbose = FALSE)
    +
    + 
    sf_get_deleted(object_name, start, end, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    start

    date or datetime; starting datetime of the timespan -for which to retrieve the data.

    end

    date or datetime; ending datetime of the timespan for -which to retrieve the data.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    start
    +

    date or datetime; starting datetime of the timespan +for which to retrieve the data.

    +
    end
    +

    date or datetime; ending datetime of the timespan for +which to retrieve the data.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Note

    - +along with additional diagnostic information where available.

    +
    +
    +

    Note

    This API ignores the seconds portion of the supplied datetime values.

    +
    -

    Examples

    - 
    if (FALSE) {
-# get all deleted Contact records from midnight until now
-deleted_recs <- sf_get_deleted("Contact", Sys.Date(), Sys.time())
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# get all deleted Contact records from midnight until now
+deleted_recs <- sf_get_deleted("Contact", Sys.Date(), Sys.time())
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_job_bulk.html b/docs/reference/sf_get_job_bulk.html index 33c41410..e35fd6dc 100644 --- a/docs/reference/sf_get_job_bulk.html +++ b/docs/reference/sf_get_job_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Get Bulk API Job — sf_get_job_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get Bulk API Job — sf_get_job_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Get Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,84 +105,75 @@

    Get Bulk API Job

    This function retrieves details about a Job in the Salesforce Bulk API

    - 
    sf_get_job_bulk(
-  job_id,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  query_operation = FALSE,
-  verbose = FALSE
-)
    +
    + 
    sf_get_job_bulk(
+  job_id,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  query_operation = FALSE,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    query_operation

    logical; an indicator of whether the job is a query job, +making the request.

    +
    query_operation
    +

    logical; an indicator of whether the job is a query job, which is needed when using the Bulk 2.0 API because the URI endpoints are different -for the "ingest" vs. the "query" jobs.

    verbose

    logical; an indicator of whether to print additional +for the "ingest" vs. the "query" jobs.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of parameters defining the details of the specified job id

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk('insert', 'Account')
-refreshed_job_info <- sf_get_job_bulk(job_info$id)
-sf_abort_job_bulk(refreshed_job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk('insert', 'Account')
+refreshed_job_info <- sf_get_job_bulk(job_info$id)
+sf_abort_job_bulk(refreshed_job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_job_records_bulk.html b/docs/reference/sf_get_job_records_bulk.html index 18b5924f..bccd6065 100644 --- a/docs/reference/sf_get_job_records_bulk.html +++ b/docs/reference/sf_get_job_records_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Returning the Details of a Bulk API Job — sf_get_job_records_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Returning the Details of a Bulk API Job — sf_get_job_records_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Returning the Details of a Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -190,99 +107,89 @@

    Returning the Details of a Bulk API Job

    which has already been submitted completed (successfully or not).

    - 
    sf_get_job_records_bulk(
-  job_id,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  record_types = c("successfulResults", "failedResults", "unprocessedRecords"),
-  combine_record_types = TRUE,
-  verbose = FALSE
-)
    +
    + 
    sf_get_job_records_bulk(
+  job_id,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  record_types = c("successfulResults", "failedResults", "unprocessedRecords"),
+  combine_record_types = TRUE,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    record_types

    character; one or more types of records to retrieve -from the results of running the specified job

    combine_record_types

    logical; indicating for Bulk 2.0 jobs whether the +making the request.

    +
    record_types
    +

    character; one or more types of records to retrieve +from the results of running the specified job

    +
    combine_record_types
    +

    logical; indicating for Bulk 2.0 jobs whether the successfulResults, failedResults, and unprocessedRecords should be stacked -together by binding the rows

    verbose

    logical; an indicator of whether to print additional +together by binding the rows

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df or list of tbl_df, formatted by Salesforce, with information containing the success or failure or certain rows in a submitted job

    -

    Note

    - +
    +
    +

    Note

    With Bulk 2.0 the order of records in the response is not guaranteed to match the ordering of records in the original job data.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk('insert', 'Account')
-input_data <- tibble(Name=c("Test Account 1", "Test Account 2"))
-batches_result <- sf_create_batches_bulk(job_info$id, input_data)
-# pause a few seconds for operation to finish. Wait longer if job is not complete.
-Sys.sleep(3)
-# check status using - sf_get_job_bulk(job_info$id)
-job_record_details <- sf_get_job_records_bulk(job_id=job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk('insert', 'Account')
+input_data <- tibble(Name=c("Test Account 1", "Test Account 2"))
+batches_result <- sf_create_batches_bulk(job_info$id, input_data)
+# pause a few seconds for operation to finish. Wait longer if job is not complete.
+Sys.sleep(3)
+# check status using - sf_get_job_bulk(job_info$id)
+job_record_details <- sf_get_job_records_bulk(job_id=job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_report_instance_results.html b/docs/reference/sf_get_report_instance_results.html index edb577c9..7e82857e 100644 --- a/docs/reference/sf_get_report_instance_results.html +++ b/docs/reference/sf_get_report_instance_results.html @@ -1,94 +1,21 @@ - - - - - - - -Get report instance results — sf_get_report_instance_results • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get report instance results — sf_get_report_instance_results • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get report instance results

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Retrieves results for an instance of a report run asynchronously with or without filters. Depending on your asynchronous report run request, data can be at the summary level or include details.

    - 
    sf_get_report_instance_results(
-  report_id,
-  report_instance_id,
-  labels = TRUE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  fact_map_key = "T!T",
-  verbose = FALSE
-)
    +
    + 
    sf_get_report_instance_results(
+  report_id,
+  report_instance_id,
+  labels = TRUE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  fact_map_key = "T!T",
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    report_instance_id

    character; the Salesforce Id assigned to a +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    report_instance_id
    +

    character; the Salesforce Id assigned to a created analytics report instance (an asynchronous run). It will start with -"0LG".

    labels

    logical; an indicator of whether the returned data should +"0LG".

    +
    labels
    +

    logical; an indicator of whether the returned data should be the label (i.e. formatted value) or the actual value. By default, the labels are returned because these are what appear in the Salesforce dashboard and more closely align with the column names. For example, "Account.Name" label may be "Account B" and the value 0016A0000035mJEQAY. The former -(label) more accurately reflects the "Account.Name".

    guess_types

    logical; indicating whether or not to use col_guess() +(label) more accurately reflects the "Account.Name".

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    fact_map_key

    character; string providing an index into each +character.

    +
    fact_map_key
    +

    character; string providing an index into each section of a fact map, from which you can access summary and detailed data. The pattern for the fact map keys varies by report format so it is important to know what the reportFormat property of the target report is. See the -note below for more details.

    verbose

    logical; an indicator of whether to print additional +note below for more details.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df; the detail report data. More specifically, the detailed data from the "T!T" entry in the fact map.

    -

    Note

    - -

    Below are the fact map key patterns for three report types:

    -
    TABULAR

    T!T: The grand total of a report. Both record data +

    +
    +

    Note

    +

    Below are the fact map key patterns for three report types:

    TABULAR
    +

    T!T: The grand total of a report. Both record data values and the grand total are represented by this key.

    -
    SUMMARY

    <First level row grouping_second level row grouping_third + +

    SUMMARY
    +

    <First level row grouping_second level row grouping_third level row grouping>!T: T refers to the row grand total.

    -
    MATRIX

    <First level row grouping_second level row grouping>!<First + +

    MATRIX
    +

    <First level row grouping_second level row grouping>!<First level column grouping_second level column grouping>.

    -
    -

    Each item in a row or column grouping is numbered starting with 0. Here are +

    Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:

    -
    -
    0!T

    The first item in the first-level grouping.

    -
    1!T

    The second item in the first-level grouping.

    -
    0_0!T

    The first item in the first-level grouping and the first item -in the second-level grouping.

    -
    0_1!T

    The first item in the first-level grouping and the second item -in the second-level grouping.

    - -
    +
    0!T
    +

    The first item in the first-level grouping.

    -

    Salesforce Documentation

    +
    1!T
    +

    The second item in the first-level grouping.

    - - - +
    0_0!T
    +

    The first item in the first-level grouping and the first item +in the second-level grouping.

    -

    See also

    +
    0_1!T
    +

    The first item in the first-level grouping and the second item +in the second-level grouping.

    -

    Other Report Instance functions: -sf_delete_report_instance(), -sf_list_report_instances()

    -

    Examples

    - 
    if (FALSE) {
-# execute a report asynchronously in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-this_report_id <- all_reports$Id[1]
-results <- sf_execute_report(this_report_id, async=TRUE)
+
    +
    +

    Salesforce Documentation

    + -# check if that report has succeeded, ... -instance_list <- sf_list_report_instances(this_report_id) -instance_status <- instance_list[[which(instance_list$id == results$id), "status"]] +
    +
    +

    See also

    +

    Other Report Instance functions: +sf_delete_report_instance(), +sf_list_report_instances()

    +
    -# ... if so, then grab the results -if(instance_status == "Success"){ - report_data <- sf_get_report_instance_results(report_id = this_report_id, - report_instance_id = results$id) -} -} -
    +
    +

    Examples

    + 
    if (FALSE) {
+# execute a report asynchronously in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+this_report_id <- all_reports$Id[1]
+results <- sf_execute_report(this_report_id, async=TRUE)
+
+# check if that report has succeeded, ... 
+instance_list <- sf_list_report_instances(this_report_id)
+instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
+
+# ... if so, then grab the results
+if(instance_status == "Success"){
+  report_data <- sf_get_report_instance_results(report_id = this_report_id, 
+                                                report_instance_id = results$id)
+}
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_get_updated.html b/docs/reference/sf_get_updated.html index 5b2d1d9c..59d50911 100644 --- a/docs/reference/sf_get_updated.html +++ b/docs/reference/sf_get_updated.html @@ -1,93 +1,20 @@ - - - - - - - -Get Updated Records from a Timeframe — sf_get_updated • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get Updated Records from a Timeframe — sf_get_updated • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get Updated Records from a Timeframe

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Retrieves the list of individual records that have been inserted or updated within the given timespan in the specified object.

    - 
    sf_get_updated(object_name, start, end, verbose = FALSE)
    +
    + 
    sf_get_updated(object_name, start, end, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    start

    date or datetime; starting datetime of the timespan -for which to retrieve the data.

    end

    date or datetime; ending datetime of the timespan for -which to retrieve the data.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    start
    +

    date or datetime; starting datetime of the timespan +for which to retrieve the data.

    +
    end
    +

    date or datetime; ending datetime of the timespan for +which to retrieve the data.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Note

    - +along with additional diagnostic information where available.

    +
    +
    +

    Note

    This API ignores the seconds portion of the supplied datetime values.

    +
    -

    Examples

    - 
    if (FALSE) {
-# get all updated Contact records from midnight until now
-updated_recs <- sf_get_updated("Contact", Sys.Date(), Sys.time())
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# get all updated Contact records from midnight until now
+updated_recs <- sf_get_updated("Contact", Sys.Date(), Sys.time())
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_guess_cols.html b/docs/reference/sf_guess_cols.html index 03e5505f..d1b5f6ee 100644 --- a/docs/reference/sf_guess_cols.html +++ b/docs/reference/sf_guess_cols.html @@ -1,91 +1,18 @@ - - - - - - - -Parse resultset columns to a known datatype in R — sf_guess_cols • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Parse resultset columns to a known datatype in R — sf_guess_cols • salesforcer - - - - - - - - + + -
    -
    -

    Parse resultset columns to a known datatype in R

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -188,52 +105,47 @@

    Parse resultset columns to a known datatype in R

    This function accepts a tbl_df with columns rearranged.

    - 
    sf_guess_cols(df, guess_types = TRUE, dataType = NULL)
    - -

    Arguments

    - - - - - - -
    df

    tbl_df; the data frame to rearrange columns in

    - -

    Value

    +
    + 
    sf_guess_cols(df, guess_types = TRUE, dataType = NULL)
    +
    +
    +

    Arguments

    +
    df
    +

    tbl_df; the data frame to rearrange columns in

    +
    +
    +

    Value

    tbl_df the formatted data frame

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_input_data_validation.html b/docs/reference/sf_input_data_validation.html index c0f4185c..e16b7dda 100644 --- a/docs/reference/sf_input_data_validation.html +++ b/docs/reference/sf_input_data_validation.html @@ -1,91 +1,18 @@ - - - - - - - -Validate the input for an operation — sf_input_data_validation • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Validate the input for an operation — sf_input_data_validation • salesforcer - - - - - - - - + + -
    -
    -

    Validate the input for an operation

    - Source: R/utils-input-validation.R + Source: R/utils-input-validation.R
    @@ -188,41 +105,56 @@

    Validate the input for an operation

    Validate the input for an operation

    - 
    sf_input_data_validation(input_data, operation = "")
    - - -

    Note

    +
    + 
    sf_input_data_validation(input_data, operation = "")
    +
    +
    +

    Arguments

    +
    input_data
    +

    named vector, matrix, data.frame, or +tbl_df; data can be coerced into a data.frame. If performing an +update, upsert, or delete operation, then one column or +field must be the Id of the record to modify or delete.

    +
    operation
    +

    character; a string defining the type of operation being +performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", +"query", "queryall").

    +
    +
    +

    Value

    +

    the input data validated and formatted according to the specified +operation. This allows more flexibility for the user while ensuring that all +inputs are formatted as expected by the target APIs and operations.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_job_batches_bulk.html b/docs/reference/sf_job_batches_bulk.html index cdcf95dc..a65bbc70 100644 --- a/docs/reference/sf_job_batches_bulk.html +++ b/docs/reference/sf_job_batches_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Checking the Status of a Batch in a Bulk API Job — sf_job_batches_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Checking the Status of a Batch in a Bulk API Job — sf_job_batches_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Checking the Status of a Batch in a Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -190,79 +107,73 @@

    Checking the Status of a Batch in a Bulk API Job

    which has already been submitted to Bulk API Job

    - 
    sf_job_batches_bulk(job_id, api_type = c("Bulk 1.0"), verbose = FALSE)
    +
    + 
    sf_job_batches_bulk(job_id, api_type = c("Bulk 1.0"), verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of parameters defining the batch identified by the batch_id

    -

    Note

    - +
    +
    +

    Note

    This is a legacy function used only with Bulk 1.0.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-job_info <- sf_create_job_bulk(operation = "query", object = "Account")
-soql <- "SELECT Id, Name FROM Account LIMIT 10"
-batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql)
-submitted_batches <- sf_job_batches_bulk(job_id=batch_query_info$jobId)
-job_close_ind <- sf_close_job_bulk(job_info$id)
-sf_get_job_bulk(job_info$id)                               
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+job_info <- sf_create_job_bulk(operation = "query", object = "Account")
+soql <- "SELECT Id, Name FROM Account LIMIT 10"
+batch_query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = soql)
+submitted_batches <- sf_job_batches_bulk(job_id=batch_query_info$jobId)
+job_close_ind <- sf_close_job_bulk(job_info$id)
+sf_get_job_bulk(job_info$id)                               
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_api_limits.html b/docs/reference/sf_list_api_limits.html index 1559bd25..62cf9013 100644 --- a/docs/reference/sf_list_api_limits.html +++ b/docs/reference/sf_list_api_limits.html @@ -1,92 +1,19 @@ - - - - - - - -List the Limits for an API — sf_list_api_limits • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List the Limits for an API — sf_list_api_limits • salesforcer - - - - - - - - + + -
    -
    -

    List the Limits for an API

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Lists information about limits in your org.

    - 
    sf_list_api_limits()
    - - -

    Value

    +
    + 
    sf_list_api_limits()
    +
    +
    +

    Value

    list

    -

    Note

    - +
    +
    +

    Note

    This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission. The resource returns -these limits:

      -

    • Daily API calls

      • +these limits:

      • Daily API calls

      • Daily asynchronous Apex method executions (batch Apex, future methods, queueable Apex, and scheduled Apex)

      • Daily Bulk API calls

      • Daily Streaming API events (API version 36.0 and earlier)

        • @@ -225,42 +143,38 @@

        Note

      • Daily and active scratch org counts

      • Data storage (MB)

      • File storage (MB)

        • -
      - - -

      Examples

      - 
      if (FALSE) {
-sf_list_api_limits()
-}
-
      +
    + +
    +

    Examples

    + 
    if (FALSE) {
+sf_list_api_limits()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_metadata.html b/docs/reference/sf_list_metadata.html index a1da3ba5..4a1001c4 100644 --- a/docs/reference/sf_list_metadata.html +++ b/docs/reference/sf_list_metadata.html @@ -1,93 +1,20 @@ - - - - - - - -List All Objects of a Certain Metadata Type in Salesforce — sf_list_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List All Objects of a Certain Metadata Type in Salesforce — sf_list_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    List All Objects of a Certain Metadata Type in Salesforce

    - Source: R/list-metadata.R + Source: R/list-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes a query of metadata types and returns a summary of all objects in salesforce of the requested types

    - 
    sf_list_metadata(queries, verbose = FALSE)
    +
    + 
    sf_list_metadata(queries, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    queries

    a list of lists with each element consisting of 2 components: 1) +

    +

    Arguments

    +
    queries
    +

    a list of lists with each element consisting of 2 components: 1) the metadata type being requested and 2) the folder associated with the type that required for types -that use folders, such as Dashboard, Document, EmailTemplate, or Report.

    verbose

    logical; an indicator of whether to print additional +that use folders, such as Dashboard, Document, EmailTemplate, or Report.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_dfs containing the queried metadata types

    -

    Note

    - +
    +
    +

    Note

    Only 3 queries can be specified at one time, so the list length must not exceed 3.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/

    +
    + -

    Examples

    - 
    if (FALSE) {
-# pull back a list of all Custom Objects and Email Templates
-my_queries <- list(list(type='CustomObject'),
-                   list(folder='unfiled$public',
-                        type='EmailTemplate'))
-metadata_info <- sf_list_metadata(queries=my_queries)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# pull back a list of all Custom Objects and Email Templates
+my_queries <- list(list(type='CustomObject'),
+                   list(folder='unfiled$public',
+                        type='EmailTemplate'))
+metadata_info <- sf_list_metadata(queries=my_queries)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_objects.html b/docs/reference/sf_list_objects.html index 63342f4c..be4b47da 100644 --- a/docs/reference/sf_list_objects.html +++ b/docs/reference/sf_list_objects.html @@ -1,92 +1,19 @@ - - - - - - - -List Organization Objects and their Metadata — sf_list_objects • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List Organization Objects and their Metadata — sf_list_objects • salesforcer - - - - - - - - + + -
    -
    -

    List Organization Objects and their Metadata

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Lists the available objects and their metadata for your organization’s data.

    - 
    sf_list_objects()
    - - -

    Value

    +
    + 
    sf_list_objects()
    +
    +
    +

    Value

    list

    +
    -

    Examples

    - 
    if (FALSE) {
-sf_list_objects()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_list_objects()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_report_fields.html b/docs/reference/sf_list_report_fields.html index b9989ae9..6925f4df 100644 --- a/docs/reference/sf_list_report_fields.html +++ b/docs/reference/sf_list_report_fields.html @@ -1,95 +1,22 @@ - - - - - - - -Get a list of report fields — sf_list_report_fields • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get a list of report fields — sf_list_report_fields • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get a list of report fields

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    The Report Fields resource returns report fields available for specified reports. Use the resource to determine the best fields for use in dashboard filters by seeing which fields different source reports have in common. Available in API version 40.0 and later.

    - 
    sf_list_report_fields(
-  report_id,
-  intersect_with = c(character(0)),
-  verbose = FALSE
-)
    +
    + 
    sf_list_report_fields(
+  report_id,
+  intersect_with = c(character(0)),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    intersect_with

    character a vector of unique report IDs. This is +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    intersect_with
    +

    character a vector of unique report IDs. This is helpful in determining the best fields for use in dashboard filters by seeing which fields different source reports have in common. If this argument is left empty, then the function returns a list of all possible report fields. -Otherwise, returns a list of fields that specified reports share.

    verbose

    logical; an indicator of whether to print additional +Otherwise, returns a list of fields that specified reports share.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    list representing the 4 different field report properties:

    displayGroups
    +

    Fields available when adding a filter.

    -

    Value

    +
    equivalentFields
    +

    Fields available for each specified report. Each object in this array is a list of common fields categorized by report type.

    -

    list representing the 4 different field report properties:

    -
    displayGroups

    Fields available when adding a filter.

    -
    equivalentFields

    Fields available for each specified report. Each object in this array is a list of common fields categorized by report type.

    -
    equivalentFieldIndices

    Map of each field’s API name to the index of the field in the equivalentFields array.

    -
    mergedGroups

    Merged fields.

    +
    equivalentFieldIndices
    +

    Map of each field’s API name to the index of the field in the equivalentFields array.

    -
    +
    mergedGroups
    +

    Merged fields.

    -

    Salesforce Documentation

    +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-# first, grab all possible reports in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-
-# second, get the id of the report to check fields on
-this_report_id <- all_reports$Id[1]
+
    
+    
 
-# third, pull that report and intersect its fields with up to three other reports
-fields <- sf_list_report_fields(this_report_id, intersect_with=head(all_reports[["Id"]],3))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# first, grab all possible reports in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+
+# second, get the id of the report to check fields on
+this_report_id <- all_reports$Id[1]
+
+# third, pull that report and intersect its fields with up to three other reports
+fields <- sf_list_report_fields(this_report_id, intersect_with=head(all_reports[["Id"]],3))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_report_filter_operators.html b/docs/reference/sf_list_report_filter_operators.html index e10a5f69..06a1899f 100644 --- a/docs/reference/sf_list_report_filter_operators.html +++ b/docs/reference/sf_list_report_filter_operators.html @@ -1,94 +1,21 @@ - - - - - - - -List report filter operators — sf_list_report_filter_operators • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List report filter operators — sf_list_report_filter_operators • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    List report filter operators

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Use the Filter Operators API to get information about which filter operators are available for reports and dashboards. The Filter Operators API is available in API version 40.0 and later.

    - 
    sf_list_report_filter_operators(as_tbl = TRUE, verbose = FALSE)
    +
    + 
    sf_list_report_filter_operators(as_tbl = TRUE, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df by default, or a list depending on the value of argument as_tbl

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-report_filters <- sf_list_report_filter_operators()
-unique_supported_fields <- report_filters %>% distinct(supported_field_type)
+
    
+    
 
-# operators to filter a picklist field
-picklist_field_operators <- report_filters %>% filter(supported_field_type == "picklist")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+report_filters <- sf_list_report_filter_operators()
+unique_supported_fields <- report_filters %>% distinct(supported_field_type)
+
+# operators to filter a picklist field
+picklist_field_operators <- report_filters %>% filter(supported_field_type == "picklist")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_report_instances.html b/docs/reference/sf_list_report_instances.html index adb78bef..974871ea 100644 --- a/docs/reference/sf_list_report_instances.html +++ b/docs/reference/sf_list_report_instances.html @@ -1,94 +1,21 @@ - - - - - - - -List report instances — sf_list_report_instances • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List report instances — sf_list_report_instances • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    List report instances

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report run with metadata in that snapshot of time.

    - 
    sf_list_report_instances(report_id, as_tbl = TRUE, verbose = FALSE)
    +
    + 
    sf_list_report_instances(report_id, as_tbl = TRUE, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df by default, or a list depending on the value of argument as_tbl

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report Instance functions: -sf_delete_report_instance(), -sf_get_report_instance_results()

    - -

    Examples

    - 
    if (FALSE) {
-# first, get the Id of a report in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-this_report_id <- all_reports$Id[1]
-
-# second, execute an async report
-results <- sf_execute_report(this_report_id, async=TRUE)
+
    
+    
    
+    
    See also
    
+    
    Other Report Instance functions: 
+sf_delete_report_instance(),
+sf_get_report_instance_results()
    
+    
    
 
-# third, pull a list of async requests ("instances") usually meant for checking 
-# if a recently requested report has succeeded and the results can be retrieved
-instance_list <- sf_list_report_instances(this_report_id)
-instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# first, get the Id of a report in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+this_report_id <- all_reports$Id[1]
+
+# second, execute an async report
+results <- sf_execute_report(this_report_id, async=TRUE)
+
+# third, pull a list of async requests ("instances") usually meant for checking 
+# if a recently requested report has succeeded and the results can be retrieved
+instance_list <- sf_list_report_instances(this_report_id)
+instance_status <- instance_list[[which(instance_list$id == results$id), "status"]]
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_report_types.html b/docs/reference/sf_list_report_types.html index f6b80d35..4e6c9085 100644 --- a/docs/reference/sf_list_report_types.html +++ b/docs/reference/sf_list_report_types.html @@ -1,92 +1,19 @@ - - - - - - - -List report types — sf_list_report_types • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List report types — sf_list_report_types • salesforcer - - - - - - - - + + -
    -
    -

    List report types

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Return a list of report types.

    - 
    sf_list_report_types(as_tbl = TRUE, verbose = FALSE)
    +
    + 
    sf_list_report_types(as_tbl = TRUE, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df by default, or a list depending on the value of argument as_tbl

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_reports(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-report_types <- sf_list_report_types()
-unique_report_types <- report_types %>% select(reportTypes.type)
+
    
+    
 
-# return the results as a list
-reports_as_list <- sf_list_report_types(as_tbl=FALSE)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+report_types <- sf_list_report_types()
+unique_report_types <- report_types %>% select(reportTypes.type)
+
+# return the results as a list
+reports_as_list <- sf_list_report_types(as_tbl=FALSE)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_reports.html b/docs/reference/sf_list_reports.html index d12bc343..bb0c1009 100644 --- a/docs/reference/sf_list_reports.html +++ b/docs/reference/sf_list_reports.html @@ -1,95 +1,22 @@ - - - - - - - -List reports — sf_list_reports • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List reports — sf_list_reports • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    List reports

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Displays a list of full list of reports based on the Report object. If recent is up to 200 tabular, matrix, or summary reports that you recently viewed. To get additional details on reports by format, name, and other fields, use a SOQL query on the Report object.

    - 
    sf_list_reports(recent = FALSE, as_tbl = TRUE, verbose = FALSE)
    +
    + 
    sf_list_reports(recent = FALSE, as_tbl = TRUE, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    recent

    logical; an indicator of whether to return the 200 most +

    +

    Arguments

    +
    recent
    +

    logical; an indicator of whether to return the 200 most recently viewed reports or to invoke a query on the Report object to return all reports in the Org. By default, this argument is set to FALSE meaning that all of the reports, not just the most recently viewed reports are returned. Note that the default behavior of the reports list endpoint in the Reports and Dashboards REST API is only the most recently viewed up to -200 reports.

    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    verbose

    logical; an indicator of whether to print additional +200 reports.

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df by default, or a list depending on the value of argument as_tbl

    -

    Note

    - +
    +
    +

    Note

    This function will only return up to 200 of recently viewed reports when the recent argument is set to TRUE. For a complete details you must -use sf_query on the report object.

    -

    Salesforce Documentation

    - +use sf_query on the report object.

    +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_query_report(), -sf_run_report(), -sf_update_report()

    - -

    Examples

    - 
    if (FALSE) {
-# to return all possible reports, which is queried from the Report object
-reports <- sf_list_reports()
-
-# return the results as a list
-reports_as_list <- sf_list_reports(as_tbl=FALSE)
+
    
+    
 
-# return up to 200 recently viewed reports
-all_reports <- sf_list_reports(recent=TRUE)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# to return all possible reports, which is queried from the Report object
+reports <- sf_list_reports()
+
+# return the results as a list
+reports_as_list <- sf_list_reports(as_tbl=FALSE)
+
+# return up to 200 recently viewed reports
+all_reports <- sf_list_reports(recent=TRUE)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_resources.html b/docs/reference/sf_list_resources.html index aa96f934..251410c7 100644 --- a/docs/reference/sf_list_resources.html +++ b/docs/reference/sf_list_resources.html @@ -1,93 +1,20 @@ - - - - - - - -List the Resources for an API — sf_list_resources • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List the Resources for an API — sf_list_resources • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    List the Resources for an API

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Lists available resources for the specified API version, including resource name and URI.

    - 
    sf_list_resources()
    - - -

    Value

    +
    + 
    sf_list_resources()
    +
    +
    +

    Value

    list

    +
    -

    Examples

    - 
    if (FALSE) {
-sf_list_resources()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_list_resources()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_list_rest_api_versions.html b/docs/reference/sf_list_rest_api_versions.html index cf1cebdc..a1af3e95 100644 --- a/docs/reference/sf_list_rest_api_versions.html +++ b/docs/reference/sf_list_rest_api_versions.html @@ -1,93 +1,20 @@ - - - - - - - -List REST API Versions — sf_list_rest_api_versions • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List REST API Versions — sf_list_rest_api_versions • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    List REST API Versions

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version\'s root

    - 
    sf_list_rest_api_versions()
    - - -

    Value

    +
    + 
    sf_list_rest_api_versions()
    +
    +
    +

    Value

    list

    +
    -

    Examples

    - 
    if (FALSE) {
-sf_list_rest_api_versions()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_list_rest_api_versions()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_merge.html b/docs/reference/sf_merge.html index fe53c4f1..9bea4221 100644 --- a/docs/reference/sf_merge.html +++ b/docs/reference/sf_merge.html @@ -1,95 +1,22 @@ - - - - - - - -Merge Records — sf_merge • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Merge Records — sf_merge • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Merge Records

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    This function combines records of the same object type into one of the records, known as the master record. The other records, known as the victim records, will be deleted. If a victim record has related records the master record the new parent of the related records.

    - 
    sf_merge(
-  master_id,
-  victim_ids,
-  object_name,
-  master_fields = character(0),
-  api_type = c("SOAP"),
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_merge(
+  master_id,
+  victim_ids,
+  object_name,
+  master_fields = character(0),
+  api_type = c("SOAP"),
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    master_id

    character; a Salesforce generated Id that identifies the master record, -which is the record to which the victim records will be merged into

    victim_ids

    character; one or two Salesforce Ids of records to be merged into +

    +

    Arguments

    +
    master_id
    +

    character; a Salesforce generated Id that identifies the master record, +which is the record to which the victim records will be merged into

    +
    victim_ids
    +

    character; one or two Salesforce Ids of records to be merged into the master record. Up to three records can be merged in a single request, including the master record. This limit is the same as the limit enforced by the Salesforce user interface. To merge more than 3 records, successively merge records by running -sf_merge repeatedly.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    master_fields

    named vector; a vector of field names and values to +sf_merge repeatedly.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    master_fields
    +

    named vector; a vector of field names and values to supersede the master record values. Otherwise, the field values on the master record -will prevail.

    api_type

    character; one of "REST", "SOAP", +will prevail.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 3
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact", 1:n),
-                       Description = paste0("Description", 1:n))
-new_recs1 <- sf_create(new_contacts, object_name = "Contact")
-
-# merge the second and third into the first record, but set the
-# description field equal to the description of the second. All other fields
-# will from the first record or, if blank, from the other records
-merge_res <- sf_merge(master_id = new_recs1$id[1],
-                      victim_ids = new_recs1$id[2:3],
-                      object_name = "Contact",
-                      master_fields = tibble("Description" = new_contacts$Description[2]))
-# check the second and third records now have the same Master Record Id as the first
-merge_check <- sf_query(sprintf("SELECT Id, MasterRecordId, Description 
-                                 FROM Contact WHERE Id IN ('%s')", 
-                                 paste0(new_recs1$id, collapse="','")), 
-                        queryall = TRUE)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 3
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact", 1:n),
+                       Description = paste0("Description", 1:n))
+new_recs1 <- sf_create(new_contacts, object_name = "Contact")
+
+# merge the second and third into the first record, but set the
+# description field equal to the description of the second. All other fields
+# will from the first record or, if blank, from the other records
+merge_res <- sf_merge(master_id = new_recs1$id[1],
+                      victim_ids = new_recs1$id[2:3],
+                      object_name = "Contact",
+                      master_fields = tibble("Description" = new_contacts$Description[2]))
+# check the second and third records now have the same Master Record Id as the first
+merge_check <- sf_query(sprintf("SELECT Id, MasterRecordId, Description 
+                                 FROM Contact WHERE Id IN ('%s')", 
+                                 paste0(new_recs1$id, collapse="','")), 
+                        queryall = TRUE)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query.html b/docs/reference/sf_query.html index bdfe3427..f3aea7ff 100644 --- a/docs/reference/sf_query.html +++ b/docs/reference/sf_query.html @@ -1,93 +1,20 @@ - - - - - - - -Perform SOQL Query — sf_query • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Perform SOQL Query — sf_query • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Perform SOQL Query

    - Source: R/query.R + Source: R/query.R
    -

    [Stable]

    +

    [Stable]

    Executes a query against the specified object and returns data that matches the specified criteria.

    - 
    sf_query(
-  soql,
-  object_name = NULL,
-  queryall = FALSE,
-  guess_types = TRUE,
-  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
-  control = list(...),
-  ...,
-  page_size = deprecated(),
-  next_records_url = NULL,
-  bind_using_character_cols = deprecated(),
-  object_name_append = FALSE,
-  object_name_as_col = FALSE,
-  verbose = FALSE
-)
    +
    + 
    sf_query(
+  soql,
+  object_name = NULL,
+  queryall = FALSE,
+  guess_types = TRUE,
+  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
+  control = list(...),
+  ...,
+  page_size = deprecated(),
+  next_records_url = NULL,
+  bind_using_character_cols = deprecated(),
+  object_name_append = FALSE,
+  object_name_as_col = FALSE,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    soql

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    queryall

    logical; indicating if the query recordset should include records +

    +

    Arguments

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    queryall
    +

    logical; indicating if the query recordset should include records that have been deleted because of a merge or delete. Setting this argument to TRUE will also return information about archived Task and Event records. -It is available in API versions 29.0 and later.

    guess_types

    logical; indicating whether or not to use col_guess() +It is available in API versions 29.0 and later.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    api_type

    character; one of "REST", "SOAP", +like numeric looking values that must be preserved as strings ("48.0").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_query_bulk.

    page_size

    numeric; a number between 200 and 2000 indicating the number of +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_query_bulk.

    +
    page_size
    +

    numeric; a number between 200 and 2000 indicating the number of records per page that are returned. Speed benchmarks should be done to better -understand the speed implications of choosing high or low values of this argument.

    next_records_url

    character (leave as NULL); a string used internally -by the function to paginate through to more records until complete

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +understand the speed implications of choosing high or low values of this argument.

    +
    next_records_url
    +

    character (leave as NULL); a string used internally +by the function to paginate through to more records until complete

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    object_name_append

    logical; whether to include the object type -(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

    object_name_as_col

    logical; whether to include the object type -(e.g. Account or Contact) as a new column.

    verbose

    logical; an indicator of whether to print additional +character.

    +
    object_name_append
    +

    logical; whether to include the object type +(e.g. Account or Contact) as part of the column names (e.g. Account.Name).

    +
    object_name_as_col
    +

    logical; whether to include the object type +(e.g. Account or Contact) as a new column.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records

    -

    Note

    - -

    Bulk API query doesn't support the following SOQL:

      -

    • COUNT

      • +
    +
    +

    Note

    +

    Bulk API query doesn't support the following SOQL:

    • COUNT

    • ROLLUP

    • SUM

    • GROUP BY CUBE

      • @@ -307,43 +198,42 @@

      Note

    • Nested SOQL queries

    • Relationship fields

    Additionally, Bulk API can't access or query compound address or compound geolocation fields.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-sf_query("SELECT Id, Account.Name, Email FROM Contact LIMIT 10")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_query("SELECT Id, Account.Name, Email FROM Contact LIMIT 10")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query_bulk_v1.html b/docs/reference/sf_query_bulk_v1.html index d57f6a2d..4590e497 100644 --- a/docs/reference/sf_query_bulk_v1.html +++ b/docs/reference/sf_query_bulk_v1.html @@ -1,92 +1,19 @@ - - - - - - - -Run Bulk 1.0 query — sf_query_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Run Bulk 1.0 query — sf_query_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Run Bulk 1.0 query

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    @@ -190,140 +107,117 @@

    Run Bulk 1.0 query

    query API jobs from the Bulk 1.0 API.

    - 
    sf_query_bulk_v1(
-  soql,
-  object_name = NULL,
-  queryall = FALSE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  interval_seconds = 3,
-  max_attempts = 200,
-  control = list(...),
-  ...,
-  api_type = "Bulk 1.0",
-  verbose = FALSE
-)
    +
    + 
    sf_query_bulk_v1(
+  soql,
+  object_name = NULL,
+  queryall = FALSE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  interval_seconds = 3,
+  max_attempts = 200,
+  control = list(...),
+  ...,
+  api_type = "Bulk 1.0",
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    soql

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    queryall

    logical; indicating if the query recordset should include records +

    +

    Arguments

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    queryall
    +

    logical; indicating if the query recordset should include records that have been deleted because of a merge or delete. Setting this argument to TRUE will also return information about archived Task and Event records. -It is available in API versions 29.0 and later.

    guess_types

    logical; indicating whether or not to use col_guess() +It is available in API versions 29.0 and later.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    interval_seconds

    integer; defines the seconds between attempts to check -for job completion.

    max_attempts

    integer; defines then max number attempts to check for job -completion before stopping.

    control

    list; a list of parameters for controlling the behavior of +character.

    +
    interval_seconds
    +

    integer; defines the seconds between attempts to check +for job completion.

    +
    max_attempts
    +

    integer; defines then max number attempts to check for job +completion before stopping.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    other arguments passed on to sf_control or sf_create_job_bulk -to specify the content_type, concurrency_mode, and/or column_delimiter.

    api_type

    character; one of "REST", "SOAP", +look at the documentation for sf_control.

    +
    ...
    +

    other arguments passed on to sf_control or sf_create_job_bulk +to specify the content_type, concurrency_mode, and/or column_delimiter.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of the recordset returned by the query

    -

    References

    - -

    Bulk 1.0 documentation

    +
    +
    +

    References

    +

    Bulk 1.0 documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-# select all Ids from Account object (up to 1000)
-ids <- sf_query_bulk_v1(soql = 'SELECT Id FROM Account LIMIT 1000', 
-                        object_name = 'Account')
-# alternatively you can specify as 
-ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
-                object_name = 'Account', 
-                api_type="Bulk 1.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# select all Ids from Account object (up to 1000)
+ids <- sf_query_bulk_v1(soql = 'SELECT Id FROM Account LIMIT 1000', 
+                        object_name = 'Account')
+# alternatively you can specify as 
+ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
+                object_name = 'Account', 
+                api_type="Bulk 1.0")
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query_bulk_v2.html b/docs/reference/sf_query_bulk_v2.html index aeb1d21c..9458aebe 100644 --- a/docs/reference/sf_query_bulk_v2.html +++ b/docs/reference/sf_query_bulk_v2.html @@ -1,92 +1,19 @@ - - - - - - - -Run Bulk 2.0 query — sf_query_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Run Bulk 2.0 query — sf_query_bulk_v2 • salesforcer - - - - - - - - + + -
    -
    -

    Run Bulk 2.0 query

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    @@ -190,140 +107,117 @@

    Run Bulk 2.0 query

    query API jobs from the Bulk 2.0 API.

    - 
    sf_query_bulk_v2(
-  soql,
-  object_name = NULL,
-  queryall = FALSE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  interval_seconds = 3,
-  max_attempts = 200,
-  control = list(...),
-  ...,
-  api_type = "Bulk 2.0",
-  verbose = FALSE
-)
    +
    + 
    sf_query_bulk_v2(
+  soql,
+  object_name = NULL,
+  queryall = FALSE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  interval_seconds = 3,
+  max_attempts = 200,
+  control = list(...),
+  ...,
+  api_type = "Bulk 2.0",
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    soql

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    queryall

    logical; indicating if the query recordset should include records +

    +

    Arguments

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    queryall
    +

    logical; indicating if the query recordset should include records that have been deleted because of a merge or delete. Setting this argument to TRUE will also return information about archived Task and Event records. -It is available in API versions 29.0 and later.

    guess_types

    logical; indicating whether or not to use col_guess() +It is available in API versions 29.0 and later.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    interval_seconds

    integer; defines the seconds between attempts to check -for job completion.

    max_attempts

    integer; defines then max number attempts to check for job -completion before stopping.

    control

    list; a list of parameters for controlling the behavior of +character.

    +
    interval_seconds
    +

    integer; defines the seconds between attempts to check +for job completion.

    +
    max_attempts
    +

    integer; defines then max number attempts to check for job +completion before stopping.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    other arguments passed on to sf_control or sf_create_job_bulk -to specify the content_type, concurrency_mode, and/or column_delimiter.

    api_type

    character; one of "REST", "SOAP", +look at the documentation for sf_control.

    +
    ...
    +

    other arguments passed on to sf_control or sf_create_job_bulk +to specify the content_type, concurrency_mode, and/or column_delimiter.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of the recordset returned by the query

    -

    References

    - -

    Bulk 2.0 documentation

    +
    +
    +

    References

    +

    Bulk 2.0 documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-# select all Ids from Account object (up to 1000)
-ids <- sf_query_bulk_v2(soql = 'SELECT Id FROM Account LIMIT 1000', 
-                        object_name = 'Account')
-# alternatively you can specify as 
-ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
-                object_name = 'Account', 
-                api_type="Bulk 2.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# select all Ids from Account object (up to 1000)
+ids <- sf_query_bulk_v2(soql = 'SELECT Id FROM Account LIMIT 1000', 
+                        object_name = 'Account')
+# alternatively you can specify as 
+ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
+                object_name = 'Account', 
+                api_type="Bulk 2.0")
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query_report.html b/docs/reference/sf_query_report.html index d969c28d..6723f965 100644 --- a/docs/reference/sf_query_report.html +++ b/docs/reference/sf_query_report.html @@ -1,94 +1,21 @@ - - - - - - - -Get Report Data without Saving Changes to or Creating a Report — sf_query_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get Report Data without Saving Changes to or Creating a Report — sf_query_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get Report Data without Saving Changes to or Creating a Report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Run a report without creating a new report or changing the existing one by making a POST request to the query resource. This allows you to get report data without filling up your Org with unnecessary reports.

    - 
    sf_query_report(report_id, report_metadata = NULL, verbose = FALSE)
    +
    + 
    sf_query_report(report_id, report_metadata = NULL, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    report_metadata

    list; a list with one element named +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    report_metadata
    +

    list; a list with one element named "reportMetadata" having additional list elements underneath. All possible elements of reportMetadata are documented -HERE, +HERE, but you will most commonly only need to specify the following 3 elements to -filter or query the results of an existing report:

    -
    reportFormat

    A character specifying the format of the report +filter or query the results of an existing report:

    reportFormat
    +

    A character specifying the format of the report with possible values: "TABULAR", "SUMMARY", "MATRIX", or "MULTI_BLOCK".

    -
    reportBooleanFilter

    A character denoting how the individuals + +

    reportBooleanFilter
    +

    A character denoting how the individuals filters specified in reportFilters should be combined. For example, -"(1OR4)AND2AND3"

    . -
    reportFilters

    A list of reportFilter specifications. Each must +"(1OR4)AND2AND3"

    +. +
    reportFilters
    +

    A list of reportFilter specifications. Each must be a list with 3 elements: 1) column, 2) operator, and 3) value. You can find out how certain field types can be filtered by reviewing the results -of sf_list_report_filter_operators.

    +of sf_list_report_filter_operators.

    + -
    verbose

    logical; an indicator of whether to print additional + +

    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df

    -

    Details

    - +
    +
    +

    Details

    Note that you can query a report's data simply by providing its Id. However, the data will only be the detailed data from the tabular format with no totals or other metadata. If you would like more control, for example, @@ -246,61 +163,56 @@

    Details to specify a list to the report_metadata argument. The report_metadata argument requires specific knowledge on the structure the reportMetadata property of a report. For more information, please review the Salesforce documentation -in detail HERE. +in detail HERE. Additional references are provided in the "See Also" section.

    -

    Salesforce Documentation

    - +
    + +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query_result_bulk.html b/docs/reference/sf_query_result_bulk.html index 9eca44e7..2b6c5d27 100644 --- a/docs/reference/sf_query_result_bulk.html +++ b/docs/reference/sf_query_result_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Retrieve the results of a completed bulk query — sf_query_result_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Retrieve the results of a completed bulk query — sf_query_result_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Retrieve the results of a completed bulk query

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    @@ -190,122 +107,105 @@

    Retrieve the results of a completed bulk query

    submitted to the Bulk 1.0 or Bulk 2.0 API and has completed.

    - 
    sf_query_result_bulk(
-  job_id,
-  batch_id = NULL,
-  result_id = NULL,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  batch_size = 50000,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_query_result_bulk(
+  job_id,
+  batch_id = NULL,
+  result_id = NULL,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  batch_size = 50000,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    batch_id

    character; the Salesforce Id assigned to a submitted -batch as returned by sf_create_batches_bulk. It will start with "751".

    result_id

    character; a string returned from -sf_batch_details_bulk when a query has completed and specifies how to -get the recordset

    guess_types

    logical; indicating whether or not to use col_guess() +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    batch_id
    +

    character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

    +
    result_id
    +

    character; a string returned from +sf_batch_details_bulk when a query has completed and specifies how to +get the recordset

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    batch_size

    integer; the number of individual records to be included in a -single batch uploaded to the Bulk APIs (1.0 or 2.0).

    api_type

    character; one of "REST", "SOAP", +character.

    +
    batch_size
    +

    integer; the number of individual records to be included in a +single batch uploaded to the Bulk APIs (1.0 or 2.0).

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df, formatted by Salesforce, containing query results

    -

    References

    - -

    Bulk 1.0 documentation and Bulk 2.0 documentation

    +
    + -

    Examples

    - 
    if (FALSE) {
-my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
-job_info <- sf_create_job_bulk(operation = 'query', object = 'Account')
-query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query)
-result <- sf_batch_details_bulk(job_id = query_info$jobId,
-                                batch_id = query_info$id)
-recordset <- sf_query_result_bulk(job_id = query_info$jobId,
-                                  batch_id = query_info$id,
-                                  result_id = result$result)
-sf_close_job_bulk(job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
+job_info <- sf_create_job_bulk(operation = 'query', object = 'Account')
+query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query)
+result <- sf_batch_details_bulk(job_id = query_info$jobId,
+                                batch_id = query_info$id)
+recordset <- sf_query_result_bulk(job_id = query_info$jobId,
+                                  batch_id = query_info$id,
+                                  result_id = result$result)
+sf_close_job_bulk(job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query_result_bulk_v1.html b/docs/reference/sf_query_result_bulk_v1.html index 38b838a5..ac1d93ee 100644 --- a/docs/reference/sf_query_result_bulk_v1.html +++ b/docs/reference/sf_query_result_bulk_v1.html @@ -1,92 +1,19 @@ - - - - - - - -Retrieve the results of a Bulk 1.0 query — sf_query_result_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Retrieve the results of a Bulk 1.0 query — sf_query_result_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Retrieve the results of a Bulk 1.0 query

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    @@ -190,116 +107,101 @@

    Retrieve the results of a Bulk 1.0 query

    which has already been submitted to Bulk API Job and has Completed state

    - 
    sf_query_result_bulk_v1(
-  job_id,
-  batch_id = NULL,
-  result_id = NULL,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  api_type = c("Bulk 1.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_query_result_bulk_v1(
+  job_id,
+  batch_id = NULL,
+  result_id = NULL,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  api_type = c("Bulk 1.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    batch_id

    character; the Salesforce Id assigned to a submitted -batch as returned by sf_create_batches_bulk. It will start with "751".

    result_id

    character; a string returned from -sf_batch_details_bulk when a query has completed and specifies how to -get the recordset

    guess_types

    logical; indicating whether or not to use col_guess() +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    batch_id
    +

    character; the Salesforce Id assigned to a submitted +batch as returned by sf_create_batches_bulk. It will start with "751".

    +
    result_id
    +

    character; a string returned from +sf_batch_details_bulk when a query has completed and specifies how to +get the recordset

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    api_type

    character; one of "REST", "SOAP", +character.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df, formatted by Salesforce, containing query results

    -

    References

    - -

    Bulk 1.0 documentation

    +
    +
    +

    References

    +

    Bulk 1.0 documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
-job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 1.0")
-query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 1.0")
-result <- sf_batch_details_bulk(job_id = query_info$jobId,
-                                batch_id = query_info$id)
-recordset <- sf_query_result_bulk(job_id = query_info$jobId,
-                                  batch_id = query_info$id,
-                                  result_id = result$result)
-sf_close_job_bulk(job_info$id, api_type="Bulk 1.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
+job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 1.0")
+query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 1.0")
+result <- sf_batch_details_bulk(job_id = query_info$jobId,
+                                batch_id = query_info$id)
+recordset <- sf_query_result_bulk(job_id = query_info$jobId,
+                                  batch_id = query_info$id,
+                                  result_id = result$result)
+sf_close_job_bulk(job_info$id, api_type="Bulk 1.0")
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_query_result_bulk_v2.html b/docs/reference/sf_query_result_bulk_v2.html index c1a4a912..2f0f6393 100644 --- a/docs/reference/sf_query_result_bulk_v2.html +++ b/docs/reference/sf_query_result_bulk_v2.html @@ -1,93 +1,20 @@ - - - - - - - -Retrieve the results of a Bulk 2.0 query — sf_query_result_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Retrieve the results of a Bulk 2.0 query — sf_query_result_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Retrieve the results of a Bulk 2.0 query

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    @@ -192,117 +109,102 @@

    Retrieve the results of a Bulk 2.0 query

    state.

    - 
    sf_query_result_bulk_v2(
-  job_id,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  batch_size = 50000,
-  locator = NULL,
-  api_type = c("Bulk 2.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_query_result_bulk_v2(
+  job_id,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  batch_size = 50000,
+  locator = NULL,
+  api_type = c("Bulk 2.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    guess_types

    logical; indicating whether or not to use col_guess() +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    batch_size

    integer; the number of individual records to be included in a -single batch uploaded to the Bulk APIs (1.0 or 2.0).

    locator

    character; a string returned found in the API response +character.

    +
    batch_size
    +

    integer; the number of individual records to be included in a +single batch uploaded to the Bulk APIs (1.0 or 2.0).

    +
    locator
    +

    character; a string returned found in the API response header of a prior iteration of sf_query_result_bulk_v2 that is included in the query string of the next call to paginate through all records returned -by the query.

    api_type

    character; one of "REST", "SOAP", +by the query.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df, formatted by Salesforce, containing query results

    -

    References

    - -

    Bulk 2.0 documentation

    +
    +
    +

    References

    +

    Bulk 2.0 documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
-job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 2.0")
-query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 2.0")
-result <- sf_batch_details_bulk(job_id = query_info$jobId,
-                                batch_id = query_info$id)
-recordset <- sf_query_result_bulk(job_id = query_info$jobId,
-                                  batch_id = query_info$id,
-                                  result_id = result$result)
-sf_close_job_bulk(job_info$id, api_type="Bulk 2.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
+job_info <- sf_create_job_bulk(operation = 'query', object = 'Account', api_type="Bulk 2.0")
+query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query, api_type="Bulk 2.0")
+result <- sf_batch_details_bulk(job_id = query_info$jobId,
+                                batch_id = query_info$id)
+recordset <- sf_query_result_bulk(job_id = query_info$jobId,
+                                  batch_id = query_info$id,
+                                  result_id = result$result)
+sf_close_job_bulk(job_info$id, api_type="Bulk 2.0")
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_read_metadata.html b/docs/reference/sf_read_metadata.html index 104c41a4..af354678 100644 --- a/docs/reference/sf_read_metadata.html +++ b/docs/reference/sf_read_metadata.html @@ -1,93 +1,20 @@ - - - - - - - -Read Object or Field Metadata from Salesforce — sf_read_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Read Object or Field Metadata from Salesforce — sf_read_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Read Object or Field Metadata from Salesforce

    - Source: R/read-metadata.R + Source: R/read-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes a request of named elements in Salesforce and returns their metadata

    - 
    sf_read_metadata(metadata_type, object_names, verbose = FALSE)
    +
    + 
    sf_read_metadata(metadata_type, object_names, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    metadata_type

    character; string on what type of metadata to create.

    object_names

    a character vector of names that we wish to read metadata for

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    metadata_type
    +

    character; string on what type of metadata to create.

    +
    object_names
    +

    a character vector of names that we wish to read metadata for

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list containing a response for each requested object

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/

    +
    + -

    Examples

    - 
    if (FALSE) {
-metadata_info <- sf_read_metadata(metadata_type='CustomObject', 
-                                  object_names=c('Account'))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+metadata_info <- sf_read_metadata(metadata_type='CustomObject', 
+                                  object_names=c('Account'))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_rename_metadata.html b/docs/reference/sf_rename_metadata.html index 2312d390..cab3db4e 100644 --- a/docs/reference/sf_rename_metadata.html +++ b/docs/reference/sf_rename_metadata.html @@ -1,93 +1,20 @@ - - - - - - - -Rename Metadata Elements in Salesforce — sf_rename_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Rename Metadata Elements in Salesforce — sf_rename_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Rename Metadata Elements in Salesforce

    - Source: R/rename-metadata.R + Source: R/rename-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes an old and new name for a metadata element in Salesforce and applies the new name

    - 
    sf_rename_metadata(metadata_type, old_fullname, new_fullname, verbose = FALSE)
    +
    + 
    sf_rename_metadata(metadata_type, old_fullname, new_fullname, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    metadata_type

    character; string on what type of metadata to create.

    old_fullname

    character; string corresponding to the fullName of the element you would -like to rename

    new_fullname

    character; string corresponding to the new fullName you would like -to apply the targeted element

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    metadata_type
    +

    character; string on what type of metadata to create.

    +
    old_fullname
    +

    character; string corresponding to the fullName of the element you would +like to rename

    +
    new_fullname
    +

    character; string corresponding to the new fullName you would like +to apply the targeted element

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A data.frame containing the creation result for each submitted metadata component

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/

    +
    + -

    Examples

    - 
    if (FALSE) {
-renamed_custom_object <- sf_rename_metadata(metadata_type = 'CustomObject', 
-                                            old_fullname = 'Custom_Account32__c', 
-                                            new_fullname = 'Custom_Account99__c')
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+renamed_custom_object <- sf_rename_metadata(metadata_type = 'CustomObject', 
+                                            old_fullname = 'Custom_Account32__c', 
+                                            new_fullname = 'Custom_Account99__c')
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_reorder_cols.html b/docs/reference/sf_reorder_cols.html index a6412c49..9a6a04cd 100644 --- a/docs/reference/sf_reorder_cols.html +++ b/docs/reference/sf_reorder_cols.html @@ -1,91 +1,18 @@ - - - - - - - -Reorder resultset columns to prioritize sObject and Id — sf_reorder_cols • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Reorder resultset columns to prioritize sObject and Id — sf_reorder_cols • salesforcer - - - - - - - - + + -
    -
    -

    Reorder resultset columns to prioritize sObject and Id

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -188,52 +105,47 @@

    Reorder resultset columns to prioritize sObject and IdThis function accepts a tbl_df with columns rearranged.

    - 
    sf_reorder_cols(df)
    - -

    Arguments

    - - - - - - -
    df

    tbl_df; the data frame to rearrange columns in

    - -

    Value

    +
    + 
    sf_reorder_cols(df)
    +
    +
    +

    Arguments

    +
    df
    +

    tbl_df; the data frame to rearrange columns in

    +
    +
    +

    Value

    tbl_df the formatted data frame

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_children.html b/docs/reference/sf_report_folder_children.html index 4359d7df..b1305f9b 100644 --- a/docs/reference/sf_report_folder_children.html +++ b/docs/reference/sf_report_folder_children.html @@ -1,91 +1,18 @@ - - - - - - - -Get the subfolders (children) of a report folder — sf_report_folder_children • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get the subfolders (children) of a report folder — sf_report_folder_children • salesforcer - - - - - - - - + + -
    -
    -

    Get the subfolders (children) of a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_children(report_folder_id, page_size = 10, page = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    page_size

    integer; integer that indicates how many results each -page returns. Default is 10.

    page

    integer; integer that indicates which page of results to return.

    +
    + 
    sf_report_folder_children(report_folder_id, page_size = 10, page = NULL)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    page_size
    +

    integer; integer that indicates how many results each +page returns. Default is 10.

    +
    page
    +

    integer; integer that indicates which page of results to return.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_create.html b/docs/reference/sf_report_folder_create.html index 2f9cc048..68e7c89b 100644 --- a/docs/reference/sf_report_folder_create.html +++ b/docs/reference/sf_report_folder_create.html @@ -1,91 +1,18 @@ - - - - - - - -Create report folder — sf_report_folder_create • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create report folder — sf_report_folder_create • salesforcer - - - - - - - - + + -
    -
    -

    Create report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_create(body)
    +
    + 
    sf_report_folder_create(body)
    +
    -

    Arguments

    - - - - - - -
    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_delete.html b/docs/reference/sf_report_folder_delete.html index 4767f1cf..9376d043 100644 --- a/docs/reference/sf_report_folder_delete.html +++ b/docs/reference/sf_report_folder_delete.html @@ -1,91 +1,18 @@ - - - - - - - -Delete a report folder — sf_report_folder_delete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete a report folder — sf_report_folder_delete • salesforcer - - - - - - - - + + -
    -
    -

    Delete a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_delete(report_folder_id)
    - -

    Arguments

    - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    - -

    Value

    +
    + 
    sf_report_folder_delete(report_folder_id)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    +
    +

    Value

    logical

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_describe.html b/docs/reference/sf_report_folder_describe.html index 41d9d9c5..58a4b85c 100644 --- a/docs/reference/sf_report_folder_describe.html +++ b/docs/reference/sf_report_folder_describe.html @@ -1,91 +1,18 @@ - - - - - - - -Describe a report folder — sf_report_folder_describe • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe a report folder — sf_report_folder_describe • salesforcer - - - - - - - - + + -
    -
    -

    Describe a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_describe(report_folder_id)
    - -

    Arguments

    - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    - -

    Value

    +
    + 
    sf_report_folder_describe(report_folder_id)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_share_delete.html b/docs/reference/sf_report_folder_share_delete.html index 7ca2f680..8c2a2d8c 100644 --- a/docs/reference/sf_report_folder_share_delete.html +++ b/docs/reference/sf_report_folder_share_delete.html @@ -1,91 +1,18 @@ - - - - - - - -Delete a report folder share — sf_report_folder_share_delete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Delete a report folder share — sf_report_folder_share_delete • salesforcer - - - - - - - - + + -
    -
    -

    Delete a report folder share

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_share_delete(report_folder_id, share_id)
    - -

    Arguments

    - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    share_id

    character; the Salesforce Id assigned to a created -analytics folder share (it will start with "004").

    - -

    Value

    +
    + 
    sf_report_folder_share_delete(report_folder_id, share_id)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    share_id
    +

    character; the Salesforce Id assigned to a created +analytics folder share (it will start with "004").

    +
    +
    +

    Value

    logical

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_share_describe.html b/docs/reference/sf_report_folder_share_describe.html index 417ec75a..1ba5af06 100644 --- a/docs/reference/sf_report_folder_share_describe.html +++ b/docs/reference/sf_report_folder_share_describe.html @@ -1,91 +1,18 @@ - - - - - - - -Describe a report folder share — sf_report_folder_share_describe • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Describe a report folder share — sf_report_folder_share_describe • salesforcer - - - - - - - - + + -
    -
    -

    Describe a report folder share

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_share_describe(report_folder_id, share_id)
    - -

    Arguments

    - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    share_id

    character; the Salesforce Id assigned to a created -analytics folder share (it will start with "004").

    - -

    Value

    +
    + 
    sf_report_folder_share_describe(report_folder_id, share_id)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    share_id
    +

    character; the Salesforce Id assigned to a created +analytics folder share (it will start with "004").

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_share_recipients.html b/docs/reference/sf_report_folder_share_recipients.html index 30ad205c..b1989605 100644 --- a/docs/reference/sf_report_folder_share_recipients.html +++ b/docs/reference/sf_report_folder_share_recipients.html @@ -1,91 +1,18 @@ - - - - - - - -Get report folder share recipients — sf_report_folder_share_recipients • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get report folder share recipients — sf_report_folder_share_recipients • salesforcer - - - - - - - - + + -
    -
    -

    Get report folder share recipients

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_share_recipients(
-  report_folder_id,
-  share_type = c("User", "Group", "Role"),
-  search_term = "",
-  limit = 100
-)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    share_type

    character; Return data for the recipients of the -specified type, such as "User", "Group", or "Role".

    search_term

    character; Search to match share recipients' names. -Default is "" (no restriction).

    limit

    integer; Limit to the number of search results. Default is 100.

    - -

    Value

    +
    + 
    sf_report_folder_share_recipients(
+  report_folder_id,
+  share_type = c("User", "Group", "Role"),
+  search_term = "",
+  limit = 100
+)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    share_type
    +

    character; Return data for the recipients of the +specified type, such as "User", "Group", or "Role".

    +
    search_term
    +

    character; Search to match share recipients' names. +Default is "" (no restriction).

    +
    limit
    +

    integer; Limit to the number of search results. Default is 100.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_share_update.html b/docs/reference/sf_report_folder_share_update.html index 91d839b7..a6c153e2 100644 --- a/docs/reference/sf_report_folder_share_update.html +++ b/docs/reference/sf_report_folder_share_update.html @@ -1,91 +1,18 @@ - - - - - - - -Update a report folder share — sf_report_folder_share_update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update a report folder share — sf_report_folder_share_update • salesforcer - - - - - - - - + + -
    -
    -

    Update a report folder share

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_share_update(report_folder_id, share_id, body)
    +
    + 
    sf_report_folder_share_update(report_folder_id, share_id, body)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    share_id

    character; the Salesforce Id assigned to a created -analytics folder share (it will start with "004").

    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    share_id
    +

    character; the Salesforce Id assigned to a created +analytics folder share (it will start with "004").

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_shares_add.html b/docs/reference/sf_report_folder_shares_add.html index 9185a422..e656ec45 100644 --- a/docs/reference/sf_report_folder_shares_add.html +++ b/docs/reference/sf_report_folder_shares_add.html @@ -1,92 +1,19 @@ - - - - - - - -Add shares to a report folder — sf_report_folder_shares_add • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Add shares to a report folder — sf_report_folder_shares_add • salesforcer - - - - - - - - + + -
    -
    -

    Add shares to a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    Creates new shares and appends them to the existing share list for the folder.

    - 
    sf_report_folder_shares_add(report_folder_id, body)
    +
    + 
    sf_report_folder_shares_add(report_folder_id, body)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_shares_list.html b/docs/reference/sf_report_folder_shares_list.html index 40ae8ad2..5b9ec59a 100644 --- a/docs/reference/sf_report_folder_shares_list.html +++ b/docs/reference/sf_report_folder_shares_list.html @@ -1,91 +1,18 @@ - - - - - - - -List the shares in a report folder — sf_report_folder_shares_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List the shares in a report folder — sf_report_folder_shares_list • salesforcer - - - - - - - - + + -
    -
    -

    List the shares in a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_shares_list(report_folder_id)
    - -

    Arguments

    - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    - -

    Value

    +
    + 
    sf_report_folder_shares_list(report_folder_id)
    +
    +
    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_shares_update.html b/docs/reference/sf_report_folder_shares_update.html index bb8337ff..3d3930eb 100644 --- a/docs/reference/sf_report_folder_shares_update.html +++ b/docs/reference/sf_report_folder_shares_update.html @@ -1,92 +1,19 @@ - - - - - - - -Update the shares for a report folder — sf_report_folder_shares_update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update the shares for a report folder — sf_report_folder_shares_update • salesforcer - - - - - - - - + + -
    -
    -

    Update the shares for a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    Creates new shares to replace the existing shares in the share list for the folder.

    - 
    sf_report_folder_shares_update(report_folder_id, body)
    +
    + 
    sf_report_folder_shares_update(report_folder_id, body)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folder_update.html b/docs/reference/sf_report_folder_update.html index c73572b2..ba5ccca2 100644 --- a/docs/reference/sf_report_folder_update.html +++ b/docs/reference/sf_report_folder_update.html @@ -1,91 +1,18 @@ - - - - - - - -Update a report folder — sf_report_folder_update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update a report folder — sf_report_folder_update • salesforcer - - - - - - - - + + -
    -
    -

    Update a report folder

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folder_update(report_folder_id, body)
    +
    + 
    sf_report_folder_update(report_folder_id, body)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_folder_id

    character; the Salesforce Id assigned to a created -analytics folder (it will start with "00l").

    body

    list; a list of data to be formatted as JSON before being +

    +

    Arguments

    +
    report_folder_id
    +

    character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

    +
    body
    +

    list; a list of data to be formatted as JSON before being sent to an API endpoint. This is NOT validated and is only experimental in allowing users to utilize the API functionality before wrapper functions have been written in R to format and validate the request in a more -user-friendly format.

    - -

    Value

    - +user-friendly format.

    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_report_folders_list.html b/docs/reference/sf_report_folders_list.html index c31df12b..c6e6eb95 100644 --- a/docs/reference/sf_report_folders_list.html +++ b/docs/reference/sf_report_folders_list.html @@ -1,91 +1,18 @@ - - - - - - - -List report folders — sf_report_folders_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List report folders — sf_report_folders_list • salesforcer - - - - - - - - + + -
    -
    -

    List report folders

    - Source: R/analytics-report-folder.R + Source: R/analytics-report-folder.R
    -

    [Experimental]

    +

    [Experimental]

    - 
    sf_report_folders_list()
    - - -

    Value

    +
    + 
    sf_report_folders_list()
    +
    +
    +

    Value

    list

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_reset_password.html b/docs/reference/sf_reset_password.html index 028293dc..709410f3 100644 --- a/docs/reference/sf_reset_password.html +++ b/docs/reference/sf_reset_password.html @@ -1,92 +1,19 @@ - - - - - - - -Reset User Password — sf_reset_password • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Reset User Password — sf_reset_password • salesforcer - - - - - - - - + + -
    -
    -

    Reset User Password

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Changes a user’s password to a temporary, system-generated value.

    - 
    sf_reset_password(user_id, control = list(...), ..., verbose = FALSE)
    +
    + 
    sf_reset_password(user_id, control = list(...), ..., verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    user_id

    character; the unique Salesforce Id assigned to the User

    control

    list; a list of parameters for controlling the behavior of +

    +

    Arguments

    +
    user_id
    +

    character; the unique Salesforce Id assigned to the User

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list

    +
    -

    Examples

    - 
    if (FALSE) {
-# reset a user's password and ensure that an email is triggered to them
-sf_reset_password(user_id = "0056A000000ZZZaaBBB", 
-                  EmailHeader = list(triggerAutoResponseEmail = FALSE, 
-                                     triggerOtherEmail = FALSE, 
-                                     triggerUserEmail = TRUE))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# reset a user's password and ensure that an email is triggered to them
+sf_reset_password(user_id = "0056A000000ZZZaaBBB", 
+                  EmailHeader = list(triggerAutoResponseEmail = FALSE, 
+                                     triggerOtherEmail = FALSE, 
+                                     triggerUserEmail = TRUE))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_rest_list.html b/docs/reference/sf_rest_list.html index f4906266..18d2139c 100644 --- a/docs/reference/sf_rest_list.html +++ b/docs/reference/sf_rest_list.html @@ -1,91 +1,18 @@ - - - - - - - -Execute a non-paginated REST API call to list items — sf_rest_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Execute a non-paginated REST API call to list items — sf_rest_list • salesforcer - - - - - - - - + + -
    -
    -

    Execute a non-paginated REST API call to list items

    - Source: R/utils-httr.R + Source: R/utils-httr.R
    @@ -188,64 +105,60 @@

    Execute a non-paginated REST API call to list items

    Execute a non-paginated REST API call to list items

    - 
    sf_rest_list(url, as_tbl = FALSE, records_root = NULL, verbose = FALSE)
    +
    + 
    sf_rest_list(url, as_tbl = FALSE, records_root = NULL, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    as_tbl

    logical; an indicator of whether to convert the parsed -JSON into a tbl_df.

    records_root

    character or integer; an index or string that +

    +

    Arguments

    +
    url
    +

    character; a valid REST API URL (as a string)

    +
    as_tbl
    +

    logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

    +
    records_root
    +

    character or integer; an index or string that identifies the element in the parsed list which contains the records returned by the API call. By default, this argument is NULL, which means that -each element in the list is an individual record.

    verbose

    logical; an indicator of whether to print additional +each element in the list is an individual record.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Note

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    +

    tbl_df or list of data depending on what was requested.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_retrieve.html b/docs/reference/sf_retrieve.html index 8031d4d5..a1ccf800 100644 --- a/docs/reference/sf_retrieve.html +++ b/docs/reference/sf_retrieve.html @@ -1,92 +1,19 @@ - - - - - - - -Retrieve Records By Id — sf_retrieve • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Retrieve Records By Id — sf_retrieve • salesforcer - - - - - - - - + + -
    -
    -

    Retrieve Records By Id

    - Source: R/retrieve.R + Source: R/retrieve.R
    -

    [Stable]

    +

    [Stable]

    Retrieves one or more new records to your organization’s data.

    - 
    sf_retrieve(
-  ids,
-  fields,
-  object_name,
-  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
-  guess_types = TRUE,
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_retrieve(
+  ids,
+  fields,
+  object_name,
+  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
+  guess_types = TRUE,
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ids

    vector, matrix, data.frame, or +

    +

    Arguments

    +
    ids
    +

    vector, matrix, data.frame, or tbl_df; if not a vector, there must be a column called Id (case -insensitive) that can be passed in the request.

    fields

    character; one or more strings indicating the fields to be returned -on the records

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +insensitive) that can be passed in the request.

    +
    fields
    +

    character; one or more strings indicating the fields to be returned +on the records

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    guess_types

    logical; indicating whether or not to use col_guess() +making the request.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    control

    list; a list of parameters for controlling the behavior of +like numeric looking values that must be preserved as strings ("48.0").

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tibble

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 3
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact", 1:n))
-new_contacts_result <- sf_create(new_contacts, object_name="Contact")
-retrieved_records <- sf_retrieve(ids=new_contacts_result$id,
-                                 fields=c("LastName"),
-                                 object_name="Contact")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 3
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact", 1:n))
+new_contacts_result <- sf_create(new_contacts, object_name="Contact")
+retrieved_records <- sf_retrieve(ids=new_contacts_result$id,
+                                 fields=c("LastName"),
+                                 object_name="Contact")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_retrieve_metadata.html b/docs/reference/sf_retrieve_metadata.html index 4b6e36bf..38ab9c5a 100644 --- a/docs/reference/sf_retrieve_metadata.html +++ b/docs/reference/sf_retrieve_metadata.html @@ -1,94 +1,21 @@ - - - - - - - -Make A Request to Retrieve the Metadata — sf_retrieve_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Make A Request to Retrieve the Metadata — sf_retrieve_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Make A Request to Retrieve the Metadata

    - Source: R/retrieve-metadata.R + Source: R/retrieve-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function makes a request to retrieve metadata as a package XML files that can be modified and later deployed into an environment

    - 
    sf_retrieve_metadata(
-  retrieve_request,
-  filename = "package.zip",
-  check_interval = 3,
-  max_tries = 20,
-  verbose = FALSE
-)
    +
    + 
    sf_retrieve_metadata(
+  retrieve_request,
+  filename = "package.zip",
+  check_interval = 3,
+  max_tries = 20,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    retrieve_request

    a list of parameters defining what XML file representations -should be returned

    filename

    a file path to save the zip file in the event that it is downloaded. The +

    +

    Arguments

    +
    retrieve_request
    +

    a list of parameters defining what XML file representations +should be returned

    +
    filename
    +

    a file path to save the zip file in the event that it is downloaded. The name must have a .zip extension. The default behavior will be to save in the current -working directory as "package.zip"

    check_interval

    numeric; specifying the seconds to wait between retrieve -status requests to check if complete

    max_tries

    numeric; specifying the maximum number of times to check -whether the retrieve package.zip is complete before the function times out

    verbose

    logical; an indicator of whether to print additional +working directory as "package.zip"

    +
    check_interval
    +

    numeric; specifying the seconds to wait between retrieve +status requests to check if complete

    +
    max_tries
    +

    numeric; specifying the maximum number of times to check +whether the retrieve package.zip is complete before the function times out

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list of details from the created retrieve request

    -

    Note

    - +
    + + -

    Examples

    - 
    if (FALSE) {
-retrieve_request <- list(unpackaged=list(types=list(members='*',
-                                                    name='CustomObject')))
-retrieve_info <- sf_retrieve_metadata(retrieve_request)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+retrieve_request <- list(unpackaged=list(types=list(members='*',
+                                                    name='CustomObject')))
+retrieve_info <- sf_retrieve_metadata(retrieve_request)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_retrieve_metadata_check_status.html b/docs/reference/sf_retrieve_metadata_check_status.html index 1d6bac18..0e2ed269 100644 --- a/docs/reference/sf_retrieve_metadata_check_status.html +++ b/docs/reference/sf_retrieve_metadata_check_status.html @@ -1,93 +1,20 @@ - - - - - - - -Check on Retrieve Calls and Get Contents If Available — sf_retrieve_metadata_check_status • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Check on Retrieve Calls and Get Contents If Available — sf_retrieve_metadata_check_status • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Check on Retrieve Calls and Get Contents If Available

    - Source: R/retrieve-metadata.R + Source: R/retrieve-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function returns details about an initiated retrieveMetadata request and saves the results into a zip file

    - 
    sf_retrieve_metadata_check_status(
-  id,
-  include_zip = TRUE,
-  filename = "package.zip",
-  verbose = FALSE
-)
    +
    + 
    sf_retrieve_metadata_check_status(
+  id,
+  include_zip = TRUE,
+  filename = "package.zip",
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    id

    character; string id returned from sf_retrieve_metadata

    include_zip

    logical; Set to false to check the status of the retrieval without -attempting to retrieve the zip file. If omitted, this argument defaults to true.

    filename

    a file path to save the zip file in the event that it is downloaded. The +

    +

    Arguments

    +
    id
    +

    character; string id returned from sf_retrieve_metadata

    +
    include_zip
    +

    logical; Set to false to check the status of the retrieval without +attempting to retrieve the zip file. If omitted, this argument defaults to true.

    +
    filename
    +

    a file path to save the zip file in the event that it is downloaded. The name must have a .zip extension. The default behavior will be to save in the current -working directory as package.zip

    verbose

    logical; an indicator of whether to print additional +working directory as package.zip

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list of the response

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_checkretrievestatus.htm

    - -

    Examples

    - 
    if (FALSE) {
-retrieve_request <- list(unpackaged=list(types=list(members='*', name='CustomObject')))
-retrieve_info <- sf_retrieve_metadata(retrieve_request)
+    
    
+    
 
-# check on status, this will automatically download the contents to package.zip when ready
-retrieve_status <- sf_retrieve_metadata_check_status(retrieve_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+retrieve_request <- list(unpackaged=list(types=list(members='*', name='CustomObject')))
+retrieve_info <- sf_retrieve_metadata(retrieve_request)
+
+# check on status, this will automatically download the contents to package.zip when ready
+retrieve_status <- sf_retrieve_metadata_check_status(retrieve_info$id)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_retrieve_rest.html b/docs/reference/sf_retrieve_rest.html index 9d4fa549..68ec1f56 100644 --- a/docs/reference/sf_retrieve_rest.html +++ b/docs/reference/sf_retrieve_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Retrieve records using REST API — sf_retrieve_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Retrieve records using REST API — sf_retrieve_rest • salesforcer - - - - - - - - + + -
    -
    -

    Retrieve records using REST API

    - Source: R/retrieve.R + Source: R/retrieve.R
    @@ -188,49 +105,46 @@

    Retrieve records using REST API

    Retrieve records using REST API

    - 
    sf_retrieve_rest(
-  ids,
-  fields,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_retrieve_rest(
+  ids,
+  fields,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_retrieve_soap.html b/docs/reference/sf_retrieve_soap.html index 912f97ac..2ba6947d 100644 --- a/docs/reference/sf_retrieve_soap.html +++ b/docs/reference/sf_retrieve_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Retrieve records using SOAP API — sf_retrieve_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Retrieve records using SOAP API — sf_retrieve_soap • salesforcer - - - - - - - - + + -
    -
    -

    Retrieve records using SOAP API

    - Source: R/retrieve.R + Source: R/retrieve.R
    @@ -188,49 +105,46 @@

    Retrieve records using SOAP API

    Retrieve records using SOAP API

    - 
    sf_retrieve_soap(
-  ids,
-  fields,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_retrieve_soap(
+  ids,
+  fields,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_run_bulk_operation.html b/docs/reference/sf_run_bulk_operation.html index 71bbd946..0ad3388c 100644 --- a/docs/reference/sf_run_bulk_operation.html +++ b/docs/reference/sf_run_bulk_operation.html @@ -1,92 +1,19 @@ - - - - - - - -Run Bulk Operation — sf_run_bulk_operation • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Run Bulk Operation — sf_run_bulk_operation • salesforcer - - - - - - - - + + -
    -
    -

    Run Bulk Operation

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    -

    [Stable]

    +

    [Stable]

    This function is a convenience wrapper for submitting bulk API jobs

    - 
    sf_run_bulk_operation(
-  input_data,
-  object_name,
-  operation = c("insert", "delete", "upsert", "update", "hardDelete"),
-  external_id_fieldname = NULL,
-  guess_types = TRUE,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  batch_size = NULL,
-  interval_seconds = 3,
-  max_attempts = 200,
-  wait_for_results = TRUE,
-  record_types = c("successfulResults", "failedResults", "unprocessedRecords"),
-  combine_record_types = TRUE,
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
-
-sf_bulk_operation(
-  input_data,
-  object_name,
-  operation = c("insert", "delete", "upsert", "update", "hardDelete"),
-  external_id_fieldname = NULL,
-  guess_types = TRUE,
-  api_type = c("Bulk 1.0", "Bulk 2.0"),
-  batch_size = NULL,
-  interval_seconds = 3,
-  max_attempts = 200,
-  wait_for_results = TRUE,
-  record_types = c("successfulResults", "failedResults", "unprocessedRecords"),
-  combine_record_types = TRUE,
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_run_bulk_operation(
+  input_data,
+  object_name,
+  operation = c("insert", "delete", "upsert", "update", "hardDelete"),
+  external_id_fieldname = NULL,
+  guess_types = TRUE,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  batch_size = NULL,
+  interval_seconds = 3,
+  max_attempts = 200,
+  wait_for_results = TRUE,
+  record_types = c("successfulResults", "failedResults", "unprocessedRecords"),
+  combine_record_types = TRUE,
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
+
+sf_bulk_operation(
+  input_data,
+  object_name,
+  operation = c("insert", "delete", "upsert", "update", "hardDelete"),
+  external_id_fieldname = NULL,
+  guess_types = TRUE,
+  api_type = c("Bulk 1.0", "Bulk 2.0"),
+  batch_size = NULL,
+  interval_seconds = 3,
+  max_attempts = 200,
+  wait_for_results = TRUE,
+  record_types = c("successfulResults", "failedResults", "unprocessedRecords"),
+  combine_record_types = TRUE,
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    input_data

    named vector, matrix, data.frame, or -tbl_df; data can be coerced into CSV file for submitting as batch request

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    operation

    character; string defining the type of operation being performed

    external_id_fieldname

    character; string identifying a custom field on the +

    +

    Arguments

    +
    input_data
    +

    named vector, matrix, data.frame, or +tbl_df; data can be coerced into CSV file for submitting as batch request

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    operation
    +

    character; string defining the type of operation being performed

    +
    external_id_fieldname
    +

    character; string identifying a custom field on the object that has been set as an "External ID" field. This field is used to reference -objects during upserts to determine if the record already exists in Salesforce or not.

    guess_types

    logical; indicating whether or not to use col_guess() +objects during upserts to determine if the record already exists in Salesforce or not.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    api_type

    character; one of "REST", "SOAP", +like numeric looking values that must be preserved as strings ("48.0").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    batch_size

    integer; the number of individual records to be included in a -single batch uploaded to the Bulk APIs (1.0 or 2.0).

    interval_seconds

    integer; defines the seconds between attempts to check -for job completion.

    max_attempts

    integer; defines then max number attempts to check for job -completion before stopping.

    wait_for_results

    logical; indicating whether to wait for the operation to complete -so that the batch results of individual records can be obtained

    record_types

    character; one or more types of records to retrieve -from the results of running the specified job

    combine_record_types

    logical; indicating for Bulk 2.0 jobs whether the +making the request.

    +
    batch_size
    +

    integer; the number of individual records to be included in a +single batch uploaded to the Bulk APIs (1.0 or 2.0).

    +
    interval_seconds
    +

    integer; defines the seconds between attempts to check +for job completion.

    +
    max_attempts
    +

    integer; defines then max number attempts to check for job +completion before stopping.

    +
    wait_for_results
    +

    logical; indicating whether to wait for the operation to complete +so that the batch results of individual records can be obtained

    +
    record_types
    +

    character; one or more types of records to retrieve +from the results of running the specified job

    +
    combine_record_types
    +

    logical; indicating for Bulk 2.0 jobs whether the successfulResults, failedResults, and unprocessedRecords should be stacked -together by binding the rows

    control

    list; a list of parameters for controlling the behavior of +together by binding the rows

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    other arguments passed on to sf_control or sf_create_job_bulk -to specify the content_type, concurrency_mode, and/or column_delimiter.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    other arguments passed on to sf_control or sf_create_job_bulk +to specify the content_type, concurrency_mode, and/or column_delimiter.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of the results of the bulk job

    -

    Note

    - +
    +
    +

    Note

    With Bulk 2.0 the order of records in the response is not guaranteed to match the ordering of records in the original job data.

    -

    See also

    - -

    Salesforce Documentation

    +
    +
    +

    See also

    +

    Salesforce Documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 20
-new_contacts <- tibble(FirstName = rep("Test", n), 
-                       LastName = paste0("Contact", 1:n))
-# insert new records into the Contact object
-inserts <- sf_bulk_operation(input_data = new_contacts, 
-                             object_name = "Contact", 
-                             operation = "insert")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 20
+new_contacts <- tibble(FirstName = rep("Test", n), 
+                       LastName = paste0("Contact", 1:n))
+# insert new records into the Contact object
+inserts <- sf_bulk_operation(input_data = new_contacts, 
+                             object_name = "Contact", 
+                             operation = "insert")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_run_bulk_query.html b/docs/reference/sf_run_bulk_query.html index fda699dd..aab12602 100644 --- a/docs/reference/sf_run_bulk_query.html +++ b/docs/reference/sf_run_bulk_query.html @@ -1,93 +1,20 @@ - - - - - - - -Run bulk query — sf_run_bulk_query • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Run bulk query — sf_run_bulk_query • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Run bulk query

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    -

    [Stable]

    +

    [Stable]

    This function is a convenience wrapper for submitting and retrieving query API jobs from the Bulk 1.0 and Bulk 2.0 APIs.

    - 
    sf_run_bulk_query(
-  soql,
-  object_name = NULL,
-  queryall = FALSE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  interval_seconds = 3,
-  max_attempts = 200,
-  control = list(...),
-  ...,
-  api_type = c("Bulk 2.0", "Bulk 1.0"),
-  verbose = FALSE
-)
-
-sf_query_bulk(
-  soql,
-  object_name = NULL,
-  queryall = FALSE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  interval_seconds = 3,
-  max_attempts = 200,
-  control = list(...),
-  ...,
-  api_type = c("Bulk 2.0", "Bulk 1.0"),
-  verbose = FALSE
-)
    +
    + 
    sf_run_bulk_query(
+  soql,
+  object_name = NULL,
+  queryall = FALSE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  interval_seconds = 3,
+  max_attempts = 200,
+  control = list(...),
+  ...,
+  api_type = c("Bulk 2.0", "Bulk 1.0"),
+  verbose = FALSE
+)
+
+sf_query_bulk(
+  soql,
+  object_name = NULL,
+  queryall = FALSE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  interval_seconds = 3,
+  max_attempts = 200,
+  control = list(...),
+  ...,
+  api_type = c("Bulk 2.0", "Bulk 1.0"),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    soql

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    queryall

    logical; indicating if the query recordset should include records +

    +

    Arguments

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    queryall
    +

    logical; indicating if the query recordset should include records that have been deleted because of a merge or delete. Setting this argument to TRUE will also return information about archived Task and Event records. -It is available in API versions 29.0 and later.

    guess_types

    logical; indicating whether or not to use col_guess() +It is available in API versions 29.0 and later.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    interval_seconds

    integer; defines the seconds between attempts to check -for job completion.

    max_attempts

    integer; defines then max number attempts to check for job -completion before stopping.

    control

    list; a list of parameters for controlling the behavior of +character.

    +
    interval_seconds
    +

    integer; defines the seconds between attempts to check +for job completion.

    +
    max_attempts
    +

    integer; defines then max number attempts to check for job +completion before stopping.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    other arguments passed on to sf_control or -sf_create_job_bulk to specify the content_type, -concurrency_mode, and/or column_delimiter.

    api_type

    character; one of "REST", "SOAP", +look at the documentation for sf_control.

    +
    ...
    +

    other arguments passed on to sf_control or +sf_create_job_bulk to specify the content_type, +concurrency_mode, and/or column_delimiter.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df of the recordset returned by the query

    -

    References

    - -

    Bulk 1.0 documentation and Bulk 2.0 documentation

    - -

    Examples

    - 
    if (FALSE) {
-# select all Ids from Account object (up to 1000)
-ids <- sf_query_bulk(soql = 'SELECT Id FROM Account LIMIT 1000')
-
-# note that, by default, bulk queries are executed using the Bulk 2.0 API, which 
-# does not required the object name, but the Bulk 1.0 API can be still be invoked 
-# for queries by setting api_type="Bulk 1.0".
-
-# alternatively you can specify as:
-ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
-                api_type = "Bulk 2.0")
+    
    
+    
 
-ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
-                object_name = 'Account', 
-                api_type = "Bulk 1.0")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# select all Ids from Account object (up to 1000)
+ids <- sf_query_bulk(soql = 'SELECT Id FROM Account LIMIT 1000')
+
+# note that, by default, bulk queries are executed using the Bulk 2.0 API, which 
+# does not required the object name, but the Bulk 1.0 API can be still be invoked 
+# for queries by setting api_type="Bulk 1.0".
+
+# alternatively you can specify as:
+ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
+                api_type = "Bulk 2.0")
+
+ids <- sf_query(soql = 'SELECT Id FROM Account LIMIT 1000', 
+                object_name = 'Account', 
+                api_type = "Bulk 1.0")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_run_report.html b/docs/reference/sf_run_report.html index 7d179d2f..e94a214a 100644 --- a/docs/reference/sf_run_report.html +++ b/docs/reference/sf_run_report.html @@ -1,95 +1,22 @@ - - - - - - - -Get a report's data in tabular format — sf_run_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get a report's data in tabular format — sf_run_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Get a report's data in tabular format

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    This function is a convenience wrapper for retrieving the data from a report. By default, it executes an asynchronous report and waits for the detailed data summarized in a tabular format, before pulling them down and returning as a tbl_df.

    - 
    sf_run_report(
-  report_id,
-  report_filters = NULL,
-  report_boolean_logic = NULL,
-  sort_by = character(0),
-  decreasing = FALSE,
-  top_n = NULL,
-  async = TRUE,
-  interval_seconds = 3,
-  max_attempts = 200,
-  wait_for_results = TRUE,
-  guess_types = TRUE,
-  bind_using_character_cols = deprecated(),
-  fact_map_key = "T!T",
-  verbose = FALSE
-)
    +
    + 
    sf_run_report(
+  report_id,
+  report_filters = NULL,
+  report_boolean_logic = NULL,
+  sort_by = character(0),
+  decreasing = FALSE,
+  top_n = NULL,
+  async = TRUE,
+  interval_seconds = 3,
+  max_attempts = 200,
+  wait_for_results = TRUE,
+  guess_types = TRUE,
+  bind_using_character_cols = deprecated(),
+  fact_map_key = "T!T",
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    report_filters

    list; A list of reportFilter specifications. +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    report_filters
    +

    list; A list of reportFilter specifications. Each must be a list with 3 elements: 1) column, 2) operator, and 3) value. You can find out how certain field types can be filtered by -reviewing the results of sf_list_report_filter_operators.

    report_boolean_logic

    character; a string of boolean logic to parse +reviewing the results of sf_list_report_filter_operators.

    +
    report_boolean_logic
    +

    character; a string of boolean logic to parse custom field filters if more than one is specified. For example, if three filters -are specified, then they can be combined using the logic "(1 OR 2) AND 3".

    sort_by

    character; the name of the column(s) used to sort the results.

    decreasing

    logical; a indicator of whether the results should be +are specified, then they can be combined using the logic "(1 OR 2) AND 3".

    +
    sort_by
    +

    character; the name of the column(s) used to sort the results.

    +
    decreasing
    +

    logical; a indicator of whether the results should be ordered by increasing or decreasing values in sort_by column when selecting the top N records. Note, this argument will be ignored if not specifying Top N. You can -sort the records using arrange after the results are returned.

    top_n

    integer; an integer which sets a row limit filter to a report. +sort the records using arrange after the results are returned.

    +
    top_n
    +

    integer; an integer which sets a row limit filter to a report. The results will be ordered as they appear in the report unless specified differently via the sort_by and decreasing arguments. Note, it is sometimes helpful to specify the top_n argument if a report contains many rows, but you are only interested in a subset of them. Alternatively, you can limit the count -of returned rows via the report_filters argument.

    async

    logical; an indicator, by default set to TRUE, which +of returned rows via the report_filters argument.

    +
    async
    +

    logical; an indicator, by default set to TRUE, which executes the report asynchronously. If executed asynchronously, this function will return a list of attributes of the created report instance. The results can be pulled down by providing the report id and instance id to -the function sf_get_report_instance_results. Refer to the details -of the documentation on why executing a report asynchronously is preferred.

    interval_seconds

    integer; defines the seconds between attempts to check -for job completion.

    max_attempts

    integer; defines then max number attempts to check for job -completion before stopping.

    wait_for_results

    logical; indicating whether to wait for the +the function sf_get_report_instance_results. Refer to the details +of the documentation on why executing a report asynchronously is preferred.

    +
    interval_seconds
    +

    integer; defines the seconds between attempts to check +for job completion.

    +
    max_attempts
    +

    integer; defines then max number attempts to check for job +completion before stopping.

    +
    wait_for_results
    +

    logical; indicating whether to wait for the report finish running so that data can be obtained. Otherwise, return the report instance details which can be used to retrieve the results when the -async report has finished.

    guess_types

    logical; indicating whether or not to use col_guess() +async report has finished.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    bind_using_character_cols

    logical; an indicator of whether to -cast the data to all character columns to ensure that bind_rows +like numeric looking values that must be preserved as strings ("48.0").

    +
    bind_using_character_cols
    +

    logical; an indicator of whether to +cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be -character.

    fact_map_key

    character; string providing an index into each +character.

    +
    fact_map_key
    +

    character; string providing an index into each section of a fact map, from which you can access summary and detailed data. The pattern for the fact map keys varies by report format so it is important to know what the reportFormat property of the target report is. See the -note below for more details.

    verbose

    logical; an indicator of whether to print additional +note below for more details.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df

    -

    Details

    - -

    This function is essentially a wrapper around sf_execute_report. -Please review or use that function and/or sf_query_report if you +

    +
    +

    Details

    +

    This function is essentially a wrapper around sf_execute_report. +Please review or use that function and/or sf_query_report if you want to have more control over how the report is run and what format should be returned. In this case we've forced the reportFormat="TABULAR" without total rows and given options to filter, and select the Top N as function arguments rather than forcing the user to create an entire list of reportMetadata.

    -

    Note

    - -

    Below are the fact map key patterns for three report types:

    -
    TABULAR

    T!T: The grand total of a report. Both record data +

    +
    +

    Note

    +

    Below are the fact map key patterns for three report types:

    TABULAR
    +

    T!T: The grand total of a report. Both record data values and the grand total are represented by this key.

    -
    SUMMARY

    <First level row grouping_second level row grouping_third + +

    SUMMARY
    +

    <First level row grouping_second level row grouping_third level row grouping>!T: T refers to the row grand total.

    -
    MATRIX

    <First level row grouping_second level row grouping>!<First + +

    MATRIX
    +

    <First level row grouping_second level row grouping>!<First level column grouping_second level column grouping>.

    -
    -

    Each item in a row or column grouping is numbered starting with 0. Here are +

    Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:

    -
    -
    0!T

    The first item in the first-level grouping.

    -
    1!T

    The second item in the first-level grouping.

    -
    0_0!T

    The first item in the first-level grouping and the first item -in the second-level grouping.

    -
    0_1!T

    The first item in the first-level grouping and the second item -in the second-level grouping.

    - -
    - -

    Salesforce Documentation

    +
    0!T
    +

    The first item in the first-level grouping.

    - - - +
    1!T
    +

    The second item in the first-level grouping.

    -

    See also

    - -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_update_report()

    +
    0_0!T
    +

    The first item in the first-level grouping and the first item +in the second-level grouping.

    -

    Examples

    - 
    if (FALSE) {
-# find a report in your org and run it
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-this_report_id <- all_reports$Id[1]
-results <- sf_run_report(this_report_id)
+
    0_1!T
    
+
    The first item in the first-level grouping and the second item
+in the second-level grouping.
    
 
-# apply your own filters to that same report
-# set up some filters, if needed
-# filter records that was created before this month
-filter1 <- list(column = "CREATED_DATE",
-                operator = "lessThan", 
-                value = "THIS_MONTH")
 
-# filter records where the account billing address city is not empty
-filter2 <-  list(column = "ACCOUNT.ADDRESS1_CITY",
-                 operator = "notEqual", 
-                 value = "")
+
    +
    +

    Salesforce Documentation

    + -# combine filter1 and filter2 using 'AND' so that records must meet both filters -results_using_AND <- sf_run_report(my_report_id, - report_boolean_logic = "1 AND 2", - report_filters = list(filter1, filter2)) +
    + -# combine filter1 and filter2 using 'OR' which means that records must meet one -# of the filters but also throw in a row limit based on a specific sort order -results_using_OR <- sf_run_report(my_report_id, - report_boolean_logic = "1 OR 2", - report_filters = list(filter1, filter2), - sort_by = "Contact.test_number__c", - decreasing = TRUE, - top_n = 5) -} -
    +
    +

    Examples

    + 
    if (FALSE) {
+# find a report in your org and run it
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+this_report_id <- all_reports$Id[1]
+results <- sf_run_report(this_report_id)
+
+# apply your own filters to that same report
+# set up some filters, if needed
+# filter records that was created before this month
+filter1 <- list(column = "CREATED_DATE",
+                operator = "lessThan", 
+                value = "THIS_MONTH")
+
+# filter records where the account billing address city is not empty
+filter2 <-  list(column = "ACCOUNT.ADDRESS1_CITY",
+                 operator = "notEqual", 
+                 value = "")
+
+# combine filter1 and filter2 using 'AND' so that records must meet both filters
+results_using_AND <- sf_run_report(my_report_id, 
+                                   report_boolean_logic = "1 AND 2",
+                                   report_filters = list(filter1, filter2))
+
+# combine filter1 and filter2 using 'OR' which means that records must meet one 
+# of the filters but also throw in a row limit based on a specific sort order
+results_using_OR <- sf_run_report(my_report_id, 
+                                  report_boolean_logic = "1 OR 2",
+                                  report_filters = list(filter1, filter2), 
+                                  sort_by = "Contact.test_number__c", 
+                                  decreasing = TRUE, 
+                                  top_n = 5)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_search.html b/docs/reference/sf_search.html index 44753095..9c69f54b 100644 --- a/docs/reference/sf_search.html +++ b/docs/reference/sf_search.html @@ -1,92 +1,19 @@ - - - - - - - -Perform SOSL Search — sf_search • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Perform SOSL Search — sf_search • salesforcer - - - - - - - - + + -
    -
    -

    Perform SOSL Search

    - Source: R/search.R + Source: R/search.R
    -

    [Stable]

    +

    [Stable]

    Searches for records in your organization’s data.

    - 
    sf_search(
-  search_string,
-  is_sosl = FALSE,
-  guess_types = TRUE,
-  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
-  parameterized_search_options = list(...),
-  verbose = FALSE,
-  ...
-)
    +
    + 
    sf_search(
+  search_string,
+  is_sosl = FALSE,
+  guess_types = TRUE,
+  api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
+  parameterized_search_options = list(...),
+  verbose = FALSE,
+  ...
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    search_string

    character; string to search using parameterized search +

    +

    Arguments

    +
    search_string
    +

    character; string to search using parameterized search or SOSL. Note that is_sosl must be set to TRUE and the string valid in order -to perform a search using SOSL.

    is_sosl

    logical; indicating whether or not to try the string as SOSL

    guess_types

    logical; indicating whether or not to use col_guess() +to perform a search using SOSL.

    +
    is_sosl
    +

    logical; indicating whether or not to try the string as SOSL

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    api_type

    character; one of "REST", "SOAP", +like numeric looking values that must be preserved as strings ("48.0").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    parameterized_search_options

    list; a list of parameters for -controlling the search if not using SOSL. If using SOSL this argument is ignored.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    parameterized_search_options
    +

    list; a list of parameters for +controlling the search if not using SOSL. If using SOSL this argument is ignored.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    ...

    arguments to be used to form the parameterized search options argument -if it is not supplied directly.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    ...
    +

    arguments to be used to form the parameterized search options argument +if it is not supplied directly.

    +
    +
    +

    Value

    tibble

    -

    Note

    - +
    +
    +

    Note

    The maximum number of returned rows in the SOSL query results is 2,000. Please refer to the limits -HERE +HERE for more detail.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl.htm

    - -

    Examples

    - 
    if (FALSE) {
-# free text search
-area_code_search_string <- "(336)"
-search_result <- sf_search(area_code_search_string)
-
-# free text search with parameters
-search_result <- sf_search(area_code_search_string,
-                           fields_scope = "PHONE",
-                           objects = "Lead",
-                           fields = c("id", "phone", "firstname", "lastname"))
+    
    
+    
 
-# using SOSL
-my_sosl_search <- paste("FIND {(336)} in phone fields returning",
-                        "contact(id, phone, firstname, lastname),",
-                        "lead(id, phone, firstname, lastname)")
-sosl_search_result <- sf_search(my_sosl_search, is_sosl=TRUE)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# free text search
+area_code_search_string <- "(336)"
+search_result <- sf_search(area_code_search_string)
+
+# free text search with parameters
+search_result <- sf_search(area_code_search_string,
+                           fields_scope = "PHONE",
+                           objects = "Lead",
+                           fields = c("id", "phone", "firstname", "lastname"))
+
+# using SOSL
+my_sosl_search <- paste("FIND {(336)} in phone fields returning",
+                        "contact(id, phone, firstname, lastname),",
+                        "lead(id, phone, firstname, lastname)")
+sosl_search_result <- sf_search(my_sosl_search, is_sosl=TRUE)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_server_timestamp.html b/docs/reference/sf_server_timestamp.html index 1fd643dd..a91218e5 100644 --- a/docs/reference/sf_server_timestamp.html +++ b/docs/reference/sf_server_timestamp.html @@ -1,92 +1,19 @@ - - - - - - - -Salesforce Server Timestamp — sf_server_timestamp • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Salesforce Server Timestamp — sf_server_timestamp • salesforcer - - - - - - - - + + -
    -
    -

    Salesforce Server Timestamp

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Retrieves the current system timestamp from the API.

    - 
    sf_server_timestamp()
    - - -

    Value

    +
    + 
    sf_server_timestamp()
    +
    +
    +

    Value

    POSIXct formatted timestamp

    +
    -

    Examples

    - 
    if (FALSE) {
-sf_server_timestamp()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_server_timestamp()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_session_id.html b/docs/reference/sf_session_id.html index 9a24e05c..cec7b731 100644 --- a/docs/reference/sf_session_id.html +++ b/docs/reference/sf_session_id.html @@ -1,91 +1,18 @@ - - - - - - - -Return session_id resulting from Basic auth routine — sf_session_id • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Return session_id resulting from Basic auth routine — sf_session_id • salesforcer - - - - - - - - + + -
    -
    -

    Return session_id resulting from Basic auth routine

    - Source: R/auth.R + Source: R/auth.R
    @@ -188,56 +105,51 @@

    Return session_id resulting from Basic auth routine

    Return session_id resulting from Basic auth routine

    - 
    sf_session_id(verbose = TRUE)
    +
    + 
    sf_session_id(verbose = TRUE)
    +
    -

    Arguments

    - - - - - - -
    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    character; a string of the sessionId element of the current authorized API session; otherwise NULL

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_set_password.html b/docs/reference/sf_set_password.html index e0c7f3be..b5726f00 100644 --- a/docs/reference/sf_set_password.html +++ b/docs/reference/sf_set_password.html @@ -1,92 +1,19 @@ - - - - - - - -Set User Password — sf_set_password • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Set User Password — sf_set_password • salesforcer - - - - - - - - + + -
    -
    -

    Set User Password

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Sets the specified user’s password to the specified value.

    - 
    sf_set_password(user_id, password, verbose = FALSE)
    +
    + 
    sf_set_password(user_id, password, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    user_id

    character; the unique Salesforce Id assigned to the User

    password

    character; a new password that you would like to set for the -supplied user that complies to your organizations password requirements

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    user_id
    +

    character; the unique Salesforce Id assigned to the User

    +
    password
    +

    character; a new password that you would like to set for the +supplied user that complies to your organizations password requirements

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list

    +
    -

    Examples

    - 
    if (FALSE) {
-sf_set_password(user_id = "0056A000000ZZZaaBBB", password="password123")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_set_password(user_id = "0056A000000ZZZaaBBB", password="password123")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_submit_query_bulk.html b/docs/reference/sf_submit_query_bulk.html index 9d3a8837..efbde755 100644 --- a/docs/reference/sf_submit_query_bulk.html +++ b/docs/reference/sf_submit_query_bulk.html @@ -1,92 +1,19 @@ - - - - - - - -Submit Bulk Query Batch to a Bulk API Job — sf_submit_query_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Submit Bulk Query Batch to a Bulk API Job — sf_submit_query_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Submit Bulk Query Batch to a Bulk API Job

    - Source: R/bulk-query.R + Source: R/bulk-query.R
    @@ -190,43 +107,35 @@

    Submit Bulk Query Batch to a Bulk API Job

    an already existing Bulk API Job of operation "query"

    - 
    sf_submit_query_bulk(job_id, soql, api_type = c("Bulk 1.0"), verbose = FALSE)
    +
    + 
    sf_submit_query_bulk(job_id, soql, api_type = c("Bulk 1.0"), verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    soql

    character; a string defining a SOQL query -(e.g. "SELECT Id, Name FROM Account").

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    soql
    +

    character; a string defining a SOQL query +(e.g. "SELECT Id, Name FROM Account").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list parameters of the batch

    -

    Note

    - -

    Bulk API query doesn't support the following SOQL:

      -

    • COUNT

      • +
    +
    +

    Note

    +

    Bulk API query doesn't support the following SOQL:

    • COUNT

    • ROLLUP

    • SUM

    • GROUP BY CUBE

      • @@ -234,45 +143,44 @@

      Note

    • Nested SOQL queries

    • Relationship fields

    Additionally, Bulk API can't access or query compound address or compound geolocation fields.

    -

    References

    - -

    Bulk 1.0 documentation

    +
    +
    +

    References

    +

    Bulk 1.0 documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
-job_info <- sf_create_job_bulk(operation = 'query', object = 'Account')
-query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+my_query <- "SELECT Id, Name FROM Account LIMIT 1000"
+job_info <- sf_create_job_bulk(operation = 'query', object = 'Account')
+query_info <- sf_submit_query_bulk(job_id = job_info$id, soql = my_query)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_undelete.html b/docs/reference/sf_undelete.html index b20e868b..d74ee2e4 100644 --- a/docs/reference/sf_undelete.html +++ b/docs/reference/sf_undelete.html @@ -1,92 +1,19 @@ - - - - - - - -Undelete Records — sf_undelete • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Undelete Records — sf_undelete • salesforcer - - - - - - - - + + -
    -
    -

    Undelete Records

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Experimental]

    +

    [Experimental]

    Undeletes records from the Recycle Bin.

    - 
    sf_undelete(
-  ids,
-  api_type = c("SOAP"),
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_undelete(
+  ids,
+  api_type = c("SOAP"),
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    ids

    vector, matrix, data.frame, or +

    +

    Arguments

    +
    ids
    +

    vector, matrix, data.frame, or tbl_df; if not a vector, there must be a column called Id (case-insensitive) -that can be passed in the request

    api_type

    character; one of "REST", "SOAP", +that can be passed in the request

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    -

    Note

    - +
    +
    +

    Note

    Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_undelete.htm

    +
    + -

    Examples

    - 
    if (FALSE) {
-new_contact <- c(FirstName = "Test", LastName = "Contact")
-new_records <- sf_create(new_contact, object_name = "Contact")
-delete <- sf_delete(new_records$id[1],
-                    AllOrNoneHeader = list(allOrNone = TRUE))
-is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'",
-                       new_records$id[1]), 
-                       queryall = TRUE)
-undelete <- sf_undelete(new_records$id[1])
-is_not_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'",
-                           new_records$id[1]))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+new_contact <- c(FirstName = "Test", LastName = "Contact")
+new_records <- sf_create(new_contact, object_name = "Contact")
+delete <- sf_delete(new_records$id[1],
+                    AllOrNoneHeader = list(allOrNone = TRUE))
+is_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'",
+                       new_records$id[1]), 
+                       queryall = TRUE)
+undelete <- sf_undelete(new_records$id[1])
+is_not_deleted <- sf_query(sprintf("SELECT Id, IsDeleted FROM Contact WHERE Id='%s'",
+                           new_records$id[1]))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update.html b/docs/reference/sf_update.html index 55bd123c..42abea21 100644 --- a/docs/reference/sf_update.html +++ b/docs/reference/sf_update.html @@ -1,92 +1,19 @@ - - - - - - - -Update Records — sf_update • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Records — sf_update • salesforcer - - - - - - - - + + -
    -
    -

    Update Records

    - Source: R/update.R + Source: R/update.R
    -

    [Stable]

    +

    [Stable]

    Updates one or more records to your organization’s data.

    - 
    sf_update(
-  input_data,
-  object_name,
-  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
-  guess_types = TRUE,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_update(
+  input_data,
+  object_name,
+  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
+  guess_types = TRUE,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    input_data

    named vector, matrix, data.frame, or +

    +

    Arguments

    +
    input_data
    +

    named vector, matrix, data.frame, or tbl_df; data can be coerced into a data.frame. If performing an update, upsert, or delete operation, then one column or -field must be the Id of the record to modify or delete.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +field must be the Id of the record to modify or delete.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    guess_types

    logical; indicating whether or not to use col_guess() +making the request.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    control

    list; a list of parameters for controlling the behavior of +like numeric looking values that must be preserved as strings ("48.0").

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    -

    Note

    - +
    +
    +

    Note

    Because the SOAP and REST calls chunk data into batches of 200 records the AllOrNoneHeader will only apply to the success or failure of every batch of records and not all records submitted to the function.

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 2
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact", 1:n))
-new_records <- sf_create(new_contacts, "Contact")
-updated_contacts <- tibble(FirstName = rep("TestTest", n),
-                           LastName = paste0("Contact", 1:n),
-                           Id = new_records$id)
-# update and allow fields to be truncated if they are too long
-update <- sf_update(input_data = updated_contacts, object_name = "Contact",
-                    AllowFieldTruncationHeader=list(allowFieldTruncation=TRUE))
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 2
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact", 1:n))
+new_records <- sf_create(new_contacts, "Contact")
+updated_contacts <- tibble(FirstName = rep("TestTest", n),
+                           LastName = paste0("Contact", 1:n),
+                           Id = new_records$id)
+# update and allow fields to be truncated if they are too long
+update <- sf_update(input_data = updated_contacts, object_name = "Contact",
+                    AllowFieldTruncationHeader=list(allowFieldTruncation=TRUE))
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_attachment.html b/docs/reference/sf_update_attachment.html index ed8886f0..9c2dd15b 100644 --- a/docs/reference/sf_update_attachment.html +++ b/docs/reference/sf_update_attachment.html @@ -1,96 +1,23 @@ - - - - - - - -Update Attachments — sf_update_attachment • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Attachments — sf_update_attachment • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Update Attachments

    - Source: R/attachments.R + Source: R/attachments.R
    -

    [Experimental]

    +

    [Experimental]

    This function will allow you to update attachments (and other blob data, such as Documents) by providing the Id of the attachment record and the file paths (absolute or relative) to media that you would like to upload to Salesforce @@ -198,134 +115,120 @@

    Update Attachments

    Body, IsPrivate, and OwnerId).

    - 
    sf_update_attachment(
-  attachment_input_data,
-  object_name = c("Attachment"),
-  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
-  control = list(...),
-  ...,
-  verbose = FALSE
-)
    +
    + 
    sf_update_attachment(
+  attachment_input_data,
+  object_name = c("Attachment"),
+  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
+  control = list(...),
+  ...,
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    attachment_input_data

    named vector, matrix, +

    +

    Arguments

    +
    attachment_input_data
    +

    named vector, matrix, data.frame, or tbl_df; data can be coerced into a data.frame. The input must contain a column entitled 'Body' with an absolute or relative file path (unless creating a Document using a Url) along with other required fields depending on the object.If performing an update operation, then one column or field of the input must be -the Id of the record to modify.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    api_type

    character; one of "REST", "SOAP", +the Id of the record to modify.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    control

    list; a list of parameters for controlling the behavior of +making the request.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df with details of the created records

    -

    Note

    - +
    +
    +

    Note

    The length of any file name can’t exceed 512 bytes (per Bulk 1.0 API). The SOAP API create call restricts these files to a maximum size of 25 MB. For a file attached to a Solution, the limit is 1.5 MB. The maximum email attachment size is 3 MB. You can only create or update documents to a maximum size of 5 MB. The REST API allows you to insert or update blob data limited to 50 MB of text data or 37.5 MB of base64–encoded data.

    -

    Salesforce Documentation

    - +
    +
    +

    Salesforce Documentation

    - - -

    See also

    - -

    Other Attachment functions: -check_and_encode_files(), -sf_create_attachment(), -sf_delete_attachment(), -sf_download_attachment()

    - -

    Examples

    - 
    if (FALSE) {
-# upload a PDF to a particular record as an Attachment
-file_path <- system.file("extdata",
-                         "data-wrangling-cheatsheet.pdf",
-                         package = "salesforcer")
-parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId!
-attachment_details <- tibble(Body = file_path, ParentId = parent_record_id)
-create_result <- sf_create_attachment(attachment_details)
+
    
+    
    
+    
    See also
    
+    
    Other Attachment functions: 
+check_and_encode_files(),
+sf_create_attachment(),
+sf_delete_attachment(),
+sf_download_attachment()
    
+    
    
 
-# download, zip, and re-upload the PDF
-pdf_path <- sf_download_attachment(sf_id = create_result$id[1])
-zipped_path <- paste0(pdf_path, ".zip")
-zip(zipped_path, pdf_path)
-attachment_details <- tibble(Id = create_result$id, Body = zipped_path)
-update_result <- sf_update_attachment(attachment_details)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# upload a PDF to a particular record as an Attachment
+file_path <- system.file("extdata",
+                         "data-wrangling-cheatsheet.pdf",
+                         package = "salesforcer")
+parent_record_id <- "0036A000002C6MmQAK" # replace with your own ParentId!
+attachment_details <- tibble(Body = file_path, ParentId = parent_record_id)
+create_result <- sf_create_attachment(attachment_details)
+
+# download, zip, and re-upload the PDF
+pdf_path <- sf_download_attachment(sf_id = create_result$id[1])
+zipped_path <- paste0(pdf_path, ".zip")
+zip(zipped_path, pdf_path)
+attachment_details <- tibble(Id = create_result$id, Body = zipped_path)
+update_result <- sf_update_attachment(attachment_details)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_attachment_bulk_v1.html b/docs/reference/sf_update_attachment_bulk_v1.html index 9b4df1e2..65033fcf 100644 --- a/docs/reference/sf_update_attachment_bulk_v1.html +++ b/docs/reference/sf_update_attachment_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Update Attachments using Bulk 1.0 API — sf_update_attachment_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Attachments using Bulk 1.0 API — sf_update_attachment_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Update Attachments using Bulk 1.0 API

    - Source: R/attachments.R + Source: R/attachments.R
    @@ -188,48 +105,45 @@

    Update Attachments using Bulk 1.0 API

    Update Attachments using Bulk 1.0 API

    - 
    sf_update_attachment_bulk_v1(
-  attachment_input_data,
-  object_name = c("Attachment"),
-  content_type = "ZIP_CSV",
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_attachment_bulk_v1(
+  attachment_input_data,
+  object_name = c("Attachment"),
+  content_type = "ZIP_CSV",
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_attachment_rest.html b/docs/reference/sf_update_attachment_rest.html index 2354c0cf..de4af23f 100644 --- a/docs/reference/sf_update_attachment_rest.html +++ b/docs/reference/sf_update_attachment_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Update Attachment using REST API — sf_update_attachment_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Attachment using REST API — sf_update_attachment_rest • salesforcer - - - - - - - - + + -
    -
    -

    Update Attachment using REST API

    - Source: R/attachments.R + Source: R/attachments.R
    @@ -188,47 +105,44 @@

    Update Attachment using REST API

    Update Attachment using REST API

    - 
    sf_update_attachment_rest(
-  attachment_input_data,
-  object_name = c("Attachment"),
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_attachment_rest(
+  attachment_input_data,
+  object_name = c("Attachment"),
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_attachment_soap.html b/docs/reference/sf_update_attachment_soap.html index 2bd9ab52..766a6c1a 100644 --- a/docs/reference/sf_update_attachment_soap.html +++ b/docs/reference/sf_update_attachment_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Update Attachment using SOAP API — sf_update_attachment_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Attachment using SOAP API — sf_update_attachment_soap • salesforcer - - - - - - - - + + -
    -
    -

    Update Attachment using SOAP API

    - Source: R/attachments.R + Source: R/attachments.R
    @@ -188,47 +105,44 @@

    Update Attachment using SOAP API

    Update Attachment using SOAP API

    - 
    sf_update_attachment_soap(
-  attachment_input_data,
-  object_name = c("Attachment"),
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_attachment_soap(
+  attachment_input_data,
+  object_name = c("Attachment"),
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_bulk_v1.html b/docs/reference/sf_update_bulk_v1.html index ec78de97..c5449a66 100644 --- a/docs/reference/sf_update_bulk_v1.html +++ b/docs/reference/sf_update_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Update Records using Bulk 1.0 API — sf_update_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Records using Bulk 1.0 API — sf_update_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Update Records using Bulk 1.0 API

    - Source: R/update.R + Source: R/update.R
    @@ -188,48 +105,45 @@

    Update Records using Bulk 1.0 API

    Update Records using Bulk 1.0 API

    - 
    sf_update_bulk_v1(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_bulk_v1(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_bulk_v2.html b/docs/reference/sf_update_bulk_v2.html index 7122da52..af150855 100644 --- a/docs/reference/sf_update_bulk_v2.html +++ b/docs/reference/sf_update_bulk_v2.html @@ -1,91 +1,18 @@ - - - - - - - -Update Records using Bulk 2.0 API — sf_update_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Records using Bulk 2.0 API — sf_update_bulk_v2 • salesforcer - - - - - - - - + + -
    -
    -

    Update Records using Bulk 2.0 API

    - Source: R/update.R + Source: R/update.R
    @@ -188,48 +105,45 @@

    Update Records using Bulk 2.0 API

    Update Records using Bulk 2.0 API

    - 
    sf_update_bulk_v2(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_bulk_v2(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_metadata.html b/docs/reference/sf_update_metadata.html index 0bae0300..3b95e4c5 100644 --- a/docs/reference/sf_update_metadata.html +++ b/docs/reference/sf_update_metadata.html @@ -1,93 +1,20 @@ - - - - - - - -Update Object or Field Metadata in Salesforce — sf_update_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Object or Field Metadata in Salesforce — sf_update_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Update Object or Field Metadata in Salesforce

    - Source: R/update-metadata.R + Source: R/update-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes a list of Metadata components and sends them to Salesforce to update an object that already exists

    - 
    sf_update_metadata(
-  metadata_type,
-  metadata,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_update_metadata(
+  metadata_type,
+  metadata,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    metadata_type

    character; string on what type of metadata to create.

    metadata

    list; metadata components to be created formatted as -XML before being sent via API.

    control

    list; a list of parameters for controlling the behavior of +

    +

    Arguments

    +
    metadata_type
    +

    character; string on what type of metadata to create.

    +
    metadata
    +

    list; metadata components to be created formatted as +XML before being sent via API.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df containing the creation result for each submitted metadata component

    -

    Note

    - +
    +
    +

    Note

    The update key is based on the fullName parameter of the metadata, so updates are triggered when an existing Salesforce element matches the metadata type and fullName.

    -

    See also

    - -

    Salesforce Documentation

    +
    +
    +

    See also

    +

    Salesforce Documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-# create an object that we can update
-base_obj_name <- "Custom_Account1"
-custom_object <- list()
-custom_object$fullName <- paste0(base_obj_name, "__c")
-custom_object$label <- paste0(gsub("_", " ", base_obj_name))
-custom_object$pluralLabel <- paste0(base_obj_name, "s")
-custom_object$nameField <- list(displayFormat = 'AN-{0000}', 
-                                label = paste0(base_obj_name, ' Number'), 
-                                type = 'AutoNumber')
-custom_object$deploymentStatus <- 'Deployed'
-custom_object$sharingModel <- 'ReadWrite'
-custom_object$enableActivities <- 'true'
-custom_object$description <- paste0(base_obj_name, " created by the Metadata API")
-custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject',
-                                           metadata = custom_object)
-# now update the object that was created
-update_metadata <- custom_object 
-update_metadata$fullName <- 'Custom_Account1__c'
-update_metadata$label <- 'New Label Custom_Account1'
-update_metadata$pluralLabel <- 'Custom_Account1s_new'
-updated_custom_object_result <- sf_update_metadata(metadata_type = 'CustomObject',
-                                                   metadata = update_metadata)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# create an object that we can update
+base_obj_name <- "Custom_Account1"
+custom_object <- list()
+custom_object$fullName <- paste0(base_obj_name, "__c")
+custom_object$label <- paste0(gsub("_", " ", base_obj_name))
+custom_object$pluralLabel <- paste0(base_obj_name, "s")
+custom_object$nameField <- list(displayFormat = 'AN-{0000}', 
+                                label = paste0(base_obj_name, ' Number'), 
+                                type = 'AutoNumber')
+custom_object$deploymentStatus <- 'Deployed'
+custom_object$sharingModel <- 'ReadWrite'
+custom_object$enableActivities <- 'true'
+custom_object$description <- paste0(base_obj_name, " created by the Metadata API")
+custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject',
+                                           metadata = custom_object)
+# now update the object that was created
+update_metadata <- custom_object 
+update_metadata$fullName <- 'Custom_Account1__c'
+update_metadata$label <- 'New Label Custom_Account1'
+update_metadata$pluralLabel <- 'Custom_Account1s_new'
+updated_custom_object_result <- sf_update_metadata(metadata_type = 'CustomObject',
+                                                   metadata = update_metadata)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_report.html b/docs/reference/sf_update_report.html index 76896439..58ccb4aa 100644 --- a/docs/reference/sf_update_report.html +++ b/docs/reference/sf_update_report.html @@ -1,94 +1,21 @@ - - - - - - - -Update a report — sf_update_report • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update a report — sf_update_report • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Update a report

    - Source: R/analytics-report.R + Source: R/analytics-report.R
    -

    [Experimental]

    +

    [Experimental]

    Save changes to a report by sending a PATCH request to the Report resource. Note that saving a report deletes any running async report jobs because they might be obsolete based on the updates.

    - 
    sf_update_report(report_id, report_metadata, verbose = FALSE)
    +
    + 
    sf_update_report(report_id, report_metadata, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    report_metadata

    list; a list representing the properties to create +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    report_metadata
    +

    list; a list representing the properties to create the report with. The names of the list must be one or more of the 3 accepted metadata properties: reportMetadata, reportTypeMetadata, -reportExtendedMetadata.

    verbose

    logical; an indicator of whether to print additional +reportExtendedMetadata.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list representing the newly cloned report with up to 4 properties -that describe the report:

    -
    attributes

    Report type along with the URL to retrieve common objects and +that describe the report:

    attributes
    +

    Report type along with the URL to retrieve common objects and joined metadata.

    -
    reportMetadata

    Unique identifiers for groupings and summaries.

    -
    reportTypeMetadata

    Fields in each section of a report type plus filter information for those fields.

    -
    reportExtendedMetadata

    Additional information about summaries and groupings.

    -
    - -

    Salesforce Documentation

    - - +
    reportMetadata
    +

    Unique identifiers for groupings and summaries.

    - +
    reportTypeMetadata
    +

    Fields in each section of a report type plus filter information for those fields.

    -

    See also

    +
    reportExtendedMetadata
    +

    Additional information about summaries and groupings.

    -

    Other Report functions: -sf_copy_report(), -sf_create_report(), -sf_delete_report(), -sf_describe_report_type(), -sf_describe_report(), -sf_execute_report(), -sf_list_report_fields(), -sf_list_report_filter_operators(), -sf_list_report_types(), -sf_list_reports(), -sf_query_report(), -sf_run_report()

    -

    Examples

    - 
    if (FALSE) {
-# first, grab all possible reports in your Org
-all_reports <- sf_query("SELECT Id, Name FROM Report")
-
-# second, get the id of the report to update
-this_report_id <- all_reports$Id[1]
-
-my_updated_report <- sf_update_report(this_report_id,
-                                      report_metadata =
-                                        list(reportMetadata =
-                                          list(name = "Updated Report Name!")))
+
    +
    +

    Salesforce Documentation

    + -# alternatively, pull down its metadata and update the name -report_details <- sf_describe_report(this_report_id) -report_details$reportMetadata$name <- paste0(report_details$reportMetadata$name, - " - UPDATED") +
    + -# fourth, update the report by passing the metadata -my_updated_report <- sf_update_report(this_report_id, - report_metadata = report_details) -} -
    +
    +

    Examples

    + 
    if (FALSE) {
+# first, grab all possible reports in your Org
+all_reports <- sf_query("SELECT Id, Name FROM Report")
+
+# second, get the id of the report to update
+this_report_id <- all_reports$Id[1]
+
+my_updated_report <- sf_update_report(this_report_id,
+                                      report_metadata =
+                                        list(reportMetadata =
+                                          list(name = "Updated Report Name!")))
+
+# alternatively, pull down its metadata and update the name
+report_details <- sf_describe_report(this_report_id)
+report_details$reportMetadata$name <- paste0(report_details$reportMetadata$name,
+                                             " - UPDATED")
+
+# fourth, update the report by passing the metadata
+my_updated_report <- sf_update_report(this_report_id,
+                                      report_metadata = report_details)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_rest.html b/docs/reference/sf_update_rest.html index e73814a8..f1ebdfcf 100644 --- a/docs/reference/sf_update_rest.html +++ b/docs/reference/sf_update_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Update Records using REST API — sf_update_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Records using REST API — sf_update_rest • salesforcer - - - - - - - - + + -
    -
    -

    Update Records using REST API

    - Source: R/update.R + Source: R/update.R
    @@ -188,48 +105,45 @@

    Update Records using REST API

    Update Records using REST API

    - 
    sf_update_rest(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_rest(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_update_soap.html b/docs/reference/sf_update_soap.html index bcfb4dff..fb5a1b4e 100644 --- a/docs/reference/sf_update_soap.html +++ b/docs/reference/sf_update_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Update Records using SOAP API — sf_update_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Update Records using SOAP API — sf_update_soap • salesforcer - - - - - - - - + + -
    -
    -

    Update Records using SOAP API

    - Source: R/update.R + Source: R/update.R
    @@ -188,48 +105,45 @@

    Update Records using SOAP API

    Update Records using SOAP API

    - 
    sf_update_soap(
-  input_data,
-  object_name,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_update_soap(
+  input_data,
+  object_name,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upload_complete_bulk.html b/docs/reference/sf_upload_complete_bulk.html index 7f7ac4e7..225a3b92 100644 --- a/docs/reference/sf_upload_complete_bulk.html +++ b/docs/reference/sf_upload_complete_bulk.html @@ -1,91 +1,18 @@ - - - - - - - -Signal Upload Complete to Bulk API Job — sf_upload_complete_bulk • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Signal Upload Complete to Bulk API Job — sf_upload_complete_bulk • salesforcer - - - - - - - - + + -
    -
    -

    Signal Upload Complete to Bulk API Job

    - Source: R/bulk-operation.R + Source: R/bulk-operation.R
    @@ -188,76 +105,70 @@

    Signal Upload Complete to Bulk API Job

    This function signals that uploads are complete to a Job in the Salesforce Bulk API

    - 
    sf_upload_complete_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
    +
    + 
    sf_upload_complete_bulk(job_id, api_type = c("Bulk 2.0"), verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    job_id

    character; the Salesforce Id assigned to a submitted job as -returned by sf_create_job_bulk. It will start with "750".

    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    job_id
    +

    character; the Salesforce Id assigned to a submitted job as +returned by sf_create_job_bulk. It will start with "750".

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A list of parameters defining the job after signaling a completed upload

    -

    Note

    - -

    This function is typically not used directly. It is used in sf_create_batches_bulk() +

    +
    +

    Note

    +

    This function is typically not used directly. It is used in sf_create_batches_bulk() right after submitting the batches to signal to Salesforce that the batches should no longer be queued.

    -

    References

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

    +
    + -

    Examples

    - 
    if (FALSE) {
-upload_info <- sf_upload_complete_bulk(job_id=job_info$id)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+upload_info <- sf_upload_complete_bulk(job_id=job_info$id)
+}
+
    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upsert.html b/docs/reference/sf_upsert.html index 3fd91af4..d98eb284 100644 --- a/docs/reference/sf_upsert.html +++ b/docs/reference/sf_upsert.html @@ -1,92 +1,19 @@ - - - - - - - -Upsert Records — sf_upsert • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Upsert Records — sf_upsert • salesforcer - - - - - - - - + + -
    -
    -

    Upsert Records

    - Source: R/upsert.R + Source: R/upsert.R
    -

    [Stable]

    +

    [Stable]

    Upserts one or more new records to your organization’s data.

    - 
    sf_upsert(
-  input_data,
-  object_name,
-  external_id_fieldname,
-  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
-  guess_types = TRUE,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_upsert(
+  input_data,
+  object_name,
+  external_id_fieldname,
+  api_type = c("SOAP", "REST", "Bulk 1.0", "Bulk 2.0"),
+  guess_types = TRUE,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    input_data

    named vector, matrix, data.frame, or +

    +

    Arguments

    +
    input_data
    +

    named vector, matrix, data.frame, or tbl_df; data can be coerced into a data.frame. If performing an update, upsert, or delete operation, then one column or -field must be the Id of the record to modify or delete.

    object_name

    character; the name of the Salesforce object that the -function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    external_id_fieldname

    character; string identifying a custom field on the +field must be the Id of the record to modify or delete.

    +
    object_name
    +

    character; the name of the Salesforce object that the +function is operating against (e.g. "Account", "Contact", "CustomObject__c").

    +
    external_id_fieldname
    +

    character; string identifying a custom field on the object that has been set as an "External ID" field. This field is used to reference -objects during upserts to determine if the record already exists in Salesforce or not.

    api_type

    character; one of "REST", "SOAP", +objects during upserts to determine if the record already exists in Salesforce or not.

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    guess_types

    logical; indicating whether or not to use col_guess() +making the request.

    +
    guess_types
    +

    logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, -like numeric looking values that must be preserved as strings ("48.0").

    control

    list; a list of parameters for controlling the behavior of +like numeric looking values that must be preserved as strings ("48.0").

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control or further downstream -to sf_bulk_operation

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control or further downstream +to sf_bulk_operation

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    tbl_df of records with success indicator

    +
    -

    Examples

    - 
    if (FALSE) {
-n <- 2
-new_contacts <- tibble(FirstName = rep("Test", n),
-                       LastName = paste0("Contact-Create-", 1:n),
-                       My_External_Id__c=letters[1:n])
-new_contacts_result <- sf_create(new_contacts, object_name="Contact")
-
-upserted_contacts <- tibble(FirstName = rep("Test", n),
-                            LastName = paste0("Contact-Upsert-", 1:n),
-                            My_External_Id__c=letters[1:n])
-new_record <- tibble(FirstName = "Test",
-                     LastName = paste0("Contact-Upsert-", n+1),
-                     My_External_Id__c=letters[n+1])
-upserted_contacts <- bind_rows(upserted_contacts, new_record)
-
-upserted_contacts_result1 <- sf_upsert(upserted_contacts, 
-                                       object_name="Contact", 
-                                       "My_External_Id__c")
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+n <- 2
+new_contacts <- tibble(FirstName = rep("Test", n),
+                       LastName = paste0("Contact-Create-", 1:n),
+                       My_External_Id__c=letters[1:n])
+new_contacts_result <- sf_create(new_contacts, object_name="Contact")
+
+upserted_contacts <- tibble(FirstName = rep("Test", n),
+                            LastName = paste0("Contact-Upsert-", 1:n),
+                            My_External_Id__c=letters[1:n])
+new_record <- tibble(FirstName = "Test",
+                     LastName = paste0("Contact-Upsert-", n+1),
+                     My_External_Id__c=letters[n+1])
+upserted_contacts <- bind_rows(upserted_contacts, new_record)
+
+upserted_contacts_result1 <- sf_upsert(upserted_contacts, 
+                                       object_name="Contact", 
+                                       "My_External_Id__c")
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upsert_bulk_v1.html b/docs/reference/sf_upsert_bulk_v1.html index 60b73816..67ed5589 100644 --- a/docs/reference/sf_upsert_bulk_v1.html +++ b/docs/reference/sf_upsert_bulk_v1.html @@ -1,91 +1,18 @@ - - - - - - - -Upsert Records using Bulk 1.0 API — sf_upsert_bulk_v1 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Upsert Records using Bulk 1.0 API — sf_upsert_bulk_v1 • salesforcer - - - - - - - - + + -
    -
    -

    Upsert Records using Bulk 1.0 API

    - Source: R/upsert.R + Source: R/upsert.R
    @@ -188,49 +105,46 @@

    Upsert Records using Bulk 1.0 API

    Upsert Records using Bulk 1.0 API

    - 
    sf_upsert_bulk_v1(
-  input_data,
-  object_name,
-  external_id_fieldname,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_upsert_bulk_v1(
+  input_data,
+  object_name,
+  external_id_fieldname,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upsert_bulk_v2.html b/docs/reference/sf_upsert_bulk_v2.html index 88b084b7..55a36c7c 100644 --- a/docs/reference/sf_upsert_bulk_v2.html +++ b/docs/reference/sf_upsert_bulk_v2.html @@ -1,91 +1,18 @@ - - - - - - - -Upsert Records using Bulk 2.0 API — sf_upsert_bulk_v2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Upsert Records using Bulk 2.0 API — sf_upsert_bulk_v2 • salesforcer - - - - - - - - + + -
    -
    -

    Upsert Records using Bulk 2.0 API

    - Source: R/upsert.R + Source: R/upsert.R
    @@ -188,49 +105,46 @@

    Upsert Records using Bulk 2.0 API

    Upsert Records using Bulk 2.0 API

    - 
    sf_upsert_bulk_v2(
-  input_data,
-  object_name,
-  external_id_fieldname,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_upsert_bulk_v2(
+  input_data,
+  object_name,
+  external_id_fieldname,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upsert_metadata.html b/docs/reference/sf_upsert_metadata.html index 8ff51610..ee9a1cd3 100644 --- a/docs/reference/sf_upsert_metadata.html +++ b/docs/reference/sf_upsert_metadata.html @@ -1,93 +1,20 @@ - - - - - - - -Upsert Object or Field Metadata in Salesforce — sf_upsert_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Upsert Object or Field Metadata in Salesforce — sf_upsert_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Upsert Object or Field Metadata in Salesforce

    - Source: R/upsert-metadata.R + Source: R/upsert-metadata.R
    -

    [Experimental]

    +

    [Experimental]

    This function takes a list of Metadata components and sends them to Salesforce for creation or update if the object already exists

    - 
    sf_upsert_metadata(
-  metadata_type,
-  metadata,
-  control = list(...),
-  ...,
-  all_or_none = deprecated(),
-  verbose = FALSE
-)
    +
    + 
    sf_upsert_metadata(
+  metadata_type,
+  metadata,
+  control = list(...),
+  ...,
+  all_or_none = deprecated(),
+  verbose = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    metadata_type

    character; string on what type of metadata to create.

    metadata

    list; metadata components to be created formatted as -XML before being sent via API.

    control

    list; a list of parameters for controlling the behavior of +

    +

    Arguments

    +
    metadata_type
    +

    character; string on what type of metadata to create.

    +
    metadata
    +

    list; metadata components to be created formatted as +XML before being sent via API.

    +
    control
    +

    list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available -look at the documentation for sf_control.

    ...

    arguments passed to sf_control

    all_or_none

    logical; allows a call to roll back all changes unless all -records are processed successfully.

    verbose

    logical; an indicator of whether to print additional +look at the documentation for sf_control.

    +
    ...
    +

    arguments passed to sf_control

    +
    all_or_none
    +

    logical; allows a call to roll back all changes unless all +records are processed successfully.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    A tbl_df containing the creation result for each submitted metadata component

    -

    Note

    - +
    +
    +

    Note

    The upsert key is based on the fullName parameter of the metadata, so updates are triggered when an existing Salesforce element matches the metadata type and fullName.

    -

    See also

    - -

    Salesforce Documentation

    +
    +
    +

    See also

    +

    Salesforce Documentation

    +
    -

    Examples

    - 
    if (FALSE) {
-# create an object that we can confirm the update portion of the upsert
-base_obj_name <- "Custom_Account1"
-custom_object <- list()
-custom_object$fullName <- paste0(base_obj_name, "__c")
-custom_object$label <- paste0(gsub("_", " ", base_obj_name))
-custom_object$pluralLabel <- paste0(base_obj_name, "s")
-custom_object$nameField <- list(displayFormat = 'AN-{0000}', 
-                                label = paste0(base_obj_name, ' Number'), 
-                                type = 'AutoNumber')
-custom_object$deploymentStatus <- 'Deployed'
-custom_object$sharingModel <- 'ReadWrite'
-custom_object$enableActivities <- 'true'
-custom_object$description <- paste0(base_obj_name, " created by the Metadata API")
-custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject',
-                                           metadata = custom_object)
-# now update the object that was created
-upsert_metadata <- list(custom_object, custom_object)
-upsert_metadata[[1]]$fullName <- 'Custom_Account1__c'
-upsert_metadata[[1]]$label <- 'New Label Custom_Account1'
-upsert_metadata[[1]]$pluralLabel <- 'Custom_Account1s_new'
-upsert_metadata[[2]]$fullName <- 'Custom_Account2__c'
-upsert_metadata[[2]]$label <- 'New Label Custom_Account2'
-upsert_metadata[[2]]$pluralLabel <- 'Custom_Account2s_new'
-upserted_custom_object_result <- sf_upsert_metadata(metadata_type = 'CustomObject',
-                                                    metadata = upsert_metadata)
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+# create an object that we can confirm the update portion of the upsert
+base_obj_name <- "Custom_Account1"
+custom_object <- list()
+custom_object$fullName <- paste0(base_obj_name, "__c")
+custom_object$label <- paste0(gsub("_", " ", base_obj_name))
+custom_object$pluralLabel <- paste0(base_obj_name, "s")
+custom_object$nameField <- list(displayFormat = 'AN-{0000}', 
+                                label = paste0(base_obj_name, ' Number'), 
+                                type = 'AutoNumber')
+custom_object$deploymentStatus <- 'Deployed'
+custom_object$sharingModel <- 'ReadWrite'
+custom_object$enableActivities <- 'true'
+custom_object$description <- paste0(base_obj_name, " created by the Metadata API")
+custom_object_result <- sf_create_metadata(metadata_type = 'CustomObject',
+                                           metadata = custom_object)
+# now update the object that was created
+upsert_metadata <- list(custom_object, custom_object)
+upsert_metadata[[1]]$fullName <- 'Custom_Account1__c'
+upsert_metadata[[1]]$label <- 'New Label Custom_Account1'
+upsert_metadata[[1]]$pluralLabel <- 'Custom_Account1s_new'
+upsert_metadata[[2]]$fullName <- 'Custom_Account2__c'
+upsert_metadata[[2]]$label <- 'New Label Custom_Account2'
+upsert_metadata[[2]]$pluralLabel <- 'Custom_Account2s_new'
+upserted_custom_object_result <- sf_upsert_metadata(metadata_type = 'CustomObject',
+                                                    metadata = upsert_metadata)
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upsert_rest.html b/docs/reference/sf_upsert_rest.html index 30356091..5a0766b9 100644 --- a/docs/reference/sf_upsert_rest.html +++ b/docs/reference/sf_upsert_rest.html @@ -1,91 +1,18 @@ - - - - - - - -Upsert Records using REST API — sf_upsert_rest • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Upsert Records using REST API — sf_upsert_rest • salesforcer - - - - - - - - + + -
    -
    -

    Upsert Records using REST API

    - Source: R/upsert.R + Source: R/upsert.R
    @@ -188,49 +105,46 @@

    Upsert Records using REST API

    Upsert Records using REST API

    - 
    sf_upsert_rest(
-  input_data,
-  object_name,
-  external_id_fieldname,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_upsert_rest(
+  input_data,
+  object_name,
+  external_id_fieldname,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_upsert_soap.html b/docs/reference/sf_upsert_soap.html index 6fb24e85..41039e4f 100644 --- a/docs/reference/sf_upsert_soap.html +++ b/docs/reference/sf_upsert_soap.html @@ -1,91 +1,18 @@ - - - - - - - -Upsert Records using SOAP API — sf_upsert_soap • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Upsert Records using SOAP API — sf_upsert_soap • salesforcer - - - - - - - - + + -
    -
    -

    Upsert Records using SOAP API

    - Source: R/upsert.R + Source: R/upsert.R
    @@ -188,49 +105,46 @@

    Upsert Records using SOAP API

    Upsert Records using SOAP API

    - 
    sf_upsert_soap(
-  input_data,
-  object_name,
-  external_id_fieldname,
-  guess_types = TRUE,
-  control,
-  ...,
-  verbose = FALSE
-)
    - - -

    Note

    +
    + 
    sf_upsert_soap(
+  input_data,
+  object_name,
+  external_id_fieldname,
+  guess_types = TRUE,
+  control,
+  ...,
+  verbose = FALSE
+)
    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_user_info.html b/docs/reference/sf_user_info.html index e935cc92..b1b25bf3 100644 --- a/docs/reference/sf_user_info.html +++ b/docs/reference/sf_user_info.html @@ -1,92 +1,19 @@ - - - - - - - -Return Current User Info — sf_user_info • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Return Current User Info — sf_user_info • salesforcer - - - - - - - - + + -
    -
    -

    Return Current User Info

    - Source: R/utils-org.R + Source: R/utils-org.R
    -

    [Stable]

    +

    [Stable]

    Retrieves personal information for the user associated with the current session.

    - 
    sf_user_info(api_type = c("SOAP", "Chatter"), verbose = FALSE)
    +
    + 
    sf_user_info(api_type = c("SOAP", "Chatter"), verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    api_type

    character; one of "REST", "SOAP", +

    +

    Arguments

    +
    api_type
    +

    character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when -making the request.

    verbose

    logical; an indicator of whether to print additional +making the request.

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list

    +
    -

    Examples

    - 
    if (FALSE) {
-sf_user_info()
-}
-
    +
    +

    Examples

    + 
    if (FALSE) {
+sf_user_info()
+}
+
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/sf_write_csv.html b/docs/reference/sf_write_csv.html index 760517f1..31b160be 100644 --- a/docs/reference/sf_write_csv.html +++ b/docs/reference/sf_write_csv.html @@ -1,91 +1,18 @@ - - - - - - - -Write a CSV file in format acceptable to Salesforce APIs — sf_write_csv • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Write a CSV file in format acceptable to Salesforce APIs — sf_write_csv • salesforcer - - - - - - - - + + -
    -
    -

    Write a CSV file in format acceptable to Salesforce APIs

    - Source: R/utils.R + Source: R/utils.R
    @@ -188,41 +105,54 @@

    Write a CSV file in format acceptable to Salesforce APIs

    Write a CSV file in format acceptable to Salesforce APIs

    - 
    sf_write_csv(x, file, path = deprecated())
    - - -

    Note

    +
    + 
    sf_write_csv(x, file, path = deprecated())
    +
    +
    +

    Arguments

    +
    x
    +

    tbl_df; a data frame object to save as a CSV

    +
    file
    +

    A file or connection to write to.

    +
    path
    +

    [Deprecated] +use the file argument instead.

    +
    +
    +

    Value

    +

    the input x invisibly. This function is called for its +side-effect of creating a CSV file at the specified location using the format +required by Salesforce.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/simplify_report_metadata.html b/docs/reference/simplify_report_metadata.html index 15d06e59..ba214f4d 100644 --- a/docs/reference/simplify_report_metadata.html +++ b/docs/reference/simplify_report_metadata.html @@ -1,95 +1,22 @@ - - - - - - - -Simplify the reportMetadata property of a report — simplify_report_metadata • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Simplify the reportMetadata property of a report — simplify_report_metadata • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Simplify the reportMetadata property of a report

    - Source: R/utils-report.R + Source: R/utils-report.R
    @@ -196,61 +113,54 @@

    Simplify the reportMetadata property of a report

    with no filters, grand totals, or subtotals.

    - 
    simplify_report_metadata(report_id, verbose = FALSE)
    +
    + 
    simplify_report_metadata(report_id, verbose = FALSE)
    +
    -

    Arguments

    - - - - - - - - - - -
    report_id

    character; the Salesforce Id assigned to a created -analytics report. It will start with "00O".

    verbose

    logical; an indicator of whether to print additional +

    +

    Arguments

    +
    report_id
    +

    character; the Salesforce Id assigned to a created +analytics report. It will start with "00O".

    +
    verbose
    +

    logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, -along with additional diagnostic information where available.

    - -

    Value

    - +along with additional diagnostic information where available.

    +
    +
    +

    Value

    list; a list representing the reportMetadata property of the report id provided, but with adjustments made.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/stop_w_errors_listed.html b/docs/reference/stop_w_errors_listed.html index 50666cef..2f202c4a 100644 --- a/docs/reference/stop_w_errors_listed.html +++ b/docs/reference/stop_w_errors_listed.html @@ -1,91 +1,18 @@ - - - - - - - -List a vector of errors and stop execution — stop_w_errors_listed • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List a vector of errors and stop execution — stop_w_errors_listed • salesforcer - - - - - - - - + + -
    -
    -

    List a vector of errors and stop execution

    - Source: R/utils-input-validation.R + Source: R/utils-input-validation.R
    @@ -188,59 +105,52 @@

    List a vector of errors and stop execution

    List a vector of errors and stop execution

    - 
    stop_w_errors_listed(main_text = NULL, errors = NULL)
    +
    + 
    stop_w_errors_listed(main_text = NULL, errors = NULL)
    +
    -

    Arguments

    - - - - - - - - - - -
    main_text

    character; The text used to introduce the list of +

    +

    Arguments

    +
    main_text
    +

    character; The text used to introduce the list of errors, typically ending with a colon. For example: "Please fix the -following issue(s) before proceeding:".

    errors

    errors; a vector of errors that will be formatted into -a bulleted list for the user to review with each error listed on a new line.

    - -

    Value

    - +following issue(s) before proceeding:"    .

    +
    errors
    +

    errors; a vector of errors that will be formatted into +a bulleted list for the user to review with each error listed on a new line.

    +
    +
    +

    Value

    simpleError

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/token_available.html b/docs/reference/token_available.html index bcfcb216..6c5dc412 100644 --- a/docs/reference/token_available.html +++ b/docs/reference/token_available.html @@ -1,92 +1,19 @@ - - - - - - - -Check token availability — token_available • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Check token availability — token_available • salesforcer - - - - - - - - + + -
    -
    -

    Check token availability

    - Source: R/auth.R + Source: R/auth.R
    -

    Check if a token is available in salesforcer's internal +

    Check if a token is available in salesforcer's internal .state environment.

    - 
    token_available(verbose = FALSE)
    - - -

    Value

    - -

    logical

    -

    Note

    +
    + 
    token_available(verbose = FALSE)
    +
    +
    +

    Value

    +

    logical

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/unbox_list_elements.html b/docs/reference/unbox_list_elements.html index 458a8e89..9571c628 100644 --- a/docs/reference/unbox_list_elements.html +++ b/docs/reference/unbox_list_elements.html @@ -1,95 +1,22 @@ - - - - - - - -Unlist all list elements of length 1 if they are not a list — unbox_list_elements • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Unlist all list elements of length 1 if they are not a list — unbox_list_elements • salesforcer - - - - - - - - + + -
    -
    -

    Unlist all list elements of length 1 if they are not a list

    - Source: R/utils-query.R + Source: R/utils-query.R
    -

    This function wraps a simple modify_if function -to "unbox" list elements. This is helpful when the as_list +

    This function wraps a simple modify_if function +to "unbox" list elements. This is helpful when the as_list returns elements of XML and the element value is kept as a list of length 1, even though it could be a single primitive data type (e.g. logical, character, etc.).

    - 
    unbox_list_elements(x)
    - -

    Arguments

    - - - - - - -
    x

    list; a list to be cleaned.

    - -

    Value

    +
    + 
    unbox_list_elements(x)
    +
    +
    +

    Arguments

    +
    x
    +

    list; a list to be cleaned.

    +
    +
    +

    Value

    list containing NA in place of NULL element values.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/unbox_list_elements_recursively.html b/docs/reference/unbox_list_elements_recursively.html index 9b1ec894..f136934c 100644 --- a/docs/reference/unbox_list_elements_recursively.html +++ b/docs/reference/unbox_list_elements_recursively.html @@ -1,95 +1,22 @@ - - - - - - - -Recursively unlist all list elements of length 1 if they are not a list — unbox_list_elements_recursively • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Recursively unlist all list elements of length 1 if they are not a list — unbox_list_elements_recursively • salesforcer - - - - - - - - + + -
    -
    -

    Recursively unlist all list elements of length 1 if they are not a list

    - Source: R/utils-query.R + Source: R/utils-query.R
    -

    This function wraps a simple modify_if function +

    This function wraps a simple modify_if function to recursively "unbox" list elements. This is helpful when the -as_list returns elements of XML and the element value is +as_list returns elements of XML and the element value is kept as a list of length 1, even though it could be a single primitive data type (e.g. logical, character, etc.).

    - 
    unbox_list_elements_recursively(x)
    - -

    Arguments

    - - - - - - -
    x

    list; a list to be cleaned.

    - -

    Value

    +
    + 
    unbox_list_elements_recursively(x)
    +
    +
    +

    Arguments

    +
    x
    +

    list; a list to be cleaned.

    +
    +
    +

    Value

    list containing "unboxed" list elements.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/unnest_col.html b/docs/reference/unnest_col.html index c5e62c1d..78be1d4f 100644 --- a/docs/reference/unnest_col.html +++ b/docs/reference/unnest_col.html @@ -1,92 +1,19 @@ - - - - - - - -Flatten list column — unnest_col • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Flatten list column — unnest_col • salesforcer - - - - - - - - + + -
    -
    -

    Flatten list column

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -190,57 +107,50 @@

    Flatten list column

    The column is unnested wide while preserving the row count.

    - 
    unnest_col(df, col)
    - -

    Arguments

    - - - - - - - - - - -
    df

    tbl_df; a data frame with list column to be extracted into -multiple individual columns.

    col

    character; the name of the column to unnest

    - -

    Value

    +
    + 
    unnest_col(df, col)
    +
    +
    +

    Arguments

    +
    df
    +

    tbl_df; a data frame with list column to be extracted into +multiple individual columns.

    +
    col
    +

    character; the name of the column to unnest

    +
    +
    +

    Value

    tbl_df parsed from the flattened list.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/valid_metadata_list.html b/docs/reference/valid_metadata_list.html index bcdab964..d6af07f7 100644 --- a/docs/reference/valid_metadata_list.html +++ b/docs/reference/valid_metadata_list.html @@ -1,91 +1,18 @@ - - - - - - - -List of Valid Data Types — valid_metadata_list • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List of Valid Data Types — valid_metadata_list • salesforcer - - - - - - - - + + -
    -
    -

    List of Valid Data Types

    - Source: R/utils-metadata.R + Source: R/utils-metadata.R
    @@ -188,41 +105,38 @@

    List of Valid Data Types

    A list of data types that are valid for the Metadata API service.

    - 
    valid_metadata_list()
    - - -

    Value

    +
    + 
    valid_metadata_list()
    +
    +
    +

    Value

    codelist; contains name and valid inputs for data types

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/validate_get_all_jobs_params.html b/docs/reference/validate_get_all_jobs_params.html index 82ef2f93..d57b77f3 100644 --- a/docs/reference/validate_get_all_jobs_params.html +++ b/docs/reference/validate_get_all_jobs_params.html @@ -1,91 +1,18 @@ - - - - - - - -Validate Query Parameters When Getting List of All Bulk Jobs — validate_get_all_jobs_params • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Validate Query Parameters When Getting List of All Bulk Jobs — validate_get_all_jobs_params • salesforcer - - - - - - - - + + -
    -
    -

    Validate Query Parameters When Getting List of All Bulk Jobs

    - Source: R/endpoints-bulk.R + Source: R/endpoints-bulk.R
    @@ -188,44 +105,56 @@

    Validate Query Parameters When Getting List of All Bulk Jobs

    Validate Query Parameters When Getting List of All Bulk Jobs

    - 
    validate_get_all_jobs_params(parameterized_search_list, type = "all")
    - - -

    Note

    +
    + 
    validate_get_all_jobs_params(parameterized_search_list, type = "all")
    +
    +
    +

    Arguments

    +
    parameterized_search_list
    +

    list; a list of search options to +locate Bulk API jobs.

    +
    type
    +

    character; a string indicating which type of jobs to +include in the result.

    +
    +
    +

    Value

    +

    character; a complete URL (as a string) to send a request +to in order to retrieve queried jobs.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    -

    See also

    - -

    https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/query_get_all_jobs.htm

    +
    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/warn_w_errors_listed.html b/docs/reference/warn_w_errors_listed.html index 9dca9a7e..89a2bd6f 100644 --- a/docs/reference/warn_w_errors_listed.html +++ b/docs/reference/warn_w_errors_listed.html @@ -1,91 +1,18 @@ - - - - - - - -List a vector of errors and provide a warning — warn_w_errors_listed • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List a vector of errors and provide a warning — warn_w_errors_listed • salesforcer - - - - - - - - + + -
    -
    -

    List a vector of errors and provide a warning

    - Source: R/utils-input-validation.R + Source: R/utils-input-validation.R
    @@ -188,59 +105,52 @@

    List a vector of errors and provide a warning

    List a vector of errors and provide a warning

    - 
    warn_w_errors_listed(main_text = NULL, errors = NULL)
    +
    + 
    warn_w_errors_listed(main_text = NULL, errors = NULL)
    +
    -

    Arguments

    - - - - - - - - - - -
    main_text

    character; The text used to introduce the list of +

    +

    Arguments

    +
    main_text
    +

    character; The text used to introduce the list of errors, typically ending with a colon. For example: "Consider fixing the -following issue(s):".

    errors

    errors; a vector of errors that will be formatted into -a bulleted list for the user to review with each error listed on a new line.

    - -

    Value

    - +following issue(s):"    .

    +
    errors
    +

    errors; a vector of errors that will be formatted into +a bulleted list for the user to review with each error listed on a new line.

    +
    +
    +

    Value

    simpleError

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    + -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/xmlToList2.html b/docs/reference/xmlToList2.html index e4b74d6c..88f61ed0 100644 --- a/docs/reference/xmlToList2.html +++ b/docs/reference/xmlToList2.html @@ -1,93 +1,20 @@ - - - - - - - -xmlToList2 — xmlToList2 • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -xmlToList2 — xmlToList2 • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    xmlToList2

    - Source: R/utils-xml.R + Source: R/utils-xml.R
    @@ -192,52 +109,47 @@

    xmlToList2

    It differs from xmlToList by not including attributes at all in the output.

    - 
    xmlToList2(node)
    - -

    Arguments

    - - - - - - -
    node

    the XML node or document to be converted to an R list

    - -

    Value

    +
    + 
    xmlToList2(node)
    +
    +
    +

    Arguments

    +
    node
    +

    the XML node or document to be converted to an R list

    +
    +
    +

    Value

    list parsed from the supplied node

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/xml_drop_and_unlist.html b/docs/reference/xml_drop_and_unlist.html index 0d355b95..76a39d93 100644 --- a/docs/reference/xml_drop_and_unlist.html +++ b/docs/reference/xml_drop_and_unlist.html @@ -1,95 +1,22 @@ - - - - - - - -Drop type and Id attributes on XML queried records and unlist — xml_drop_and_unlist • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Drop type and Id attributes on XML queried records and unlist — xml_drop_and_unlist • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Drop type and Id attributes on XML queried records and unlist

    - Source: R/utils-query.R + Source: R/utils-query.R

    This function will detect if there are metadata fields returned by the SOAP -API XML from sf_query and remove them as well as unlisting (not recursively) +API XML from sf_query and remove them as well as unlisting (not recursively) to unnest the record's values. Only tested on two-level child-to-parent relationships. For example, for every Contact (child) record return attributes from the Account (parent) as well (SOQL = "SELECT Name, Account.Name FROM Contact")

    - 
    xml_drop_and_unlist(x)
    - -

    Arguments

    - - - - - - -
    x

    list; a list of xml content parsed into a list by xml2

    - -

    Note

    +
    + 
    xml_drop_and_unlist(x)
    +
    +
    +

    Arguments

    +
    x
    +

    list; a list of XML content parsed into a list by xml2

    +
    +
    +

    Value

    +

    character; a named vector of strings from the parsed XML. Nested +elements have their hierarchy represented by a period between the element names +at each level.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/xml_drop_and_unlist_recursively.html b/docs/reference/xml_drop_and_unlist_recursively.html index 017d248e..d162768e 100644 --- a/docs/reference/xml_drop_and_unlist_recursively.html +++ b/docs/reference/xml_drop_and_unlist_recursively.html @@ -1,93 +1,20 @@ - - - - - - - -Recursively Drop type and Id attributes and flatten a list — xml_drop_and_unlist_recursively • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Recursively Drop type and Id attributes and flatten a list — xml_drop_and_unlist_recursively • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Recursively Drop type and Id attributes and flatten a list

    - Source: R/utils-query.R + Source: R/utils-query.R
    -

    This function wraps the xml_drop_and_unlist function +

    This function wraps the xml_drop_and_unlist function to recursively flatten and remove record type attributes from relationship and nested queries.

    - 
    xml_drop_and_unlist_recursively(x)
    - -

    Arguments

    - - - - - - -
    x

    list; a list to be cleaned.

    - -

    Value

    +
    + 
    xml_drop_and_unlist_recursively(x)
    +
    +
    +

    Arguments

    +
    x
    +

    list; a list to be cleaned.

    +
    +
    +

    Value

    list containing without type and Id fields that are not requested as part of the query, but Salesforce provides.

    -

    Note

    - +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/xml_extract_parent_and_child_result.html b/docs/reference/xml_extract_parent_and_child_result.html index fe524e79..e3aad4f7 100644 --- a/docs/reference/xml_extract_parent_and_child_result.html +++ b/docs/reference/xml_extract_parent_and_child_result.html @@ -1,95 +1,22 @@ - - - - - - - -Extract tibble of a parent-child record from one XML node — xml_extract_parent_and_child_result • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Extract tibble of a parent-child record from one XML node — xml_extract_parent_and_child_result • salesforcer - - - - - - - - - - - - - - - - - - + + -
    -
    -

    Extract tibble of a parent-child record from one XML node

    - Source: R/utils-query.R + Source: R/utils-query.R
    @@ -196,50 +113,48 @@

    Extract tibble of a parent-child record from one XML node

    that parent record.

    - 
    xml_extract_parent_and_child_result(x)
    - -

    Arguments

    - - - - - - -
    x

    xml_node; a xml_node from an xml2 parsed response -representing one individual parent query record.

    - -

    Note

    +
    + 
    xml_extract_parent_and_child_result(x)
    +
    +
    +

    Arguments

    +
    x
    +

    xml_node; a xml_node from an xml2 parsed response +representing one individual parent query record.

    +
    +
    +

    Value

    +

    tbl_df of the query result for that parent record.

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/reference/xml_nodeset_to_df.html b/docs/reference/xml_nodeset_to_df.html index 38d3ada6..1a7f0bcb 100644 --- a/docs/reference/xml_nodeset_to_df.html +++ b/docs/reference/xml_nodeset_to_df.html @@ -1,91 +1,18 @@ - - - - - - - -xml_nodeset_to_df — xml_nodeset_to_df • salesforcer - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -xml_nodeset_to_df — xml_nodeset_to_df • salesforcer - - - - - - - - + + -
    -
    -

    xml_nodeset_to_df

    - Source: R/utils-xml.R + Source: R/utils-xml.R
    @@ -188,52 +105,47 @@

    xml_nodeset_to_df

    A function specifically for parsing an XML node into a data.frame

    - 
    xml_nodeset_to_df(this_node)
    - -

    Arguments

    - - - - - - -
    this_node

    xml_node; to be parsed out

    - -

    Value

    - -

    data.frame parsed from the supplied xml

    -

    Note

    +
    + 
    xml_nodeset_to_df(this_node)
    +
    +
    +

    Arguments

    +
    this_node
    +

    xml_node; to be parsed out

    +
    +
    +

    Value

    +

    tbl_df parsed from the supplied XML

    +
    +
    +

    Note

    This function is meant to be used internally. Only use when debugging.

    +
    +
    -
    -
    -

    Developed by Steven M. Mortimer.

    +
    +

    Developed by Steven M. Mortimer.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - - - - - - - + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 97c7f31f..99810d85 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,8 +1,62 @@ + + https://stevenmmortimer.github.io/salesforcer/404.html + + + https://stevenmmortimer.github.io/salesforcer/CODE_OF_CONDUCT.html + + + https://stevenmmortimer.github.io/salesforcer/CONTRIBUTING.html + + + https://stevenmmortimer.github.io/salesforcer/LICENSE-text.html + + + https://stevenmmortimer.github.io/salesforcer/LICENSE.html + + + https://stevenmmortimer.github.io/salesforcer/SECURITY.html + + + https://stevenmmortimer.github.io/salesforcer/SUPPORT.html + + + https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html + + + https://stevenmmortimer.github.io/salesforcer/articles/index.html + + + https://stevenmmortimer.github.io/salesforcer/articles/passing-control-args.html + + + https://stevenmmortimer.github.io/salesforcer/articles/supported-queries.html + + + https://stevenmmortimer.github.io/salesforcer/articles/transitioning-from-RForcecom.html + + + https://stevenmmortimer.github.io/salesforcer/articles/working-with-attachments.html + + + https://stevenmmortimer.github.io/salesforcer/articles/working-with-bulk-apis.html + + + https://stevenmmortimer.github.io/salesforcer/articles/working-with-metadata.html + + + https://stevenmmortimer.github.io/salesforcer/articles/working-with-reports.html + + + https://stevenmmortimer.github.io/salesforcer/authors.html + https://stevenmmortimer.github.io/salesforcer/index.html + + https://stevenmmortimer.github.io/salesforcer/news/index.html + https://stevenmmortimer.github.io/salesforcer/reference/VERB_n.html @@ -87,6 +141,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/guess_object_name_from_soql.html + + https://stevenmmortimer.github.io/salesforcer/reference/index.html + https://stevenmmortimer.github.io/salesforcer/reference/is_legit_token.html @@ -570,6 +627,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_format_time.data.frame.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_format_time.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_format_time.list.html @@ -858,28 +918,4 @@ https://stevenmmortimer.github.io/salesforcer/reference/xml_nodeset_to_df.html - - https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html - - - https://stevenmmortimer.github.io/salesforcer/articles/passing-control-args.html - - - https://stevenmmortimer.github.io/salesforcer/articles/supported-queries.html - - - https://stevenmmortimer.github.io/salesforcer/articles/transitioning-from-RForcecom.html - - - https://stevenmmortimer.github.io/salesforcer/articles/working-with-attachments.html - - - https://stevenmmortimer.github.io/salesforcer/articles/working-with-bulk-apis.html - - - https://stevenmmortimer.github.io/salesforcer/articles/working-with-metadata.html - - - https://stevenmmortimer.github.io/salesforcer/articles/working-with-reports.html - diff --git a/man/sf_dashboard_copy.Rd b/man/sf_copy_dashboard.Rd similarity index 85% rename from man/sf_dashboard_copy.Rd rename to man/sf_copy_dashboard.Rd index cefd7c68..6abfc54a 100644 --- a/man/sf_dashboard_copy.Rd +++ b/man/sf_copy_dashboard.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_copy} -\alias{sf_dashboard_copy} +\name{sf_copy_dashboard} +\alias{sf_copy_dashboard} \title{Copy a dashboard} \usage{ -sf_dashboard_copy(dashboard_id, report_folder_id) +sf_copy_dashboard(dashboard_id, report_folder_id) } \arguments{ \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created diff --git a/man/sf_dashboard_delete.Rd b/man/sf_delete_dashboard.Rd similarity index 84% rename from man/sf_dashboard_delete.Rd rename to man/sf_delete_dashboard.Rd index f496e2be..a274b13b 100644 --- a/man/sf_dashboard_delete.Rd +++ b/man/sf_delete_dashboard.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_delete} -\alias{sf_dashboard_delete} +\name{sf_delete_dashboard} +\alias{sf_delete_dashboard} \title{Delete a dashboard} \usage{ -sf_dashboard_delete(dashboard_id) +sf_delete_dashboard(dashboard_id) } \arguments{ \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created diff --git a/man/sf_dashboard_describe.Rd b/man/sf_describe_dashboard.Rd similarity index 92% rename from man/sf_dashboard_describe.Rd rename to man/sf_describe_dashboard.Rd index 9abe8dd4..bdce2549 100644 --- a/man/sf_dashboard_describe.Rd +++ b/man/sf_describe_dashboard.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_describe} -\alias{sf_dashboard_describe} +\name{sf_describe_dashboard} +\alias{sf_describe_dashboard} \title{Describe a dashboard} \usage{ -sf_dashboard_describe(dashboard_id, as_tbl = TRUE, verbose = FALSE) +sf_describe_dashboard(dashboard_id, as_tbl = TRUE, verbose = FALSE) } \arguments{ \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created diff --git a/man/sf_dashboard_components_describe.Rd b/man/sf_describe_dashboard_components.Rd similarity index 80% rename from man/sf_dashboard_components_describe.Rd rename to man/sf_describe_dashboard_components.Rd index a22dc9f2..0a3c3442 100644 --- a/man/sf_dashboard_components_describe.Rd +++ b/man/sf_describe_dashboard_components.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_components_describe} -\alias{sf_dashboard_components_describe} +\name{sf_describe_dashboard_components} +\alias{sf_describe_dashboard_components} \title{Describe dashboard components} \usage{ -sf_dashboard_components_describe(dashboard_id, component_ids = c(character(0))) +sf_describe_dashboard_components(dashboard_id, component_ids = c(character(0))) } \arguments{ \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created diff --git a/man/sf_dashboard_filter_operators_list.Rd b/man/sf_filter_dashboard_operators_list.Rd similarity index 74% rename from man/sf_dashboard_filter_operators_list.Rd rename to man/sf_filter_dashboard_operators_list.Rd index d77455e3..b0368003 100644 --- a/man/sf_dashboard_filter_operators_list.Rd +++ b/man/sf_filter_dashboard_operators_list.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_filter_operators_list} -\alias{sf_dashboard_filter_operators_list} +\name{sf_filter_dashboard_operators_list} +\alias{sf_filter_dashboard_operators_list} \title{List dashboard filter operators} \usage{ -sf_dashboard_filter_operators_list() +sf_filter_dashboard_operators_list() } \value{ \code{list} diff --git a/man/sf_dashboard_filter_options_analysis.Rd b/man/sf_filter_dashboard_options_analysis.Rd similarity index 87% rename from man/sf_dashboard_filter_options_analysis.Rd rename to man/sf_filter_dashboard_options_analysis.Rd index 56d97acf..62bad3ed 100644 --- a/man/sf_dashboard_filter_options_analysis.Rd +++ b/man/sf_filter_dashboard_options_analysis.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_filter_options_analysis} -\alias{sf_dashboard_filter_options_analysis} +\name{sf_filter_dashboard_options_analysis} +\alias{sf_filter_dashboard_options_analysis} \title{Get an analysis of the filter options for a dashboard} \usage{ -sf_dashboard_filter_options_analysis( +sf_filter_dashboard_options_analysis( dashboard_id, filter_columns = list(), options = list() diff --git a/man/sf_dashboard_results.Rd b/man/sf_get_dashboard_results.Rd similarity index 94% rename from man/sf_dashboard_results.Rd rename to man/sf_get_dashboard_results.Rd index 966eda55..d606ecf1 100644 --- a/man/sf_dashboard_results.Rd +++ b/man/sf_get_dashboard_results.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_results} -\alias{sf_dashboard_results} +\name{sf_get_dashboard_results} +\alias{sf_get_dashboard_results} \title{Get the results of an existing dashboard} \usage{ -sf_dashboard_results( +sf_get_dashboard_results( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) diff --git a/man/sf_dashboard_status.Rd b/man/sf_get_dashboard_status.Rd similarity index 93% rename from man/sf_dashboard_status.Rd rename to man/sf_get_dashboard_status.Rd index 49463da4..bb601eff 100644 --- a/man/sf_dashboard_status.Rd +++ b/man/sf_get_dashboard_status.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_status} -\alias{sf_dashboard_status} +\name{sf_get_dashboard_status} +\alias{sf_get_dashboard_status} \title{Get the status of a dashboard} \usage{ -sf_dashboard_status( +sf_get_dashboard_status( dashboard_id, running_user = NULL, dashboard_filters = c(character(0)) diff --git a/man/sf_dashboards_list.Rd b/man/sf_list_dashboards.Rd similarity index 92% rename from man/sf_dashboards_list.Rd rename to man/sf_list_dashboards.Rd index 17bf3ede..c61b4997 100644 --- a/man/sf_dashboards_list.Rd +++ b/man/sf_list_dashboards.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboards_list} -\alias{sf_dashboards_list} +\name{sf_list_dashboards} +\alias{sf_list_dashboards} \title{List dashboards} \usage{ -sf_dashboards_list(as_tbl = TRUE, verbose = FALSE) +sf_list_dashboards(as_tbl = TRUE, verbose = FALSE) } \arguments{ \item{as_tbl}{\code{logical}; an indicator of whether to convert the parsed diff --git a/man/sf_dashboard_refresh.Rd b/man/sf_refresh_dashboard.Rd similarity index 87% rename from man/sf_dashboard_refresh.Rd rename to man/sf_refresh_dashboard.Rd index 82d96b1d..2a412c66 100644 --- a/man/sf_dashboard_refresh.Rd +++ b/man/sf_refresh_dashboard.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_refresh} -\alias{sf_dashboard_refresh} +\name{sf_refresh_dashboard} +\alias{sf_refresh_dashboard} \title{Refresh an existing dashboard} \usage{ -sf_dashboard_refresh(dashboard_id, dashboard_filters = c(character(0))) +sf_refresh_dashboard(dashboard_id, dashboard_filters = c(character(0))) } \arguments{ \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created diff --git a/man/sf_dashboard_set_sticky_filter.Rd b/man/sf_set_dashboard_sticky_filter.Rd similarity index 93% rename from man/sf_dashboard_set_sticky_filter.Rd rename to man/sf_set_dashboard_sticky_filter.Rd index 9d1a164b..7378b323 100644 --- a/man/sf_dashboard_set_sticky_filter.Rd +++ b/man/sf_set_dashboard_sticky_filter.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_set_sticky_filter} -\alias{sf_dashboard_set_sticky_filter} +\name{sf_set_dashboard_sticky_filter} +\alias{sf_set_dashboard_sticky_filter} \title{Set a sticky dashboard filter} \usage{ -sf_dashboard_set_sticky_filter( +sf_set_dashboard_sticky_filter( dashboard_id, dashboard_filters = c(character(0)) ) diff --git a/man/sf_dashboard_update.Rd b/man/sf_update_dashboard.Rd similarity index 89% rename from man/sf_dashboard_update.Rd rename to man/sf_update_dashboard.Rd index d9127908..1ff7a26e 100644 --- a/man/sf_dashboard_update.Rd +++ b/man/sf_update_dashboard.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/analytics-dashboard.R -\name{sf_dashboard_update} -\alias{sf_dashboard_update} +\name{sf_update_dashboard} +\alias{sf_update_dashboard} \title{Update a dashboard} \usage{ -sf_dashboard_update(dashboard_id, body) +sf_update_dashboard(dashboard_id, body) } \arguments{ \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created diff --git a/vignettes/getting-started.Rmd b/vignettes/getting-started.Rmd index 8e1ad58d..5875b5a3 100644 --- a/vignettes/getting-started.Rmd +++ b/vignettes/getting-started.Rmd @@ -26,27 +26,30 @@ options(tibble.print_min = 5L, tibble.print_max = 5L) ## Authentication -First, load the {salesforcer} package and login. There are two ways to +First, load the {salesforcer} package and log in. There are two ways to authenticate: 1. OAuth 2.0 -2. Basic Username-Password +2. ~~Basic Username-Password~~ -It is recommended to use OAuth 2.0 so that passwords do not have to be +**NOTE**: Beginning February 1st, 2022, Salesforce will be requiring customers +to enable multi-factor authentication, which means that basic authentication +using password and security token will no longer work. The function `sf_auth()` +will return the error message: + +```sh +INVALID_LOGIN: Invalid username, password, security token; or user locked out. +``` + +Also, it is a best practice to use OAuth 2.0 so that passwords do not have to be shared/embedded within scripts. User credentials will be stored in locally cached file entitled `.httr-oauth-salesforcer` in the current working directory. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/passing-control-args.Rmd b/vignettes/passing-control-args.Rmd index c54b3772..076d756e 100644 --- a/vignettes/passing-control-args.Rmd +++ b/vignettes/passing-control-args.Rmd @@ -38,15 +38,10 @@ This new feature can be seen in the `sf_create` (and many other functions) as into the function. ```{r auth, include = FALSE} +suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` First, authenticate and load any required packages for your analysis. diff --git a/vignettes/supported-queries.Rmd b/vignettes/supported-queries.Rmd index 60fd604d..e8f0e35b 100644 --- a/vignettes/supported-queries.Rmd +++ b/vignettes/supported-queries.Rmd @@ -68,14 +68,7 @@ refreshed automatically when the session expires. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/transitioning-from-RForcecom.Rmd b/vignettes/transitioning-from-RForcecom.Rmd index 21d51c5a..a01cc2be 100644 --- a/vignettes/transitioning-from-RForcecom.Rmd +++ b/vignettes/transitioning-from-RForcecom.Rmd @@ -38,6 +38,17 @@ use it by installing from the archive, but we strongly recommend using {salesforcer} instead. The existing functionality in {RForcecom} has been further optimized within {salesforcer} and new functionality has been added too. +## Salesforce Requires MFA Which Prevents RForcecom Basic Auth Log in + +Basic authentication (password and security token) will no longer work since +Salesforce announced that all customers will be migrated to MFA beginning +February 1st, 2022 +([link](https://admin.salesforce.com/blog/2021/everything-admins-need-to-know-about-the-mfa-requirement)). +As a result, the basic authentication routine used {RForcecom} and the legacy, +compatibility method written into {salesforcer} will no longer work. Please migrate +to {salesforcer} and use `sf_auth()` to generate an OAuth 2.0 token. The examples +below will no longer work. + ## Authentication {salesforcer} supports OAuth 2.0 authentication which is preferred, but for @@ -45,25 +56,26 @@ backward compatibility provides the username-password authentication routine implemented by {RForcecom}. Here is an example running the function from each of the packages side-by-side and producing the same result. -```{r auth, eval=FALSE} -library(dplyr, warn.conflicts = FALSE) +First, authenticate and load any required packages for your analysis. + +```{r auth-background, include = FALSE} +suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` -```{r auth-background, include = FALSE} -library(dplyr, warn.conflicts = FALSE) +```{r load-package, eval=FALSE} library(salesforcer) +sf_auth() +``` -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") +```{r, warning=FALSE, eval=FALSE} -sf_auth(username = username, - password = password, - security_token = security_token) -``` +# Beginning February 1, 2022, basic authentication will no longer work. You must +# log in to Salesforce using MFA (generating an OAuth 2.0 token typically from +# the browser). -```{r, warning=FALSE} # the RForcecom way # RForcecom::rforcecom.login(username, paste0(password, security_token), # apiVersion=getOption("salesforcer.api_version")) @@ -75,15 +87,8 @@ session['sessionID'] <- "{MASKED}" session ``` -```{r, include=FALSE} -# keep using the session, just rename it to "session" -session <- salesforcer::rforcecom.login(username, - paste0(password, security_token), - apiVersion = getOption("salesforcer.api_version")) -``` - Note that we must set the API version here because calls to session will not -create a new sessionId and then we are stuck with version 35.0 (the default from +create a new `sessionId` and then we are stuck with version 35.0 (the default from `RForcecom::rforcecom.login()`). Some functions in {salesforcer} implement API calls that are only available after version 35.0. @@ -96,18 +101,6 @@ entire `data.frame` or `tbl_df` of records to churn through. However, rest assured that the replicated functions behave exactly the same way if you are hesitant to making the switch. -```{r, warning=FALSE} -object <- "Contact" -fields <- c(FirstName="Test", LastName="Contact-Create-Compatibility") - -# the RForcecom way -# RForcecom::rforcecom.create(session, objectName=object, fields) - -# replicated in salesforcer package -result <- salesforcer::rforcecom.create(session, objectName=object, fields) -result -``` - Here is an example showing the reduction in code of using {salesforcer} if you would like to create multiple records. @@ -141,10 +134,6 @@ this_soql <- "SELECT Id, Email FROM Contact LIMIT 5" # the RForcecom way # RForcecom::rforcecom.query(session, soqlQuery = this_soql) -# replicated in salesforcer package -result <- salesforcer::rforcecom.query(session, soqlQuery = this_soql) -result - # the better way in salesforcer to query salesforcer_results <- sf_query(this_soql) salesforcer_results @@ -161,9 +150,6 @@ better printing and datatype casting by using tibbles. # the RForcecom way # RForcecom::rforcecom.getObjectDescription(session, objectName='Account') -# backwards compatible in the salesforcer package -result <- salesforcer::rforcecom.getObjectDescription(session, objectName='Account') - # the better way in salesforcer to get object fields result2 <- salesforcer::sf_describe_object_fields('Account') result2 diff --git a/vignettes/working-with-attachments.Rmd b/vignettes/working-with-attachments.Rmd index d7604649..7def66d4 100644 --- a/vignettes/working-with-attachments.Rmd +++ b/vignettes/working-with-attachments.Rmd @@ -33,15 +33,9 @@ attachments, first, load the {salesforcer} and {dplyr} packages and login, if ne ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-bulk-apis.Rmd b/vignettes/working-with-bulk-apis.Rmd index 7f71e0d1..90ddea55 100644 --- a/vignettes/working-with-bulk-apis.Rmd +++ b/vignettes/working-with-bulk-apis.Rmd @@ -30,15 +30,9 @@ First, load the {salesforcer} and {dplyr} packages and login, if needed. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-metadata.Rmd b/vignettes/working-with-metadata.Rmd index 747502f1..3b19649c 100644 --- a/vignettes/working-with-metadata.Rmd +++ b/vignettes/working-with-metadata.Rmd @@ -39,15 +39,9 @@ packages and login, if needed. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(purrr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-reports.Rmd b/vignettes/working-with-reports.Rmd index b7c10206..4d017687 100644 --- a/vignettes/working-with-reports.Rmd +++ b/vignettes/working-with-reports.Rmd @@ -50,15 +50,9 @@ using your username, password, and security key. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(here))) library(salesforcer) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +sf_auth(token = here("tests/testthat/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} From ae039a1e7cecbf5822975c335a0499db7bb94b0e Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 12:48:12 -0600 Subject: [PATCH 03/22] Try explicitly providing path to tests/testthat --- .github/workflows/dev-01-R-CMD-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index a1fe932f..7b8c7019 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -26,7 +26,7 @@ jobs: SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} run: | echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds - mv salesforcer_token.rds tests/testthat + mv salesforcer_token.rds /Users/runner/work/salesforcer/salesforcer/tests/testthat - name: Reveal env vars run: | From 90368de01474095af378cf456f6facdcae389435 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 13:03:28 -0600 Subject: [PATCH 04/22] Switch to providing token path as environment var --- .github/workflows/dev-01-R-CMD-check.yml | 3 ++- vignettes/getting-started.Rmd | 3 ++- vignettes/passing-control-args.Rmd | 3 ++- vignettes/supported-queries.Rmd | 3 ++- vignettes/transitioning-from-RForcecom.Rmd | 3 ++- vignettes/working-with-attachments.Rmd | 3 ++- vignettes/working-with-bulk-apis.Rmd | 3 ++- vignettes/working-with-metadata.Rmd | 4 ++-- vignettes/working-with-reports.Rmd | 3 ++- 9 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 7b8c7019..989adadb 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -24,9 +24,10 @@ jobs: - name: Retrieve the OAuth Token secret and decode it to a file env: SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} + SALESFORCER_TOKEN_PATH: "$GITHUB_WORKSPACE/tests/testthat" run: | echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds - mv salesforcer_token.rds /Users/runner/work/salesforcer/salesforcer/tests/testthat + mv salesforcer_token.rds $SALESFORCER_TOKEN_PATH - name: Reveal env vars run: | diff --git a/vignettes/getting-started.Rmd b/vignettes/getting-started.Rmd index 5875b5a3..f093c879 100644 --- a/vignettes/getting-started.Rmd +++ b/vignettes/getting-started.Rmd @@ -49,7 +49,8 @@ cached file entitled `.httr-oauth-salesforcer` in the current working directory. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/passing-control-args.Rmd b/vignettes/passing-control-args.Rmd index 076d756e..c10851ae 100644 --- a/vignettes/passing-control-args.Rmd +++ b/vignettes/passing-control-args.Rmd @@ -41,7 +41,8 @@ into the function. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` First, authenticate and load any required packages for your analysis. diff --git a/vignettes/supported-queries.Rmd b/vignettes/supported-queries.Rmd index e8f0e35b..b4e2e40b 100644 --- a/vignettes/supported-queries.Rmd +++ b/vignettes/supported-queries.Rmd @@ -68,7 +68,8 @@ refreshed automatically when the session expires. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/transitioning-from-RForcecom.Rmd b/vignettes/transitioning-from-RForcecom.Rmd index a01cc2be..77fadfa4 100644 --- a/vignettes/transitioning-from-RForcecom.Rmd +++ b/vignettes/transitioning-from-RForcecom.Rmd @@ -62,7 +62,8 @@ First, authenticate and load any required packages for your analysis. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-attachments.Rmd b/vignettes/working-with-attachments.Rmd index 7def66d4..e9e87e11 100644 --- a/vignettes/working-with-attachments.Rmd +++ b/vignettes/working-with-attachments.Rmd @@ -35,7 +35,8 @@ attachments, first, load the {salesforcer} and {dplyr} packages and login, if ne suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-bulk-apis.Rmd b/vignettes/working-with-bulk-apis.Rmd index 90ddea55..198aafbf 100644 --- a/vignettes/working-with-bulk-apis.Rmd +++ b/vignettes/working-with-bulk-apis.Rmd @@ -32,7 +32,8 @@ First, load the {salesforcer} and {dplyr} packages and login, if needed. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-metadata.Rmd b/vignettes/working-with-metadata.Rmd index 3b19649c..2194ef58 100644 --- a/vignettes/working-with-metadata.Rmd +++ b/vignettes/working-with-metadata.Rmd @@ -38,10 +38,10 @@ packages and login, if needed. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) -suppressWarnings(suppressMessages(library(purrr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-reports.Rmd b/vignettes/working-with-reports.Rmd index 4d017687..c8ecfa76 100644 --- a/vignettes/working-with-reports.Rmd +++ b/vignettes/working-with-reports.Rmd @@ -52,7 +52,8 @@ using your username, password, and security key. suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) -sf_auth(token = here("tests/testthat/salesforcer_token.rds")) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} From 83d588bfb2bd1d12fb2dbdca59aa2fe0c18f6f5e Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 13:08:51 -0600 Subject: [PATCH 05/22] Remove quotes that make path a literal string --- .github/workflows/dev-01-R-CMD-check.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 989adadb..20216ab1 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -24,10 +24,11 @@ jobs: - name: Retrieve the OAuth Token secret and decode it to a file env: SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} - SALESFORCER_TOKEN_PATH: "$GITHUB_WORKSPACE/tests/testthat" + SALESFORCER_TOKEN_PATH: $GITHUB_WORKSPACE/tests/testthat run: | echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds mv salesforcer_token.rds $SALESFORCER_TOKEN_PATH + echo $SALESFORCER_TOKEN_PATH - name: Reveal env vars run: | From 7fc9a932619fb219134246703ca33a46972eb9a3 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 13:12:18 -0600 Subject: [PATCH 06/22] Try different syntax --- .github/workflows/dev-01-R-CMD-check.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 20216ab1..bf0dca71 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -24,11 +24,11 @@ jobs: - name: Retrieve the OAuth Token secret and decode it to a file env: SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} - SALESFORCER_TOKEN_PATH: $GITHUB_WORKSPACE/tests/testthat + SALESFORCER_TOKEN_PATH: ${{ GITHUB_WORKSPACE }}/tests/testthat run: | + echo $SALESFORCER_TOKEN_PATH echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds mv salesforcer_token.rds $SALESFORCER_TOKEN_PATH - echo $SALESFORCER_TOKEN_PATH - name: Reveal env vars run: | From d8e744b6775b24ba6a1ae17c3e6c2e976b7768bf Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 13:15:24 -0600 Subject: [PATCH 07/22] Try after reading documentation --- .github/workflows/dev-01-R-CMD-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index bf0dca71..0f2f5d2b 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -17,6 +17,7 @@ jobs: R_REMOTES_NO_ERRORS_FROM_WARNINGS: true GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} + SALESFORCER_TOKEN_PATH: ${{ github.GITHUB_WORKSPACE }}/tests/testthat steps: - uses: actions/checkout@v2 @@ -24,7 +25,6 @@ jobs: - name: Retrieve the OAuth Token secret and decode it to a file env: SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} - SALESFORCER_TOKEN_PATH: ${{ GITHUB_WORKSPACE }}/tests/testthat run: | echo $SALESFORCER_TOKEN_PATH echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds From 382fed4bf178bcc6a4abc57e46780d1115d6c8d2 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 13:24:27 -0600 Subject: [PATCH 08/22] Try again --- .github/workflows/dev-01-R-CMD-check.yml | 2 +- vignettes/getting-started.Rmd | 2 +- vignettes/passing-control-args.Rmd | 2 +- vignettes/supported-queries.Rmd | 2 +- vignettes/transitioning-from-RForcecom.Rmd | 2 +- vignettes/working-with-attachments.Rmd | 2 +- vignettes/working-with-bulk-apis.Rmd | 2 +- vignettes/working-with-metadata.Rmd | 2 +- vignettes/working-with-reports.Rmd | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 0f2f5d2b..39d2458b 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -17,7 +17,7 @@ jobs: R_REMOTES_NO_ERRORS_FROM_WARNINGS: true GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_TOKEN_PATH: ${{ github.GITHUB_WORKSPACE }}/tests/testthat + SALESFORCER_TOKEN_PATH: ${{ github.workspace }}/tests/testthat/ steps: - uses: actions/checkout@v2 diff --git a/vignettes/getting-started.Rmd b/vignettes/getting-started.Rmd index f093c879..dc61d1c0 100644 --- a/vignettes/getting-started.Rmd +++ b/vignettes/getting-started.Rmd @@ -50,7 +50,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/passing-control-args.Rmd b/vignettes/passing-control-args.Rmd index c10851ae..53357bfb 100644 --- a/vignettes/passing-control-args.Rmd +++ b/vignettes/passing-control-args.Rmd @@ -42,7 +42,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` First, authenticate and load any required packages for your analysis. diff --git a/vignettes/supported-queries.Rmd b/vignettes/supported-queries.Rmd index b4e2e40b..f21331db 100644 --- a/vignettes/supported-queries.Rmd +++ b/vignettes/supported-queries.Rmd @@ -69,7 +69,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/transitioning-from-RForcecom.Rmd b/vignettes/transitioning-from-RForcecom.Rmd index 77fadfa4..1cd0f249 100644 --- a/vignettes/transitioning-from-RForcecom.Rmd +++ b/vignettes/transitioning-from-RForcecom.Rmd @@ -63,7 +63,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-attachments.Rmd b/vignettes/working-with-attachments.Rmd index e9e87e11..e44bc328 100644 --- a/vignettes/working-with-attachments.Rmd +++ b/vignettes/working-with-attachments.Rmd @@ -36,7 +36,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-bulk-apis.Rmd b/vignettes/working-with-bulk-apis.Rmd index 198aafbf..ba7d2104 100644 --- a/vignettes/working-with-bulk-apis.Rmd +++ b/vignettes/working-with-bulk-apis.Rmd @@ -33,7 +33,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-metadata.Rmd b/vignettes/working-with-metadata.Rmd index 2194ef58..ba4aeb5e 100644 --- a/vignettes/working-with-metadata.Rmd +++ b/vignettes/working-with-metadata.Rmd @@ -41,7 +41,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} diff --git a/vignettes/working-with-reports.Rmd b/vignettes/working-with-reports.Rmd index c8ecfa76..855b990e 100644 --- a/vignettes/working-with-reports.Rmd +++ b/vignettes/working-with-reports.Rmd @@ -53,7 +53,7 @@ suppressWarnings(suppressMessages(library(dplyr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") -sf_auth(token = paste0(token_path, "/salesforcer_token.rds")) +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r load-package, eval=FALSE} From 0db5991fe89c42eb009e4105fddaf7c8aff34491 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 13:29:54 -0600 Subject: [PATCH 09/22] Diagnostics --- .github/workflows/dev-01-R-CMD-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 39d2458b..45dc7747 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -26,9 +26,9 @@ jobs: env: SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} run: | - echo $SALESFORCER_TOKEN_PATH echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds mv salesforcer_token.rds $SALESFORCER_TOKEN_PATH + ls $SALESFORCER_TOKEN_PATH - name: Reveal env vars run: | From 072e941d8e9e8ff36127b61f33ca4a34fe83073d Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 14:00:51 -0600 Subject: [PATCH 10/22] Try Referencing Token by Decrypting It --- .github/scripts/decrypt_secret.sh | 7 +++++++ .github/workflows/dev-01-R-CMD-check.yml | 10 ++++------ tests/testthat/salesforcer_token.rds.gpg | Bin 0 -> 6083 bytes 3 files changed, 11 insertions(+), 6 deletions(-) create mode 100644 .github/scripts/decrypt_secret.sh create mode 100644 tests/testthat/salesforcer_token.rds.gpg diff --git a/.github/scripts/decrypt_secret.sh b/.github/scripts/decrypt_secret.sh new file mode 100644 index 00000000..28908832 --- /dev/null +++ b/.github/scripts/decrypt_secret.sh @@ -0,0 +1,7 @@ +#!/bin/sh + +# Decrypt the file +# --batch to prevent interactive command +# --yes to assume "yes" for questions +gpg --quiet --batch --yes --decrypt --passphrase="$SALESFORCER_TOKEN_PASSPHRASE" \ +--output "$SALESFORCER_TOKEN_PATH"salesforcer_token.rds "$SALESFORCER_TOKEN_PATH"salesforcer_token.rds.gpg diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 45dc7747..542fce01 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -21,14 +21,12 @@ jobs: steps: - uses: actions/checkout@v2 - - - name: Retrieve the OAuth Token secret and decode it to a file - env: - SALESFORCER_TOKEN_BASE64: ${{ secrets.SALESFORCER_TOKEN_BASE64 }} + - name: Decrypt OAuth Token secret run: | - echo SALESFORCER_TOKEN_BASE64 | base64 --decode > salesforcer_token.rds - mv salesforcer_token.rds $SALESFORCER_TOKEN_PATH + ./.github/scripts/decrypt_secret.sh ls $SALESFORCER_TOKEN_PATH + env: + SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} - name: Reveal env vars run: | diff --git a/tests/testthat/salesforcer_token.rds.gpg b/tests/testthat/salesforcer_token.rds.gpg new file mode 100644 index 0000000000000000000000000000000000000000..3bb2abb814f6d5bb752453ff0c54090f517355e0 GIT binary patch literal 6083 zcmV;!7d+^U4Fm}T0>}f=N1VDO(&p0E@c}UnU|ZuoYa5&!AS1Xj&@Bt%fn!53$k7}>zd5_mDG6|>iu=7(;eV6zGd<}bqzVJ! z5O-=b1|8S*WYnKsCdQbplW!{yxrUq?U`Bb;P|Ohl09ltQ?@GX6h|A6jQiMExlbIjM z&4w{VW=KMQFK0oQF5x^CUl*C*d%1t}XGf8M4`{!-^_=~KPg^F%U zjPGFTmE=dw#e}*dYpmUmQ+*WI zQFz_X`&%npHz?|eyhg_Sr=aOp>PD2JS38sEPUiHq9XeR}prHBi@QGGD{4)%f|o)y9De8PJ_$x2c8}c_T^(LpAexG~uXhsI-`%0$lR^*}I}XOh zbAbpllRPe~^;k$DtREA(Hlco<% zb9fTb|6%uxj+~t6fz=*p_@qI_P8METHJrt5^H!+Z$h{HY3{!+D+RJ%hy%Wl_X56N^ zU$-U>B3A4lQhir}pm6gckA{oKre}IJK@Y0fivg1kG%TXShlYK|(@iWkSyPn@t(ol& zH>7Z~a5)=->+;}0fv0-1Rg~2wv*le^Kc?|IijwWDb__Gr8&5xB)Hn9dj`$xq%8{~! zwxAU-Wg+410^5aSK{I76ds8nrG`O`>zXLzs;9A6>(>IODE*gEnd5u*x94jQaR~J*- zx_d&1Lpn6B;QAi_k>d4VACwcewk~{-JyQ)Nwso1=7aLsgc1)pq+!plir7EDxV>-QG zF~?ow!=EjGthP(yNysyCc@Z_E1=jd90WY4%k#|FWl8N>sOwfdMu4~ojLTazV$LOL4 zsl@AE&mHsf%C~iY#GFt_xRWCg=`O;RiPjEQiA>&WQE@YD59q*AqiaXZ!dqeO`ZWa! zJHB5xOmq7QsCG=00^-_XQuLeY2Eghd_xqOwu!|bwg5wUZnymi=kq@8?0a}L)z(gXF zO$Kr-y9aE*_^qt5s97x6xj+jTE^$RcqR~qDxJJO|jT4x>PNTVg`ON)ol~UHV6oRP9 zTjokmShJjN0T9=Vn5l(>9&H880}=R6gsg=_WAVl!wFK~-H=Kq|fkiy^5Nqjl zSI8!4+QmdY;-2jp?WRD-KhQw?-PJ{_)g#uK`ei0m3FUMb>72V5tF)dvJGg4o|8v@2 z9(xpg{UX@VpsXN^qU|=s+Nse~B&boF#)|%vj-Fw70r1T&4RAZJEn+;c%ZwYA!7~5K z2|HKf@065!%m91wLt~SQ1m+nrs8YoT=!a@oR`p&s(@k&M8m@`;-XUosNMc65+M3!b zjC^v^hnaZY++HD-wGJg0@>TF5&#(r2&93=;-DzQ0B7)2E|F76r0fNjrrD|__m5CBc zD)6>IOk}u=4nAVhD$}^VN3Bw8wB1?rHfGIt-qJO^A^)EQK8~9`yQC~Zsh|MLYPY3~ zwSD-TJ9zcMx@aZz%Pgn=y#c{2H571%K)1JiwFmHyr4F`rTe@JSz<_W3s`-9v^8 zs$vieV=`}gUF+fKl1&I{&*K}sdQ%v7;e?rh0z9E%`_YNg7=e8;yvy2co2fa3RhM>7e%?!&yPjJYJ^d#_K?0%mT%*N0kN%S zwJz8wi!>_6X#cuWwUPk^pSf&Dn+Ue+&MGli;FexXY3x5qvUcyTjZbJlgJiPlrfoov zMSu^DXTTJba(m^Vh83Q%q}KP-fYnKH>?+=d;Alg=(&d&X zofS&~PJNO+>`B!Jpw$aWQ^MwJj;abYW&Rb82;kVri*0Xm*0vUHo)5a{a0VOvJmddewNg4KzxXE}-m6><)?>Jx zmV$qKZ~R|Yicd<7c4lFd1pOKa0?vqG-WVgSbNm(At`je?$rVf($B#Jjo0=?!|AeWH z`-IJZvLEbn;(BOvv5EH&1;ag=g%LAn7!`}o%R3C{$rI7mVPrAOccqH&dri>N4)xsd@g-aRv#hO)xGtkun^QrD%P{G_b`vZ31CMjr%R#lnwU29#Bt`%}#c&17Qr! z3#4OB7)C2BSZn!=B9{jy1(-5{2^*hbvbTr99<8Ra2oc+F0yATzzDc(wWEkp{Rz*&J zy5i#M9nu(@R99qxhE}T;(Q#b$uBImo>}v2(>_0EWzJFHhiK~cX7@WK~zMW$mJ|naf z#LhZXpa04nU=YpGwoj1Y^^e6g@1I(y7OYjZ>v|%0@R|Qa%$NZ^Ys7Buzks%qcwHd| zFl_s>xm50<{0f@28&us30FbTbZL{>}h!|#yBn3BsG(s4~&$8>bJzqvDRn{#}6iP%= z6%@dmlc~0!F*3GL*ERu5m0{Ktc~qWIU7b&0E{E{_ny|uGrm8)1l8$ni!U8)*YMc!k zCx0g#Iv4R103&MI$GP#?45|ETZa{XdhN9gK3Z;Lf1jWki)dP?)PmCB-CD7x9MB`!X zV+kTEcLqE-3FzpTCg79}vnbp_l8@+7>XZF47Wm;BBE(Mf~kU($F(VoDx&4+ow()aKW|=w-iW-uV*#f zyKGDGc4I(xU3Kesr@eV5#~b2edb4RZ4CvYj`OBOhdP?H=)(UFikIr4s!YlUe-LY79 zgHBpP;wvLK1608v#~IJ4*vN^f8%T*6C_xv)RgH8??yzUOq17ZT?*gKXuL<^g5LGgs z(;CTDjU_Q!s=G!aAH~MsnFmM88b6As70zQ*V?3|%kibE!2Qw`M4x)OUG;y6==d~VG zkzF%R&m2U;JT{a0u=VJ@iZQvofPM>`QLvmO9Lr>9O+pbvgy_wvF&}}zl}<>=cx5E- z01$=DP{WPpwe6**97iL{6O_jgo56=9S%lP}hRM?DiW9axRr=`R=}8ZI)_#LUhBvOb zm>owSujj7{ea4kk9kQ>~;#ly&1<7SXACtis%-{uOty`T%xkXTy=m+IbgpLg=QvF;W zOIyCL;BaU%f%))WoYETjv}LSNoetJn7erW^+aRUs6r?FnPTxm5E-WDCAZ9qKfzpH| zdsz^kzE{^?@;Y~!Y>wmFTMaeKq7Dq403l42M&Z1#Fn226_SUe+)uOCx2Nq$^K(<8> z38%4P!0UX``a!^b3l_wj)+I&*JcUnA1fxhlkO=VD&)se6Ch~8^3yv1;Y=&>VSvTa~ zhWs=(FkMZWP`!yhztR+@K&(tyOP`M+CWTfO9J5!~0Dq9K5)NlQeg{tje9a*LAY+LC5#Zr#v!EL6)mg8vo>Yt39XfT~k3iYH^>=rXle3WQ1DRQ!5tHSm>1Z_%KEH zhSSUJt9QZ8Og6tIM;WC$KyU9OyL9E~1e>navy?Mgp}@)Q)-y2t?ZuXqik*x$43+=? zca2MPw#eClw~e0RkJlwJX3@Z20ia4{0-((cVi_=aeB0dPL&Z6bc~9)7XhjtlzfT73 zgBn#M-!)Ky81iyA(#f54Eoz z6KdJ7M1!Zf7(PkHY_Wc0gq>U?d=9|g!VMG9eAbUz$u;pl=8?M^s!GC{JOQvu^7f)v zT~>YvRnCyut(hPPc* zob46%(=HwNAATt+>4Ulv!v&%DIRa0*!Uwe9z0=OR_;6|QT=_B?#*ybr!{Yub2Hmu?M!LdMAe>t;i>8Ae z+dHYdmQ+Hx1#X@+5F2*oa(va3cJO4Bq_uM;sWE%J#GAg~*0xUtNBV`@MP31*$ zDCKm-z&r519C|}v-JG(dxukAEp?OBfTjaY+E9};$$*h`uIrWL1)`y!2T zz}q(1x$U5VVSZe}{(?)gWS{l*yTv~`3G|4me0ONSWFobD23(sH$W%KZ8!bqIbm8~7 zuJZxeAreuO(p-947V!1|o<~XcxR%N^V8+-|@09){<&xFrJC5&y7N>18089vpga@uw zi;{U=JOZKM?xbatnQiz=wW&i5w{0vA69hZ2r*6`ZltiGKEIbzCw66|2ja5<`HIX0t zYn7nhnj$W@sFTVR!FZ?dHQE0!QRNS3WAeNBCs7>G_TG#Pm~4Y^>)Yz*G_Q;Q%Qyg5 zyU`oL=bTbAh}(6a-zA(e&0$_;@dI_1UzrW~^A?eCX3&ghBVGj6qg-(wA zN~*o=VZU=jI84CgC$Y%g4u;$jAQ8^MrcGe;$UlBT3&I)sBK`V5d||P=mOLB$#p+;a1hr?ZqGmCzcodkLPbG^%!QN%ifZhY#2*DR5Isuf zG(0f9Tg7-jLLq|X)Hk)IzD(JTRx;g%5T{(fh$o4azp&(+g9D)%aD>cHKVFUCj`1aP z!y(w-mE)-7&?3yN)l?g&AyGMal=jxFc|PN3XP;zLcyV!I;l94h!~Jv7*Up6RGHSuL zd*0;LTVi7D96n&i0-*2tS)$8M9LQFd%}^YF{6KpcO?iGUKo@)fo4Xa+w$-j}2ClslNIAlc%X=pZW!wss;FZ9SW7aa6Q5jm&wB!uiBf!aE6 zN%xO)hU#3(P5o^phxz`ZGTye+1ef;6?3#Dt+hNKXh~kUx}lCC5W^!$f5wO1yk#W#Jk4VDtcFqi*t#H9>>`CwjeQ} zv5i)fIjv9_pcq`F(a{w0#NVBrOe{TobLC#;!$H7#2GH~k;jL)lf1|y_1s#vp>-5yZ z2Pu9hyYMy_&A)EN;Bil&WrBwX%BfPWh1h0z@?uYvgxeB! zWi4d$*_Z96MEC?$WaZkHub$0fK8))t)Sc_>1vvL?lx$cTXiD~{fXV`oA-QOn9^Jv# zyw(=l%r9xsM#FH$%QE5fwe&3hEp%4-n&g5Ecy_zM7EKjS zmHPOlB?G*K(Ao`IgS_oh=Hrgrp*_lC3FhtV(VW}*UwYNb07_XpZnlT?z07{hTQK&V z(y+=DNDnDF0P_$&oi8ik%oE1u(9jQn7TR5^S19C&Y>QiBUhdh z`6?Bll+{L4gw#Vn z9jUSe#2U6RO(i!36taQiQMlTJDpv)jPP^A@+WARva!{`5U5~kDt6H*%?l0WiL81v6 JL|-$sx*=O8-9i8W literal 0 HcmV?d00001 From 1a71ceaea74f732e3573eb5822b9fe8b9d7d9088 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 14:01:49 -0600 Subject: [PATCH 11/22] Add new decryption script --- .github/scripts/decrypt_secret.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 .github/scripts/decrypt_secret.sh diff --git a/.github/scripts/decrypt_secret.sh b/.github/scripts/decrypt_secret.sh old mode 100644 new mode 100755 From b816eb8f855203d864c0e019416859b1aa4ff488 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 14:03:43 -0600 Subject: [PATCH 12/22] Remove Travis Encrypted Credentials --- tests/testthat/salesforcer.tar.enc | Bin 8720 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 tests/testthat/salesforcer.tar.enc diff --git a/tests/testthat/salesforcer.tar.enc b/tests/testthat/salesforcer.tar.enc deleted file mode 100644 index 36ad03fbb2b1f28a7533b051e6ae590ccae92e6b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8720 zcmV+rBJbVI8M;562k6Izlw=Zax2_?Dc`K!urhyjNd((V~S;PN3H<@132;M76x2fJN zi1qw*zx%02H6GD0e@vp>8~79Qo-1BBc0NZ!$fAXfe`1b}HUZ&Z98PbN6`BCe6LLu7 z5gdBmz0$B9p3?_(r6PN9eNoR`bUl?^1jC~NuFyK%&hYQpQew`Y4rc(pFlSQEg| zLb#9FoVE}_+Iva@0WD!Ju@;k1Wn&AS$W3zp3Ix*sksO~u3*LL-N_}{9d+msI^xS7+ zAqi0Eu$pB;TG)Hjx#0cfXl}9XWng?7VHpYy&3lnOL7gvi>Y!TfqR0w5BmoYX*7ufy)D`aOL4y0ZC^#sh?v$GmsJ>`dS>bo?))2&mKlW7n% zW}1~*FXy0b`Uyjo&wV*92?9XmS8RK^&Gc;zQIP$VU{(8_=M^QoMU*@_2IyS=VYp&y z-bDNet0@M+S3ofz_)O-PKdZ-%4D!fRDFsY1ogn^BZ%PoCI;{Rhey{QaGZLucxjIS9 zY4wl`!~}t=MHv}n?RJH3VnAg=OgXS%`MHE&2m%(7|Gtp)#UfJMV@;NGnNe*f;w_QD ze<(P^p{mWQn(xImr!g(K@4sgZ?zc-3hI{&oEXUkihM6{NKtcJyZrDOZg>HsVAjqTh z0V9-v!StJ=KLbhSakqJz@hD9tpm>xCk@J+>*urev)AuG$3e{KpIAm)s5}?#B zx}UXEz#67TFN#}gX5m+Zdy}7_8C?2=URYwTbIIFpkYhypme+KfcOlo`a+)6bJ~c2z6%jdpS~M?Puior7Me~_Abt`;sG$8^LBS-=L$VWZ;&=1`4Z3$ zug=-9$S%DAJVe#%ewbzdHZwf0g-&VCnG*^|wy}o$jS*dq+q8ET zP(exsNc%FZ?*a9l{C>1d=AgH`EN|&>>mUPyW-dXazNtNqM3LP_*5SO_)xSacZLq^U zb9*m7LCJ*Qo-XB0RHrF^)$LkPRsa~-SdX+>HxzdC>I4uZB@cwnXzK4&e-S$ypoj;< z);0pMQ$OUaQL8Z}f%fya%9E}WC?6OT_Q#EjLCbY*+=A-i<0DMG7p9Uesfdcl0u$F-(NR7D zmmRY^1wPO6?WU|f9%e?;RH5U|tc;)2X$ka8g$7^>^U9rt*pArX8z0pR4-7AZWhvXo zuZ0SCg?qaZ?L!aJa}PoXQ#j4m?sb37bo27qE^?h-JGlQY^i{+D!I%^R6ORj$a*Sqn z19GoVYicd-VK1Sesc+NrbbI}X3M2@sw_mm?uol;#$vImQT8%mauc zOey~72ibsaSV@7G)hUR1D?h71VG_)d{acA3LzfxuNj`y$QI z#H}B@avoU%pqozo(fb_H(r_A7?u=-(j*Z(DoGK^z`Ear()G##lj(l!cEAaP=EL!Pn zp1DJr6Ph~wE$7u_T{>yib9s<=XJrAD;0hFNcv%tNw`e(Wcc9|1blSQ%H_xP=2rj*s z1W5c8CHk6>O$r;-`S+MUVM|_1%G%IK!$KF3T1JnXs;j4t+Yj z)!6G4bfA>RVf0*r`{|DO9%n@Q@s8Ja1Sq~2fz0aAcDj01nEw2mqbWhj_2uhb*X1Yr z(_`-s>iGG{wqTDh+zx;pOb#k-`urE5XX(P6*a+}!4aEk51q5@{NGXM8i$(nDiN^GM zM0;7|z#4s}J;t{!A+B^?GX4SUc7vx%9*vZ~jifWFO`_ozK~Yk60CI)83y`rt)I_`i zCd{@F?|-Iu59OHk9W@!%dRj|XMD~}?r3qv4>2;Mv+GI+akr4q#0fu}50aV-%L^qmS zi7+aMQ(C4xhCo&Q&T-~ql=uH)Cp4Y3A?~z~C3vLob zv)Gz-zV@p?>?VHo4U6rkgX*SCsIn6sNsk>@%$i-8Km;@viA#k)=JxBE&fkYaPw&F5 zh43LOnOZ$(-!Mv8*&V+I;}}Lk$It|mFVgzSg2F~Zq6+vr^1JnQBVB0ZsCO*@%`cw( zbI$LY!Ap^FA)u*~WSC**R@rb9f%2)~Bppw(D|i?cJ_!PcU?sFhmjJ$az|38Ffc?Ra#>4vJ~%w1EGm^Gmuz0*1f9YoYqP*` zyr!5FA%_xlz8ngV0`+Jj9E61{^!xN|l8$EqjUPZY2At2ti=Q{bUyPYO{aa!VO96k& zfjGB@CBj&GHAyH$*#hQ$n2+~=v92xW=W4;krP*E!VY;O5c(z*I0n>22n2Daaj$&ku zZ8LBn)2$0=8QnRm5n+TfnQALq^zV{a&-uIiiFU{T7{EjwjQr$KaTBxqcOGBF+~Ln% zM-h#yLHU@(TZPnm2a;A>Zg8O zkjY&!n-=Z*RTT|IXZWONVyLwp{j+X~B-a{~_c|8yQSP3%z}aMi*6B>C+Q2C$U-W&s zgZ-m0ylWV+8k1&>?ET_~Y zhX+f1Qfp7DU-LPiAM^Vfr32oX$3!ytX~H-;F@|MSn$>P zA;!}sV@cYcaQco(fhI@pk9K)|oCmyIKq|l21eS#%j-y`=qTSTyJkN7yu{F*-n-y1% z8HvxiWMS_7q-hSSTG+gGuuSa`iiC&uD);T$IHl7fNszFV#0T6w0Le6SdrMs{mLu5r z^F5$GVR_cVwSheQz$!npW!}qaP)MS7sp(5+ zn1DsRoM20JCB>7@xt&Uunt_u6l50UWUQcIeUW>BsEVz9)Hu+iIvsa)LB7hVwgzG}% zmGgBT=-!%mTX3{4?8pRi(>&4BZZdw>dy>QbRTK()1cShOl_Q^o)AR@k)qYwRfsc)_ zD~qu%FC44km`D#{{76X82odDdZJG9I@Em!ULuccTKVda6j15)-^B<1x@5;nq7carU?* zu9^0Fq^hvf=d*wCcAu2_-LuB+;`RC!U2wk>wbO6A*AGuZopc5O=t9CGHZqi~bA(?v z3_cD|IJjn(`vn!My{`y>?1mHX>W8KoxQ1%Z-DPoS3daQW z5k*vL6xc!@5JSLrMw-sJ!bB#IKSe-0#KBeBl7A*f)W|Jbs^ZqGXNxVYA!bOG2#~|l z^6Ah#)W04Xqkf2Al3is|9T^z!B!8AYSyLTNjjgodjc<%$K%Nhp%&Pl@kh0R`-o8yb z^B*DsazrB#BLaAAg&s4kCOJ|7>(Gi#`&L}>eoMu$DlE9D85?i(iPCxffs;JK>~S$| zs{c)yi?fUZ$RSZa!v13ZOz3<9`cZWCqwrJrAIYXU#k(FpKJdo-q*3Lay5LW8opQ1V zgxmdYvC`dwZiizM0Zdbd*~i)xhIyNBTeCSvNrx08__|v#{LKu+j{MO(dSEkbx{L0%GyrAG^|6HSFg+=EZ z+It3i5BSl;^O@(n0;*`+XE@)p`+R_FFWI9QTD7HqsO0-9tf$! z7%3#D~zaR5r{ukE?)y%g+OJo%i57QgbnXtreAAsy;q&NQ$C-S+1&B z*BcB9F0^UfwKN*EzpRH)i7feV+{#n=;!V|L|1D4T4bp9(l09OOXD1phctfkLD?`&b z49cfSA2+H|9`LMHds^m>q3U4>?(-n}iE5;TA(v!4Zjp^oy41{* zS)_dm_W!%?N^O$n>M;am!UToN^p!1^|RnX#xZ$R(E?n!fG^h-e3k0N#6A?}r(2cFTD)Ff0+t zkFUSj6X;^|%@07j%+Mz+%tCD63K?JskQtBLkoBF-MjDQyin@qEZv0#-S>3+0d91p^ zzfT*cmIDnv3P+i;VGoy<>&7C44?g=HkJ;53&}uL;3{=LQ_uB-!v1RJ@W6AU2CN9muhjaF&kZT4rJeDzjA zDsv#+m=!D{FMoQhA)4{9PYcBFCi)8jxvgrbLu7t!`TtQBIOu|-LRJA~bT_(Apm&f{tW&|4n4r`*U`T{p5ouRHkr$$Krt@|m zr>=qSjkD}4IZfn#=a$~)7^b9BA1i320tU|~G^scvp-#fOHLU4lkh^yoPTs{ntXyg@ zfkVy`*OT=CucuMZ>;yJfSz9%Q6q-+N41+55Fa!QOj=hVVsS#Z?n8hrBJshA}o-NeX ziFIEeS5r*{S`B5q6u$1~9vs@S0c+7{h*IS~F564VL8Zg)*St$F3h($K)0+nn&U3q- z=P-I;7P_wKS43^&+Wi+RDGyFNKIMS0r?RdczU&->017?DRj-*`eVo#Po0M@$XWz^} zj)#>;-c>g0ZQpkTb-HP`t2HyRw=yCpG7LNwDPnNSBR3CMm{zK%Tg432=l&cv@kQkOgaB}VLlPRe~L zU3n!wBvc*@7!k<$E)g#VSOeJfhyU0LKR!;3ru4IbznX&d1XE}BE|<=g)2p)^l?B4U zSRuQOv7_g|Nv$@u`G2rUj)ef>mYjwAbZa0K+u0Yq*>i z>;i8QJ21doT_}G>THgok$8ID(3h9mdImHPz5&3iY8#&7ZJt+s1xvhw90CFKX6_cIt zvR;tyN}_lkyo9Mu%`HseX>FZUONPcZChsQRjFHCy_+@k7LB9Mb&0eKBMx?We!9@}R z{kgr;*ZIFfkB=)4L!;z`-ePoMNkojAU3?$8zkM^6cG8km?oK5Q8U)<}RfYGCM@MoQc=gSDn%F<gb0Zt)MCQL9#RZYa12V8zUp?bXU;&bBvNCzG`SQGq4l{@?jS!S}bFRk6l%M`)!FZ#J42XBwG8*)3tah*x zZ_czO+OL`z>fA7+XI0+C9!yFUn9K1k?D_#~)xzCBYXKf=5nBMj14_FsCf9lhVpNnp zKh~1bH-$t#8 z!v-QHm*%bBg=@ijGN^i2%~wi3y?&Nc3IDvvFUEE9vTG1ey;<<~3vQjiS&=b3ahx3s za_6@)0WHh?g}nN9F7h@Tc*NQac;vZ6%Hz#s!-g8(+5|==f#h4yX9HPizYR z$uGV?l=Qidm^*}6)3(tE#D|?2WI;pm&6S*w5|7W_1NF9S79JIorsCkPD}~Fj^8xeo zF~>0v`BPh-b3&q5w&)e!(=dc30L_-RunJs0+HVzpZDS8~^|?JbY{_ zsrLR9xMEQNkwn>8^U+iGJ*#YPZ`kXyB+H4deoVl}u5TMZ`Q5klw#Gh(GKCj^TFMLBxH(Q+?{ z&2m4qXc(1(PhhFZf0pv~=>EvtBgWWq)dY0r0bOY`+0NmxKO;+U>Gu;%t(ZF@$qGqX z05H?yjIhUqv6wgl`dAqP+;0$xwT@jd6ec)v@8`*Po z`SNS%$_)U13Diu@ZfwU9wB<=%L;ze<80EZfuR7}ft|g2FCz(=RjwBiuDf6lP@cL1a z2A)AUz0a;DYl&@uGF#Gk|2VO?1a>K7L$Lj#P6LnzR!c8qd{|DmDbhn#BQ@1bFIOl6-sKTgwcA+uDi7 z$dM8DW(L*3X=x3KS5@b#;o$#R;4?D<$$smF<6OqzGPbv!M)e!*qME>Pvg3wP!Ry>E z4lTB^`=Ukmn#?2KIA)7d18D!2N_`H_6tGJ|#L`Uf*E`F``%k%GcRxU#c; zw9ZC7*Ngqt%PX&Lxfb2+b0E7?oX>uBHvu@TBQ3PEzrD(9y2)G2fGK@Oncb`L=OO8j`%WtUA@xF9p<$12YjF z?1}o%5YRVHQ}CkFuY0u{xCxI{WO~LzF%ui9_T)>FP1E$~j{@cGW!}1u2HXsILIQGd zN-6#qRMtHmE3+QUSwop<`TE6=4D5lv*ed&sx!X|V$*dJfzvyezOD{gz-e?uqCEMwU z{$UrkRsiXQE4Tx=jY*645_%2Wf%1D0DJ?^wt50H_bVVV+_-%u==znMf-~6`^j|uRo zfsjE1>r-TW8vCr!QlVuGPuGN4^ytHq5knN2c|-xj0KNS?mnq8yTn1T5SfR1iyZaK<7KiJ4qzIY>-5eb+22?-tU#RpCu$1~ zc?vmUrSe9_XPhKsjqbXY@8(Tw$>%*I|*`CS5- z@r_YXIMq!^_!nATp^W`dtPL=jTj9iqY{xH{1BS5xK6Yo%UMUa^EBbI}!6W0Sm$v`S z))mvgk*nJXLF9Cn(0RS~^FN&VjxK1Rea9(#6ggZkEo{p!llk>;ePoE!=qt$L1$QjGZyg7z~kTbuZpDckiaGp8i~ z2Rtwnp48%Y0;xhB-8SKg+g`=#5b1ArN+?18D4p9F=ihde+_VIeMV}vjvdViSg)a7}zM(44;44w?2?RT2P$<#LZ|#+FlfC;{Lb}#^Lar86NJ$ z0WdBlAdSjTe=!nl(c9NgJr|md%fFrPjeMVfem&)?)e>L2v*XDbE)}5H>)|Z&(Ne@e zSait;#i^e*8kn3u{ZTM8a>Cjba9dNEH3#PvI|&tG4lvQFW*o`ANNoOD8~b+;&@rS< z%%HY=AL9s&4SK;mmK10O}mt+QpK8<&3~7Y+p-LjZQ%aZI4t%(>eGd*q>YFgIz@tDq7Yhp5=tr% zq!F+!x`L%@5OYPwM61Sf@ZLHd?#FlcGDN%%jQNu_KE4XN8mQ`Rl-`HI2+3!%_8x=^qB}42q??LWl!w&IC?sOe4tvaqhDz35-XapwCjOl z6{X%1j=KtFl^K`j96EJRXOT5-D0)Ji=Aftk(?B$}`ugb2*T<~A)IM{+m_esUD2&Kv zNYMR=J4djFQXruAtb?5kSJs|JJs}gb8`_q!ch+Y_b5Zm2#uTPufRXdOnBU`CoCJfB z@0~E=?JxyB-gs~(ckA#p@a!HTHkfJ~KcI7Ox(&vhRUTN^v2yTA{MB|5MhEe_azOv1 z`P8UtuAZ1WK1eJuc-xz2vqH-YM^FU-Rl8qeM%IpUgzu;+tjf=p(x6QTIM?V$Z?-Nw uk54$*@0;ZjQbM2A;tY{&WKy(iaN-{UYAS_@2}ChCfn`-*|ILHE^lLRoMEIfr From 04117f48c7e6bf6410a639751c7deafe8863f6df Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 14:07:45 -0600 Subject: [PATCH 13/22] Remove ls command from workflow and enable oauth tests instead of basic auth --- .github/workflows/dev-01-R-CMD-check.yml | 1 - tests/testthat/test-auth-basic.R | 2 ++ tests/testthat/test-auth-oauth.R | 3 --- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 542fce01..3aa4308e 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -24,7 +24,6 @@ jobs: - name: Decrypt OAuth Token secret run: | ./.github/scripts/decrypt_secret.sh - ls $SALESFORCER_TOKEN_PATH env: SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} diff --git a/tests/testthat/test-auth-basic.R b/tests/testthat/test-auth-basic.R index 71b03971..3432aa6c 100644 --- a/tests/testthat/test-auth-basic.R +++ b/tests/testthat/test-auth-basic.R @@ -1,5 +1,7 @@ context("Basic Authorization") +skip("Basic Auth not allowed after Feb 1, 2022.") + test_that("testing auth status", { expect_false(token_available()) expect_null(sf_access_token()) diff --git a/tests/testthat/test-auth-oauth.R b/tests/testthat/test-auth-oauth.R index 3d6306b0..09ec03ea 100644 --- a/tests/testthat/test-auth-oauth.R +++ b/tests/testthat/test-auth-oauth.R @@ -1,7 +1,5 @@ context("OAuth 2.0 Authorization") -skip("No token on GitHub Actions.") - test_that("testing auth status", { expect_false(token_available()) expect_null(sf_access_token()) @@ -14,7 +12,6 @@ test_that("testing nonsense inputs", { expect_error(sf_auth(token = letters[1:3])) }) -salesforcer_test_settings <- readRDS("salesforcer_test_settings.rds") salesforcer_token <- readRDS("salesforcer_token.rds") test_that("testing OAuth passing token as filename", { From 9cb72f75b7bbbfdbec9a2706af0d2b0c7da68127 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 14:11:42 -0600 Subject: [PATCH 14/22] Add missing package import --- vignettes/working-with-metadata.Rmd | 1 + 1 file changed, 1 insertion(+) diff --git a/vignettes/working-with-metadata.Rmd b/vignettes/working-with-metadata.Rmd index ba4aeb5e..f6c14cf0 100644 --- a/vignettes/working-with-metadata.Rmd +++ b/vignettes/working-with-metadata.Rmd @@ -38,6 +38,7 @@ packages and login, if needed. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) +suppressWarnings(suppressMessages(library(purrr))) suppressWarnings(suppressMessages(library(here))) library(salesforcer) token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") From 232b3e7d2ed48b8910ad214759e40ac7eb37ad38 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 20:36:48 -0600 Subject: [PATCH 15/22] Update docs --- .github/workflows/dev-01-R-CMD-check.yml | 2 +- man-roxygen/dashboard_filters.R | 9 +++++---- man/sf_get_dashboard_data.Rd | 9 +++++---- man/sf_get_dashboard_results.Rd | 9 +++++---- man/sf_get_dashboard_status.Rd | 9 +++++---- man/sf_refresh_dashboard.Rd | 9 +++++---- man/sf_set_dashboard_sticky_filter.Rd | 9 +++++---- 7 files changed, 31 insertions(+), 25 deletions(-) diff --git a/.github/workflows/dev-01-R-CMD-check.yml b/.github/workflows/dev-01-R-CMD-check.yml index 3aa4308e..221b2fc9 100644 --- a/.github/workflows/dev-01-R-CMD-check.yml +++ b/.github/workflows/dev-01-R-CMD-check.yml @@ -21,7 +21,7 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Decrypt OAuth Token secret + - name: Decrypt OAuth Token run: | ./.github/scripts/decrypt_secret.sh env: diff --git a/man-roxygen/dashboard_filters.R b/man-roxygen/dashboard_filters.R index cfae287d..4a12a0db 100644 --- a/man-roxygen/dashboard_filters.R +++ b/man-roxygen/dashboard_filters.R @@ -1,4 +1,5 @@ -#' @param dashboard_filters \code{character}; Dashboard results are always unfiltered, unless you -#' have specified filter parameters in your request. Use this argument to include -#' up to three optional filter Ids. You can obtain the list of defined filter Ids -#' from the dashboard metadata using \link{sf_dashboard_describe}. +#' @param dashboard_filters \code{character}; Dashboard results are always +#' unfiltered, unless you have specified filter parameters in your request. Use +#' this argument to include up to three optional filter Ids. You can obtain the +#' list of defined filter Ids from the dashboard metadata using +#' \link{sf_describe_dashboard}. diff --git a/man/sf_get_dashboard_data.Rd b/man/sf_get_dashboard_data.Rd index 5f6b4119..ba21afa7 100644 --- a/man/sf_get_dashboard_data.Rd +++ b/man/sf_get_dashboard_data.Rd @@ -19,10 +19,11 @@ as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not allowed to change the running User, or if the selected running User is invalid.} -\item{dashboard_filters}{\code{character}; Dashboard results are always unfiltered, unless you -have specified filter parameters in your request. Use this argument to include -up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using \link{sf_dashboard_describe}.} +\item{dashboard_filters}{\code{character}; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +\link{sf_describe_dashboard}.} } \value{ \code{tbl_df} diff --git a/man/sf_get_dashboard_results.Rd b/man/sf_get_dashboard_results.Rd index d606ecf1..39f0a8aa 100644 --- a/man/sf_get_dashboard_results.Rd +++ b/man/sf_get_dashboard_results.Rd @@ -19,10 +19,11 @@ as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not allowed to change the running User, or if the selected running User is invalid.} -\item{dashboard_filters}{\code{character}; Dashboard results are always unfiltered, unless you -have specified filter parameters in your request. Use this argument to include -up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using \link{sf_dashboard_describe}.} +\item{dashboard_filters}{\code{character}; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +\link{sf_describe_dashboard}.} } \value{ \code{tbl_df} diff --git a/man/sf_get_dashboard_status.Rd b/man/sf_get_dashboard_status.Rd index bb601eff..8f234c7f 100644 --- a/man/sf_get_dashboard_status.Rd +++ b/man/sf_get_dashboard_status.Rd @@ -19,10 +19,11 @@ as the runner of the job. This should be from a User record (i.e. the Id will start with "005"). Note that this will throw an error if the User is not allowed to change the running User, or if the selected running User is invalid.} -\item{dashboard_filters}{\code{character}; Dashboard results are always unfiltered, unless you -have specified filter parameters in your request. Use this argument to include -up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using \link{sf_dashboard_describe}.} +\item{dashboard_filters}{\code{character}; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +\link{sf_describe_dashboard}.} } \value{ \code{list} diff --git a/man/sf_refresh_dashboard.Rd b/man/sf_refresh_dashboard.Rd index 2a412c66..12bc0321 100644 --- a/man/sf_refresh_dashboard.Rd +++ b/man/sf_refresh_dashboard.Rd @@ -10,10 +10,11 @@ sf_refresh_dashboard(dashboard_id, dashboard_filters = c(character(0))) \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created dashboard. It will start with \code{"01Z"}.} -\item{dashboard_filters}{\code{character}; Dashboard results are always unfiltered, unless you -have specified filter parameters in your request. Use this argument to include -up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using \link{sf_dashboard_describe}.} +\item{dashboard_filters}{\code{character}; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +\link{sf_describe_dashboard}.} } \value{ \code{list} diff --git a/man/sf_set_dashboard_sticky_filter.Rd b/man/sf_set_dashboard_sticky_filter.Rd index 7378b323..78d68fb9 100644 --- a/man/sf_set_dashboard_sticky_filter.Rd +++ b/man/sf_set_dashboard_sticky_filter.Rd @@ -13,10 +13,11 @@ sf_set_dashboard_sticky_filter( \item{dashboard_id}{\code{character}; the Salesforce Id assigned to a created dashboard. It will start with \code{"01Z"}.} -\item{dashboard_filters}{\code{character}; Dashboard results are always unfiltered, unless you -have specified filter parameters in your request. Use this argument to include -up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using \link{sf_dashboard_describe}.} +\item{dashboard_filters}{\code{character}; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +\link{sf_describe_dashboard}.} } \value{ \code{list} From 2e54ce4aec801404aa8e5eb0c600034e24869774 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 21:04:22 -0600 Subject: [PATCH 16/22] Update all workflows to load the OAuth Token --- .github/workflows/main-01-pkgdown.yml | 10 +++++++--- .github/workflows/main-02-test-coverage.yml | 8 ++++++-- .github/workflows/main-03-R-CMD-check-mac.yml | 8 ++++++-- .github/workflows/main-04-R-CMD-check-windows.yml | 8 ++++++-- .github/workflows/main-05-R-CMD-check-linux.yml | 8 ++++++-- tests/testthat/helper-authenticate.R | 12 ++---------- 6 files changed, 33 insertions(+), 21 deletions(-) diff --git a/.github/workflows/main-01-pkgdown.yml b/.github/workflows/main-01-pkgdown.yml index 5aa78c87..a06f8826 100644 --- a/.github/workflows/main-01-pkgdown.yml +++ b/.github/workflows/main-01-pkgdown.yml @@ -18,11 +18,15 @@ jobs: env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_PASSWORD: ${{ secrets.SALESFORCER_PASSWORD }} - SALESFORCER_SECURITY_TOKEN: ${{ secrets.SALESFORCER_SECURITY_TOKEN }} - + SALESFORCER_TOKEN_PATH: ${{ github.workspace }}/tests/testthat/ + steps: - uses: actions/checkout@v2 + name: Decrypt OAuth Token + run: | + ./.github/scripts/decrypt_secret.sh + env: + SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} - name: Reveal env vars run: | diff --git a/.github/workflows/main-02-test-coverage.yml b/.github/workflows/main-02-test-coverage.yml index 77e3b9cf..d9c9bd7d 100644 --- a/.github/workflows/main-02-test-coverage.yml +++ b/.github/workflows/main-02-test-coverage.yml @@ -21,11 +21,15 @@ jobs: env: GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_PASSWORD: ${{ secrets.SALESFORCER_PASSWORD }} - SALESFORCER_SECURITY_TOKEN: ${{ secrets.SALESFORCER_SECURITY_TOKEN }} + SALESFORCER_TOKEN_PATH: ${{ github.workspace }}/tests/testthat/ steps: - uses: actions/checkout@v2 + name: Decrypt OAuth Token + run: | + ./.github/scripts/decrypt_secret.sh + env: + SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} with: ref: ${{ github.event.client_payload.sha }} diff --git a/.github/workflows/main-03-R-CMD-check-mac.yml b/.github/workflows/main-03-R-CMD-check-mac.yml index 798cc09f..71704634 100644 --- a/.github/workflows/main-03-R-CMD-check-mac.yml +++ b/.github/workflows/main-03-R-CMD-check-mac.yml @@ -29,11 +29,15 @@ jobs: RSPM: ${{ matrix.config.rspm }} GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_PASSWORD: ${{ secrets.SALESFORCER_PASSWORD }} - SALESFORCER_SECURITY_TOKEN: ${{ secrets.SALESFORCER_SECURITY_TOKEN }} + SALESFORCER_TOKEN_PATH: ${{ github.workspace }}/tests/testthat/ steps: - uses: actions/checkout@v2 + name: Decrypt OAuth Token + run: | + ./.github/scripts/decrypt_secret.sh + env: + SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} with: ref: ${{ github.event.client_payload.sha }} diff --git a/.github/workflows/main-04-R-CMD-check-windows.yml b/.github/workflows/main-04-R-CMD-check-windows.yml index 55bce1e9..54866406 100644 --- a/.github/workflows/main-04-R-CMD-check-windows.yml +++ b/.github/workflows/main-04-R-CMD-check-windows.yml @@ -29,11 +29,15 @@ jobs: RSPM: ${{ matrix.config.rspm }} GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_PASSWORD: ${{ secrets.SALESFORCER_PASSWORD }} - SALESFORCER_SECURITY_TOKEN: ${{ secrets.SALESFORCER_SECURITY_TOKEN }} + SALESFORCER_TOKEN_PATH: ${{ github.workspace }}/tests/testthat/ steps: - uses: actions/checkout@v2 + name: Decrypt OAuth Token + run: | + ./.github/scripts/decrypt_secret.sh + env: + SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} with: ref: ${{ github.event.client_payload.sha }} diff --git a/.github/workflows/main-05-R-CMD-check-linux.yml b/.github/workflows/main-05-R-CMD-check-linux.yml index 3cac6b7e..4b594047 100644 --- a/.github/workflows/main-05-R-CMD-check-linux.yml +++ b/.github/workflows/main-05-R-CMD-check-linux.yml @@ -29,11 +29,15 @@ jobs: RSPM: ${{ matrix.config.rspm }} GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} SALESFORCER_USERNAME: ${{ secrets.SALESFORCER_USERNAME }} - SALESFORCER_PASSWORD: ${{ secrets.SALESFORCER_PASSWORD }} - SALESFORCER_SECURITY_TOKEN: ${{ secrets.SALESFORCER_SECURITY_TOKEN }} + SALESFORCER_TOKEN_PATH: ${{ github.workspace }}/tests/testthat/ steps: - uses: actions/checkout@v2 + name: Decrypt OAuth Token + run: | + ./.github/scripts/decrypt_secret.sh + env: + SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} with: ref: ${{ github.event.client_payload.sha }} diff --git a/tests/testthat/helper-authenticate.R b/tests/testthat/helper-authenticate.R index f2a319c9..2207ac13 100644 --- a/tests/testthat/helper-authenticate.R +++ b/tests/testthat/helper-authenticate.R @@ -1,11 +1,3 @@ -# salesforcer_token <- readRDS("salesforcer_token.rds") -# sf_auth(token = salesforcer_token) - -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") - -sf_auth(username = username, - password = password, - security_token = security_token) +salesforcer_token <- readRDS("salesforcer_token.rds") +sf_auth(token = salesforcer_token) From 20ea7e3a77030be0697f8ac18e159d85ed532492 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Sun, 27 Feb 2022 22:00:53 -0600 Subject: [PATCH 17/22] Fix Breaking Tests and Warnings --- NAMESPACE | 1 + R/bulk-operation.R | 5 ++--- R/bulk-query.R | 4 ++-- R/retrieve-metadata.R | 10 ++++++++-- R/retrieve.R | 4 ++-- R/utils-query.R | 22 +++++++++++++++++++--- tests/testthat/test-auth-oauth.R | 12 ------------ 7 files changed, 34 insertions(+), 24 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 8bfcf5c0..07f204d4 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -304,6 +304,7 @@ importFrom(dplyr,contains) importFrom(dplyr,everything) importFrom(dplyr,expr) importFrom(dplyr,filter) +importFrom(dplyr,if_all) importFrom(dplyr,is.tbl) importFrom(dplyr,matches) importFrom(dplyr,mutate) diff --git a/R/bulk-operation.R b/R/bulk-operation.R index 19665378..3ae7d7fa 100644 --- a/R/bulk-operation.R +++ b/R/bulk-operation.R @@ -473,7 +473,7 @@ sf_get_all_jobs_bulk <- function(parameterized_search_list = #' @importFrom httr content #' @importFrom readr type_convert cols col_guess #' @importFrom purrr map_df -#' @importFrom dplyr as_tibble bind_rows filter mutate_all across any_of +#' @importFrom dplyr as_tibble bind_rows filter mutate_all if_all any_of #' @param parameterized_search_list list; a list of parameters to be added as part #' of the URL query string (i.e. after a question mark ("?") so that the result #' only returns information about jobs that meet that specific criteria. For @@ -552,8 +552,7 @@ sf_get_all_query_jobs_bulk <- function(parameterized_search_list = resultset <- resultset %>% type_convert(col_types = cols(.default = col_guess())) %>% # ignore record ids that could not be matched - filter(across(any_of("operation"), - ~(.x %in% c('query', 'queryall')))) # is queryall an option? + filter(if_all(any_of("operation"), ~(.x %in% c('query', 'queryall')))) # is queryall an option? } return(resultset) } diff --git a/R/bulk-query.R b/R/bulk-query.R index e58a070f..0ff5ea90 100644 --- a/R/bulk-query.R +++ b/R/bulk-query.R @@ -324,7 +324,7 @@ sf_query_result_bulk_v2 <- function(job_id, #' query API jobs from the Bulk 1.0 API. #' #' @importFrom lifecycle deprecated is_present deprecate_warn -#' @importFrom dplyr filter across any_of bind_rows is.tbl +#' @importFrom dplyr filter if_all any_of bind_rows is.tbl #' @template soql #' @template object_name #' @template queryall @@ -426,7 +426,7 @@ sf_query_bulk_v1 <- function(soql, # remove the initial batch batch_query_info <- job_batches %>% # ignore record ids that could not be matched - filter(across(any_of("state"), ~(.x != 'NotProcessed'))) + filter(if_all(any_of("state"), ~(.x != 'NotProcessed'))) if(all(batch_query_info$state == "Completed")){ status_complete <- TRUE diff --git a/R/retrieve-metadata.R b/R/retrieve-metadata.R index 3ce17613..89981901 100644 --- a/R/retrieve-metadata.R +++ b/R/retrieve-metadata.R @@ -75,8 +75,14 @@ sf_retrieve_metadata <- function(retrieve_request, resultset <- response_parsed %>% xml_ns_strip() %>% xml_find_all('.//result') %>% - map_df(xml_nodeset_to_df) %>% - type_convert(col_types = cols()) + map_df(xml_nodeset_to_df) + + is_character <- vapply(resultset, is.character, logical(1)) + if(any(is_character)){ + # only proceed if the data.frame contains character columns; otherwise, + # readr will produce a warning since type_convert() only works on character cols + resultset <- resultset %>% type_convert(col_types = cols()) + } # continually check status until complete counter <- 0 diff --git a/R/retrieve.R b/R/retrieve.R index 2f7e019f..3d2cd442 100644 --- a/R/retrieve.R +++ b/R/retrieve.R @@ -65,7 +65,7 @@ sf_retrieve <- function(ids, #' Retrieve records using SOAP API #' -#' @importFrom dplyr bind_rows filter across any_of +#' @importFrom dplyr bind_rows filter if_all any_of #' @importFrom httr content #' @importFrom purrr map_df #' @importFrom readr type_convert cols @@ -127,7 +127,7 @@ sf_retrieve_soap <- function(ids, map_df(extract_records_from_xml_node, object_name_as_col = TRUE) %>% # ignore record ids that could not be matched - filter(across(any_of("Id"), ~!is.na(.x))) + filter(if_all(any_of("Id"), ~!is.na(.x))) resultset <- safe_bind_rows(list(resultset, this_set)) } diff --git a/R/utils-query.R b/R/utils-query.R index e8642f6f..ec320ee8 100644 --- a/R/utils-query.R +++ b/R/utils-query.R @@ -750,10 +750,21 @@ sf_reorder_cols <- function(df){ #' @keywords internal #' @export sf_guess_cols <- function(df, guess_types=TRUE, dataType=NULL){ + + + + if(guess_types){ if(is.null(dataType) || any(is.na(dataType)) || (length(dataType) == 0)){ - df <- df %>% - type_convert(col_types = cols(.default = col_guess()), locale=locale(tz="UTC")) + is_character <- vapply(df, is.character, logical(1)) + if(any(is_character)){ + # only proceed if the data.frame contains character columns; otherwise, + # readr will produce a warning since type_convert() only works on character cols + df <- df %>% + type_convert(col_types = cols(.default = col_guess()), + locale=locale(tz="UTC") + ) + } } else { col_spec <- sf_build_cols_spec(dataType) # if numeric Salesforce will flag N/A as "-" so we need to preemptively change to NA @@ -776,7 +787,12 @@ sf_guess_cols <- function(df, guess_types=TRUE, dataType=NULL){ df <- df %>% mutate(across(all_of(datetime_col_idx), ~as.character(anytime(.x, tz="UTC", asUTC=TRUE)))) } - df <- df %>% type_convert(col_types = col_spec, locale=locale(tz="UTC")) + is_character <- vapply(df, is.character, logical(1)) + if(any(is_character)){ + # only proceed if the data.frame contains character columns; otherwise, + # readr will produce a warning since type_convert() only works on character cols + df <- df %>% type_convert(col_types = col_spec, locale=locale(tz="UTC")) + } } } return(df) diff --git a/tests/testthat/test-auth-oauth.R b/tests/testthat/test-auth-oauth.R index 09ec03ea..89d34fe8 100644 --- a/tests/testthat/test-auth-oauth.R +++ b/tests/testthat/test-auth-oauth.R @@ -1,12 +1,5 @@ context("OAuth 2.0 Authorization") -test_that("testing auth status", { - expect_false(token_available()) - expect_null(sf_access_token()) - expect_false(session_id_available()) - expect_null(sf_session_id()) -}) - test_that("testing nonsense inputs", { expect_error(sf_auth(token = "wrong-path.rds")) expect_error(sf_auth(token = letters[1:3])) @@ -30,8 +23,3 @@ test_that("testing custom token validation routine", { res <- sf_auth_check() expect_s3_class(res, "Token2.0") }) - -test_that("testing token and session availability after basic auth", { - expect_true(session_id_available()) - expect_true(!is.null(sf_session_id())) -}) From 873d6161af8732a955b66ab80623ac6b83ed087d Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Mon, 28 Feb 2022 00:57:25 -0600 Subject: [PATCH 18/22] Prep for CRAN Submission --- DESCRIPTION | 25 +-- NEWS.md | 10 +- R/auth.R | 2 +- R/bulk-operation.R | 20 +- R/compatibility.R | 2 +- R/describe-metadata.R | 2 +- R/list-metadata.R | 2 +- R/query.R | 2 +- R/read-metadata.R | 2 +- R/rename-metadata.R | 2 +- R/retrieve-metadata.R | 10 +- R/utils-xml.R | 2 +- README.Rmd | 44 ++--- README.md | 187 +++++++++--------- _pkgdown.yml | 44 +++++ cran-comments.md | 8 +- docs/404.html | 2 +- docs/CODE_OF_CONDUCT.html | 2 +- docs/CONTRIBUTING.html | 2 +- docs/LICENSE-text.html | 2 +- docs/LICENSE.html | 2 +- docs/SECURITY.html | 2 +- docs/SUPPORT.html | 2 +- docs/articles/getting-started.html | 30 +-- docs/articles/index.html | 2 +- docs/articles/passing-control-args.html | 6 +- docs/articles/supported-queries.html | 134 ++++++------- .../transitioning-from-RForcecom.html | 22 +-- docs/articles/working-with-attachments.html | 68 +++---- docs/articles/working-with-bulk-apis.html | 48 ++--- .../figure-html/unnamed-chunk-7-1.png | Bin 49612 -> 41338 bytes docs/articles/working-with-metadata.html | 2 +- docs/articles/working-with-reports.html | 34 ++-- docs/authors.html | 2 +- docs/index.html | 77 ++++---- docs/news/index.html | 9 +- docs/pkgdown.yml | 4 +- docs/reference/VERB_n.html | 2 +- docs/reference/accepted_controls_by_api.html | 2 +- .../accepted_controls_by_operation.html | 2 +- docs/reference/bind_query_resultsets.html | 2 +- .../build_manifest_xml_from_list.html | 2 +- .../build_metadata_xml_from_list.html | 2 +- docs/reference/build_proxy.html | 2 +- docs/reference/build_soap_xml_from_list.html | 2 +- docs/reference/catch_errors.html | 2 +- docs/reference/catch_unknown_api.html | 2 +- docs/reference/check_and_encode_files.html | 2 +- .../collapse_list_with_dupe_names.html | 2 +- .../combine_parent_and_child_resultsets.html | 2 +- docs/reference/compact2.html | 2 +- docs/reference/drop_attributes.html | 2 +- .../drop_attributes_recursively.html | 2 +- docs/reference/drop_empty_recursively.html | 2 +- docs/reference/drop_nested_child_records.html | 2 +- .../extract_nested_child_records.html | 2 +- .../extract_records_from_xml_node.html | 2 +- .../extract_records_from_xml_nodeset.html | 2 +- ...t_records_from_xml_nodeset_of_records.html | 2 +- docs/reference/filter_valid_controls.html | 2 +- docs/reference/flatten_tbl_df.html | 2 +- .../reference/format_headers_for_verbose.html | 2 +- docs/reference/format_report_row.html | 2 +- docs/reference/get_os.html | 2 +- .../guess_object_name_from_soql.html | 2 +- docs/reference/index.html | 50 ++++- docs/reference/is_legit_token.html | 2 +- .../list_extract_parent_and_child_result.html | 2 +- ...analytics_folder_child_operations_url.html | 2 +- ...make_analytics_folder_collections_url.html | 2 +- .../make_analytics_folder_operations_url.html | 2 +- ...make_analytics_folder_share_by_id_url.html | 2 +- ...analytics_folder_share_recipients_url.html | 2 +- .../make_analytics_folder_shares_url.html | 2 +- ...analytics_notification_operations_url.html | 2 +- ...ke_analytics_notifications_limits_url.html | 2 +- ...make_analytics_notifications_list_url.html | 2 +- docs/reference/make_base_metadata_url.html | 2 +- docs/reference/make_base_rest_url.html | 2 +- docs/reference/make_base_soap_url.html | 2 +- .../make_bulk_batch_details_url.html | 2 +- .../reference/make_bulk_batch_status_url.html | 2 +- docs/reference/make_bulk_batches_url.html | 2 +- docs/reference/make_bulk_create_job_url.html | 2 +- docs/reference/make_bulk_delete_job_url.html | 2 +- .../make_bulk_end_job_generic_url.html | 2 +- .../reference/make_bulk_get_all_jobs_url.html | 2 +- .../make_bulk_get_all_query_jobs_url.html | 2 +- docs/reference/make_bulk_get_job_url.html | 2 +- docs/reference/make_bulk_job_records_url.html | 2 +- .../reference/make_bulk_query_result_url.html | 2 +- docs/reference/make_bulk_query_url.html | 2 +- docs/reference/make_chatter_users_url.html | 2 +- docs/reference/make_composite_batch_url.html | 2 +- docs/reference/make_composite_url.html | 2 +- docs/reference/make_dashboard_copy_url.html | 2 +- .../make_dashboard_describe_url.html | 2 +- ...e_dashboard_filter_operators_list_url.html | 2 +- ...dashboard_filter_options_analysis_url.html | 2 +- docs/reference/make_dashboard_status_url.html | 2 +- docs/reference/make_dashboard_url.html | 2 +- docs/reference/make_dashboards_list_url.html | 2 +- docs/reference/make_login_url.html | 2 +- .../make_parameterized_search_url.html | 2 +- docs/reference/make_query_url.html | 2 +- docs/reference/make_report_copy_url.html | 2 +- docs/reference/make_report_create_url.html | 2 +- docs/reference/make_report_describe_url.html | 2 +- docs/reference/make_report_execute_url.html | 2 +- docs/reference/make_report_fields_url.html | 2 +- ...make_report_filter_operators_list_url.html | 2 +- docs/reference/make_report_instance_url.html | 2 +- .../make_report_instances_list_url.html | 2 +- docs/reference/make_report_query_url.html | 2 +- .../make_report_type_describe_url.html | 2 +- .../reference/make_report_types_list_url.html | 2 +- docs/reference/make_report_url.html | 2 +- docs/reference/make_reports_list_url.html | 2 +- docs/reference/make_rest_describe_url.html | 2 +- docs/reference/make_rest_objects_url.html | 2 +- docs/reference/make_rest_record_url.html | 2 +- docs/reference/make_search_url.html | 2 +- docs/reference/make_soap_xml_skeleton.html | 2 +- docs/reference/make_verbose_httr_message.html | 2 +- docs/reference/map_sf_type_to_r_type.html | 2 +- docs/reference/merge_null_to_na.html | 2 +- docs/reference/message_w_errors_listed.html | 2 +- docs/reference/metadata_type_validator.html | 2 +- .../parameterized_search_control.html | 2 +- .../parse_error_code_and_message.html | 2 +- docs/reference/parse_report_detail_rows.html | 2 +- docs/reference/patched_tempdir.html | 2 +- docs/reference/rDELETE.html | 2 +- docs/reference/rGET.html | 2 +- docs/reference/rPATCH.html | 2 +- docs/reference/rPOST.html | 2 +- docs/reference/rPUT.html | 2 +- docs/reference/records_list_to_tbl.html | 2 +- .../remove_empty_linked_object_cols.html | 2 +- docs/reference/return_matching_controls.html | 2 +- docs/reference/rforcecom.bulkAction.html | 2 +- docs/reference/rforcecom.bulkQuery.html | 2 +- docs/reference/rforcecom.create.html | 2 +- docs/reference/rforcecom.delete.html | 2 +- .../rforcecom.getObjectDescription.html | 2 +- .../rforcecom.getServerTimestamp.html | 2 +- docs/reference/rforcecom.login.html | 2 +- docs/reference/rforcecom.query.html | 2 +- docs/reference/rforcecom.retrieve.html | 2 +- docs/reference/rforcecom.search.html | 2 +- docs/reference/rforcecom.update.html | 2 +- docs/reference/rforcecom.upsert.html | 2 +- docs/reference/safe_bind_rows.html | 2 +- docs/reference/salesforcer-package.html | 2 +- docs/reference/salesforcer_state.html | 2 +- docs/reference/session_id_available.html | 2 +- docs/reference/set_null_elements_to_na.html | 2 +- .../set_null_elements_to_na_recursively.html | 2 +- docs/reference/sf_abort_job_bulk.html | 2 +- docs/reference/sf_access_token.html | 2 +- .../sf_analytics_notification_create.html | 2 +- .../sf_analytics_notification_delete.html | 2 +- .../sf_analytics_notification_describe.html | 2 +- .../sf_analytics_notification_update.html | 2 +- .../sf_analytics_notifications_limits.html | 2 +- .../sf_analytics_notifications_list.html | 2 +- docs/reference/sf_auth.html | 2 +- docs/reference/sf_auth_check.html | 2 +- docs/reference/sf_auth_refresh.html | 2 +- docs/reference/sf_batch_details_bulk.html | 2 +- docs/reference/sf_batch_status_bulk.html | 2 +- docs/reference/sf_build_cols_spec.html | 2 +- docs/reference/sf_close_job_bulk.html | 2 +- docs/reference/sf_control.html | 2 +- docs/reference/sf_convert_lead.html | 2 +- docs/reference/sf_copy_dashboard.html | 159 +++++++++++++++ docs/reference/sf_copy_report.html | 2 +- docs/reference/sf_create.html | 2 +- docs/reference/sf_create_attachment.html | 2 +- .../sf_create_attachment_bulk_v1.html | 2 +- docs/reference/sf_create_attachment_rest.html | 2 +- docs/reference/sf_create_attachment_soap.html | 2 +- docs/reference/sf_create_batches_bulk.html | 2 +- docs/reference/sf_create_bulk_v1.html | 2 +- docs/reference/sf_create_bulk_v2.html | 2 +- docs/reference/sf_create_job_bulk.html | 2 +- docs/reference/sf_create_job_bulk_v1.html | 2 +- docs/reference/sf_create_job_bulk_v2.html | 2 +- docs/reference/sf_create_metadata.html | 2 +- docs/reference/sf_create_report.html | 2 +- docs/reference/sf_create_rest.html | 2 +- docs/reference/sf_create_soap.html | 2 +- docs/reference/sf_delete.html | 2 +- docs/reference/sf_delete_attachment.html | 2 +- docs/reference/sf_delete_bulk_v1.html | 2 +- docs/reference/sf_delete_bulk_v2.html | 2 +- docs/reference/sf_delete_dashboard.html | 156 +++++++++++++++ docs/reference/sf_delete_job_bulk.html | 2 +- docs/reference/sf_delete_metadata.html | 2 +- docs/reference/sf_delete_report.html | 2 +- docs/reference/sf_delete_report_instance.html | 2 +- docs/reference/sf_delete_rest.html | 2 +- docs/reference/sf_delete_soap.html | 2 +- docs/reference/sf_describe_dashboard.html | 175 ++++++++++++++++ .../sf_describe_dashboard_components.html | 159 +++++++++++++++ docs/reference/sf_describe_metadata.html | 2 +- docs/reference/sf_describe_object_fields.html | 2 +- docs/reference/sf_describe_objects.html | 2 +- docs/reference/sf_describe_report.html | 2 +- docs/reference/sf_describe_report_type.html | 2 +- docs/reference/sf_download_attachment.html | 2 +- docs/reference/sf_empty_recycle_bin.html | 2 +- docs/reference/sf_end_job_bulk.html | 2 +- docs/reference/sf_execute_report.html | 2 +- .../sf_filter_dashboard_operators_list.html | 150 ++++++++++++++ .../sf_filter_dashboard_options_analysis.html | 167 ++++++++++++++++ docs/reference/sf_find_duplicates.html | 2 +- docs/reference/sf_find_duplicates_by_id.html | 2 +- docs/reference/sf_format_date.html | 2 +- docs/reference/sf_format_datetime.html | 2 +- docs/reference/sf_format_time.html | 2 +- docs/reference/sf_get_all_jobs_bulk.html | 2 +- .../reference/sf_get_all_query_jobs_bulk.html | 2 +- docs/reference/sf_get_dashboard_data.html | 11 +- docs/reference/sf_get_dashboard_results.html | 177 +++++++++++++++++ docs/reference/sf_get_dashboard_status.html | 171 ++++++++++++++++ docs/reference/sf_get_deleted.html | 2 +- docs/reference/sf_get_job_bulk.html | 2 +- docs/reference/sf_get_job_records_bulk.html | 2 +- .../sf_get_report_instance_results.html | 2 +- docs/reference/sf_get_updated.html | 2 +- docs/reference/sf_guess_cols.html | 2 +- docs/reference/sf_input_data_validation.html | 2 +- docs/reference/sf_job_batches_bulk.html | 2 +- docs/reference/sf_list_api_limits.html | 2 +- docs/reference/sf_list_dashboards.html | 170 ++++++++++++++++ docs/reference/sf_list_metadata.html | 2 +- docs/reference/sf_list_objects.html | 2 +- docs/reference/sf_list_report_fields.html | 2 +- .../sf_list_report_filter_operators.html | 2 +- docs/reference/sf_list_report_instances.html | 2 +- docs/reference/sf_list_report_types.html | 2 +- docs/reference/sf_list_reports.html | 2 +- docs/reference/sf_list_resources.html | 2 +- docs/reference/sf_list_rest_api_versions.html | 2 +- docs/reference/sf_merge.html | 2 +- docs/reference/sf_query.html | 2 +- docs/reference/sf_query_bulk_v1.html | 2 +- docs/reference/sf_query_bulk_v2.html | 2 +- docs/reference/sf_query_report.html | 2 +- docs/reference/sf_query_result_bulk.html | 2 +- docs/reference/sf_query_result_bulk_v1.html | 2 +- docs/reference/sf_query_result_bulk_v2.html | 2 +- docs/reference/sf_read_metadata.html | 2 +- docs/reference/sf_refresh_dashboard.html | 162 +++++++++++++++ docs/reference/sf_rename_metadata.html | 2 +- docs/reference/sf_reorder_cols.html | 2 +- docs/reference/sf_report_folder_children.html | 2 +- docs/reference/sf_report_folder_create.html | 2 +- docs/reference/sf_report_folder_delete.html | 2 +- docs/reference/sf_report_folder_describe.html | 2 +- .../sf_report_folder_share_delete.html | 2 +- .../sf_report_folder_share_describe.html | 2 +- .../sf_report_folder_share_recipients.html | 2 +- .../sf_report_folder_share_update.html | 2 +- .../sf_report_folder_shares_add.html | 2 +- .../sf_report_folder_shares_list.html | 2 +- .../sf_report_folder_shares_update.html | 2 +- docs/reference/sf_report_folder_update.html | 2 +- docs/reference/sf_report_folders_list.html | 2 +- docs/reference/sf_reset_password.html | 2 +- docs/reference/sf_rest_list.html | 2 +- docs/reference/sf_retrieve.html | 2 +- docs/reference/sf_retrieve_metadata.html | 2 +- .../sf_retrieve_metadata_check_status.html | 2 +- docs/reference/sf_retrieve_rest.html | 2 +- docs/reference/sf_retrieve_soap.html | 2 +- docs/reference/sf_run_bulk_operation.html | 2 +- docs/reference/sf_run_bulk_query.html | 2 +- docs/reference/sf_run_report.html | 2 +- docs/reference/sf_search.html | 2 +- docs/reference/sf_server_timestamp.html | 2 +- docs/reference/sf_session_id.html | 2 +- .../sf_set_dashboard_sticky_filter.html | 183 +++++++++++++++++ docs/reference/sf_set_password.html | 2 +- docs/reference/sf_submit_query_bulk.html | 2 +- docs/reference/sf_undelete.html | 2 +- docs/reference/sf_update.html | 2 +- docs/reference/sf_update_attachment.html | 2 +- .../sf_update_attachment_bulk_v1.html | 2 +- docs/reference/sf_update_attachment_rest.html | 2 +- docs/reference/sf_update_attachment_soap.html | 2 +- docs/reference/sf_update_bulk_v1.html | 2 +- docs/reference/sf_update_bulk_v2.html | 2 +- docs/reference/sf_update_dashboard.html | 162 +++++++++++++++ docs/reference/sf_update_metadata.html | 2 +- docs/reference/sf_update_report.html | 2 +- docs/reference/sf_update_rest.html | 2 +- docs/reference/sf_update_soap.html | 2 +- docs/reference/sf_upload_complete_bulk.html | 2 +- docs/reference/sf_upsert.html | 2 +- docs/reference/sf_upsert_bulk_v1.html | 2 +- docs/reference/sf_upsert_bulk_v2.html | 2 +- docs/reference/sf_upsert_metadata.html | 2 +- docs/reference/sf_upsert_rest.html | 2 +- docs/reference/sf_upsert_soap.html | 2 +- docs/reference/sf_user_info.html | 2 +- docs/reference/sf_write_csv.html | 2 +- docs/reference/simplify_report_metadata.html | 2 +- docs/reference/stop_w_errors_listed.html | 2 +- docs/reference/token_available.html | 2 +- docs/reference/unbox_list_elements.html | 2 +- .../unbox_list_elements_recursively.html | 2 +- docs/reference/unnest_col.html | 2 +- docs/reference/valid_metadata_list.html | 2 +- .../validate_get_all_jobs_params.html | 2 +- docs/reference/warn_w_errors_listed.html | 2 +- docs/reference/xmlToList2.html | 2 +- docs/reference/xml_drop_and_unlist.html | 2 +- .../xml_drop_and_unlist_recursively.html | 2 +- .../xml_extract_parent_and_child_result.html | 2 +- docs/reference/xml_nodeset_to_df.html | 2 +- docs/sitemap.xml | 36 ++++ index.Rmd | 45 +++-- index.md | 185 ++++++++--------- man/make_soap_xml_skeleton.Rd | 2 +- man/rforcecom.bulkAction.Rd | 2 +- man/sf_abort_job_bulk.Rd | 2 +- man/sf_auth.Rd | 2 +- man/sf_batch_details_bulk.Rd | 2 +- man/sf_batch_status_bulk.Rd | 2 +- man/sf_close_job_bulk.Rd | 2 +- man/sf_create_batches_bulk.Rd | 2 +- man/sf_create_job_bulk.Rd | 2 +- man/sf_describe_metadata.Rd | 2 +- man/sf_get_job_bulk.Rd | 2 +- man/sf_get_job_records_bulk.Rd | 2 +- man/sf_job_batches_bulk.Rd | 2 +- man/sf_list_metadata.Rd | 2 +- man/sf_query.Rd | 2 +- man/sf_read_metadata.Rd | 2 +- man/sf_rename_metadata.Rd | 2 +- man/sf_upload_complete_bulk.Rd | 2 +- revdep/README.md | 36 ++-- vignettes/getting-started.Rmd | 7 +- 345 files changed, 2934 insertions(+), 821 deletions(-) create mode 100644 docs/reference/sf_copy_dashboard.html create mode 100644 docs/reference/sf_delete_dashboard.html create mode 100644 docs/reference/sf_describe_dashboard.html create mode 100644 docs/reference/sf_describe_dashboard_components.html create mode 100644 docs/reference/sf_filter_dashboard_operators_list.html create mode 100644 docs/reference/sf_filter_dashboard_options_analysis.html create mode 100644 docs/reference/sf_get_dashboard_results.html create mode 100644 docs/reference/sf_get_dashboard_status.html create mode 100644 docs/reference/sf_list_dashboards.html create mode 100644 docs/reference/sf_refresh_dashboard.html create mode 100644 docs/reference/sf_set_dashboard_sticky_filter.html create mode 100644 docs/reference/sf_update_dashboard.html diff --git a/DESCRIPTION b/DESCRIPTION index da4adb6b..73b96fe8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: salesforcer Title: An Implementation of 'Salesforce' APIs Using Tidy Principles Version: 1.0.1 -Date: 2022-02-27 +Date: 2022-02-28 Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, Bulk 1.0, Bulk 2.0, Metadata, Reports and Dashboards) . @@ -11,23 +11,12 @@ Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, API documentation and this package's website for more information, documentation, and examples. -Authors@R: - c(person(given = c("Steven", "M."), - family = "Mortimer", - role = c("aut", "cre"), - email = "mortimer.steven.m@gmail.com"), - person(given = "Takekatsu", - family = "Hiramura", - role = "ctb", - email = "thira@plavox.info"), - person(given = "Jennifer", - family = "Bryan", - role = c("ctb", "cph"), - email = "jenny@rstudio.com"), - person(given = "Joanna", - family = "Zhao", - role = c("ctb", "cph"), - email = "joanna.zhao@alumni.ubc.ca")) +Authors@R: c( + person(c("Steven", "M."), "Mortimer", , "mortimer.steven.m@gmail.com", role = c("aut", "cre")), + person("Takekatsu", "Hiramura", , "thira@plavox.info", role = "ctb"), + person("Jennifer", "Bryan", , "jenny@rstudio.com", role = c("ctb", "cph")), + person("Joanna", "Zhao", , "joanna.zhao@alumni.ubc.ca", role = c("ctb", "cph")) + ) License: MIT + file LICENSE URL: https://github.com/StevenMMortimer/salesforcer BugReports: https://github.com/StevenMMortimer/salesforcer/issues diff --git a/NEWS.md b/NEWS.md index e4f6c340..72604964 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,18 +2,22 @@ ## Dependencies - * Increase the package's default Salesforce API version to 54.0 (Spring '22). + * Increase the package's default Salesforce API version to 54.0 (Spring '22) * Added a deprecation warning that using basic authentication (password and security token) will no longer work since Salesforce announced that all customers will be migrated to MFA beginning February 1st, 2022 ([link](https://admin.salesforce.com/blog/2021/everything-admins-need-to-know-about-the-mfa-requirement)). Many thanks to @klaw2 for highlighting in #113. + * Remove deprecated use of `dplyr::across()` and add logic to circumvent a + new warning emitted by `readr::type_convert()` when no character columns + are present ## Bug fixes * Changed the naming convention for dashboard-related functions to contain the - action verb - `sf_{action}_dashboard` (e.g., `sf_copy_dashboard`) + action verb first (e.g., `sf_copy_dashboard` instead of `sf_dashboard_copy`) + +--- # salesforcer 1.0.0 [release](https://github.com/StevenMMortimer/salesforcer/releases/tag/v1.0.0) diff --git a/R/auth.R b/R/auth.R index c76e05c2..f622f258 100644 --- a/R/auth.R +++ b/R/auth.R @@ -82,7 +82,7 @@ #' is on and where subsequent API calls will be directed to. For example, #' \code{https://na21.salesforce.com} refers to an org located on the 'NA21' #' server instance located in Chicago, USA / Washington DC, USA per this -#' Knowledge Article: \url{https://help.salesforce.com/articleView?id=000314281}. +#' Knowledge Article: \url{https://help.salesforce.com/s/articleView?language=en_US&id=000314281}. #' } #' } #' @examples diff --git a/R/bulk-operation.R b/R/bulk-operation.R index 3ae7d7fa..7b00fe39 100644 --- a/R/bulk-operation.R +++ b/R/bulk-operation.R @@ -25,7 +25,7 @@ #' @template line_ending #' @template verbose #' @return A \code{tbl_df} parameters defining the created job, including id -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @examples #' \dontrun{ #' # insert into Account @@ -339,7 +339,7 @@ sf_create_job_bulk_v2 <- function(operation = c("insert", "delete", #' for the "ingest" vs. the "query" jobs. #' @template verbose #' @return A \code{tbl_df} of parameters defining the details of the specified job id -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @examples #' \dontrun{ #' job_info <- sf_create_job_bulk('insert', 'Account') @@ -611,7 +611,7 @@ sf_end_job_bulk <- function(job_id, #' @template api_type #' @template verbose #' @return A \code{list} of parameters defining the now closed job -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note This is a legacy function used only with Bulk 1.0. #' @examples #' \dontrun{ @@ -639,7 +639,7 @@ sf_close_job_bulk <- function(job_id, #' @template api_type #' @template verbose #' @return A \code{list} of parameters defining the job after signaling a completed upload -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note This function is typically not used directly. It is used in \code{sf_create_batches_bulk()} #' right after submitting the batches to signal to Salesforce that the batches should #' no longer be queued. @@ -663,7 +663,7 @@ sf_upload_complete_bulk <- function(job_id, #' @template api_type #' @template verbose #' @return A \code{list} of parameters defining the now aborted job -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @examples #' \dontrun{ #' job_info <- sf_create_job_bulk('insert', 'Account') @@ -717,7 +717,7 @@ sf_delete_job_bulk <- function(job_id, #' @template api_type #' @template verbose #' @return a \code{tbl_df} containing details of each batch -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @examples #' \dontrun{ #' # NOTE THAT YOU MUST FIRST CREATE AN EXTERNAL ID FIELD CALLED My_External_Id @@ -1009,7 +1009,7 @@ sf_create_batches_bulk_v2 <- function(job_id, #' @template api_type #' @template verbose #' @return A \code{tbl_df} of parameters defining the batch identified by the batch_id -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note This is a legacy function used only with Bulk 1.0. #' @examples #' \dontrun{ @@ -1068,7 +1068,7 @@ sf_job_batches_bulk <- function(job_id, #' @template api_type #' @template verbose #' @return A \code{tbl_df} of parameters defining the batch identified by the batch_id -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note This is a legacy function used only with Bulk 1.0. #' @examples #' \dontrun{ @@ -1130,7 +1130,7 @@ sf_batch_status_bulk <- function(job_id, batch_id, #' @return A \code{tbl_df}, formatted by Salesforce, with information containing #' the success or failure or certain rows in a submitted batch, unless the operation #' was query, then it is a data.frame containing the result_id for retrieving the recordset. -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note This is a legacy function used only with Bulk 1.0. #' @examples #' \dontrun{ @@ -1198,7 +1198,7 @@ sf_batch_details_bulk <- function(job_id, batch_id, #' @template verbose #' @return A \code{tbl_df} or \code{list} of \code{tbl_df}, formatted by Salesforce, #' with information containing the success or failure or certain rows in a submitted job -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note With Bulk 2.0 the order of records in the response is not guaranteed to #' match the ordering of records in the original job data. #' @examples diff --git a/R/compatibility.R b/R/compatibility.R index 8ed2875b..f8632835 100644 --- a/R/compatibility.R +++ b/R/compatibility.R @@ -341,7 +341,7 @@ rforcecom.bulkQuery <- function(session, #' #' This function is a convenience wrapper for submitting bulk API jobs #' -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @template session #' @param operation a character string defining the type of operation being performed #' @param data a matrix or data.frame that can be coerced into a CSV file for submitting as batch request diff --git a/R/describe-metadata.R b/R/describe-metadata.R index 90538c92..be1d27db 100644 --- a/R/describe-metadata.R +++ b/R/describe-metadata.R @@ -11,7 +11,7 @@ #' @importFrom xml2 xml_ns_strip xml_find_all xml_text read_xml #' @importFrom purrr map_df map_dfc #' @importFrom dplyr as_tibble -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} #' @template verbose #' @return A \code{tbl_df} #' @examples diff --git a/R/list-metadata.R b/R/list-metadata.R index 7f77f569..e2c41a6c 100644 --- a/R/list-metadata.R +++ b/R/list-metadata.R @@ -11,7 +11,7 @@ #' @importFrom httr content #' @importFrom xml2 xml_ns_strip xml_find_all #' @importFrom purrr map_df -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} #' @param queries a \code{list} of \code{list}s with each element consisting of 2 components: 1) #' the metadata type being requested and 2) the folder associated with the type that required for types #' that use folders, such as Dashboard, Document, EmailTemplate, or Report. diff --git a/R/query.R b/R/query.R index 324e8be6..91ca3b38 100644 --- a/R/query.R +++ b/R/query.R @@ -23,7 +23,7 @@ #' @template object_name_as_col #' @template verbose #' @return \code{tbl_df} of records -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @note Bulk API query doesn't support the following SOQL: #' \itemize{ #' \item COUNT diff --git a/R/read-metadata.R b/R/read-metadata.R index bb5e9ed9..6f3ece79 100644 --- a/R/read-metadata.R +++ b/R/read-metadata.R @@ -10,7 +10,7 @@ #' @importFrom httr content #' @importFrom xml2 xml_ns_strip xml_find_all #' @importFrom purrr map -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} #' @template metadata_type #' @param object_names a character vector of names that we wish to read metadata for #' @template verbose diff --git a/R/rename-metadata.R b/R/rename-metadata.R index 63ecee86..7ee6d612 100644 --- a/R/rename-metadata.R +++ b/R/rename-metadata.R @@ -11,7 +11,7 @@ #' @importFrom httr content #' @importFrom xml2 xml_ns_strip xml_find_all #' @importFrom purrr map_df -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} #' @template metadata_type #' @param old_fullname \code{character}; string corresponding to the fullName of the element you would #' like to rename diff --git a/R/retrieve-metadata.R b/R/retrieve-metadata.R index 89981901..e0beb943 100644 --- a/R/retrieve-metadata.R +++ b/R/retrieve-metadata.R @@ -170,8 +170,14 @@ sf_retrieve_metadata_check_status <- function(id, file_properties <- response_parsed %>% xml_ns_strip() %>% xml_find_all('.//fileProperties') %>% - map_df(xml_nodeset_to_df) %>% - type_convert(col_types = cols()) + map_df(xml_nodeset_to_df) + + is_character <- vapply(file_properties, is.character, logical(1)) + if(any(is_character)){ + # only proceed if the data.frame contains character columns; otherwise, + # readr will produce a warning since type_convert() only works on character cols + file_properties <- file_properties %>% type_convert(col_types = cols()) + } summary_elements <- response_parsed %>% xml_ns_strip() %>% diff --git a/R/utils-xml.R b/R/utils-xml.R index 1d1998b4..08b9d9b9 100644 --- a/R/utils-xml.R +++ b/R/utils-xml.R @@ -102,7 +102,7 @@ xml_nodeset_to_df <- function(this_node){ #' \item UserTerritoryDeleteHeader #' } #' Additionally, Bulk API can't access or query compound address or compound geolocation fields. -#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +#' @references \url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} #' @keywords internal #' @export make_soap_xml_skeleton <- function(soap_headers=list(), metadata_ns=FALSE){ diff --git a/README.Rmd b/README.Rmd index 9e27156b..6bc619b8 100644 --- a/README.Rmd +++ b/README.Rmd @@ -20,7 +20,7 @@ options(tibble.print_min = 5L, tibble.print_max = 5L) [![CRAN Status](https://www.r-pkg.org/badges/version/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Lifecycle: Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![Monthly Downloads](https://cranlogs.r-pkg.org/badges/last-month/salesforcer)](https://cran.r-project.org/package=salesforcer) -[![Coverage Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://codecov.io/gh/stevenmmortimer/salesforcer?branch=main) +[![Coverage Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stevenmmortimer/salesforcer?branch=main) {salesforcer} is an R package that connects to Salesforce Platform APIs using @@ -69,7 +69,7 @@ Package features include: ## Installation ```{r, eval = FALSE} -# install the current CRAN version (1.0.0) +# install the current CRAN version (1.0.1) install.packages("salesforcer") # or get the development version on GitHub @@ -98,29 +98,32 @@ please feel free to browse the {salesforcer} website at https://stevenmmortimer. ### Authenticate -First, load the {salesforcer} package and login. There are two ways to authenticate: +First, load the {salesforcer} package and log in. There are two ways to +authenticate: 1. OAuth 2.0 - 2. Basic Username-Password + 2. ~~Basic Username-Password~~ + +**NOTE**: Beginning February 1, 2022 authentication via a username and password +will not work in most orgs. On that date Salesforce will begin requiring customers +to enable multi-factor authentication (MFA). The function `sf_auth()` will return +the error message: + +```sh +INVALID_LOGIN: Invalid username, password, security token; or user locked out. +``` -It is recommended to use OAuth 2.0 so that passwords do not have to be shared or -embedded within scripts. User credentials will be stored in locally cached file -entitled ".httr-oauth-salesforcer" in the current working directory. Also, note -that if you use OAuth 2.0 authentication then the package will automatically -refresh it so you will not have to call `sf_auth()` during each session if you -have a cached ".httr-oauth-salesforcer" file in the working directory. The cache -file is named that way to not conflict with the ".httr-oauth" files created by -other packages. +It has always been recommended to use OAuth 2.0 so that passwords do not have to +be shared or embedded within scripts. For more information on how OAuth 2.0 works +within the {salesforcer} package, please read the +[Getting Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) +vignette. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) library(salesforcer) -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") -sf_auth(username = username, - password = password, - security_token = security_token) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r, eval=FALSE} @@ -129,11 +132,6 @@ library(salesforcer) # Using OAuth 2.0 authentication sf_auth() - -# Using Basic Username-Password authentication -sf_auth(username = "test@gmail.com", - password = "{PASSWORD_HERE}", - security_token = "{SECURITY_TOKEN_HERE}") ``` After logging in with `sf_auth()`, you can check your connectivity by looking at diff --git a/README.md b/README.md index 46a1ed4b..c59acdc7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https:// [![Monthly Downloads](https://cranlogs.r-pkg.org/badges/last-month/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Coverage -Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://codecov.io/gh/stevenmmortimer/salesforcer?branch=main) +Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stevenmmortimer/salesforcer?branch=main) {salesforcer} is an R package that connects to Salesforce Platform APIs @@ -21,55 +21,55 @@ SOAP, Bulk 1.0, Bulk 2.0, Reports and Dashboards, and Metadata APIs. Package features include: - - OAuth 2.0 (Single Sign On) and Basic (Username-Password) +- OAuth 2.0 (Single Sign On) and Basic (Username-Password) Authentication methods (`sf_auth()`) - - CRUD (Create, Retrieve, Update, Delete) methods for records using +- CRUD (Create, Retrieve, Update, Delete) methods for records using the SOAP, REST, and Bulk APIs - - Query records via the SOAP, REST, Bulk 1.0, and Bulk 2.0 APIs using +- Query records via the SOAP, REST, Bulk 1.0, and Bulk 2.0 APIs using `sf_query()` - - Manage and execute reports and dashboards with: - - `sf_list_reports()`, `sf_create_report()`, `sf_run_report()`, +- Manage and execute reports and dashboards with: + - `sf_list_reports()`, `sf_create_report()`, `sf_run_report()`, and more - - Retrieve and modify metadata (Custom Objects, Fields, etc.) using +- Retrieve and modify metadata (Custom Objects, Fields, etc.) using the Metadata API with: - - `sf_describe_objects()`, `sf_create_metadata()`, + - `sf_describe_objects()`, `sf_create_metadata()`, `sf_update_metadata()`, and more - - Utilize backwards compatible functions for the {RForcecom} package, +- Utilize backwards compatible functions for the {RForcecom} package, such as: - - `rforcecom.login()`, `rforcecom.getObjectDescription()`, + - `rforcecom.login()`, `rforcecom.getObjectDescription()`, `rforcecom.query()`, `rforcecom.create()` - - Basic utility calls (`sf_user_info()`, `sf_server_timestamp()`, +- Basic utility calls (`sf_user_info()`, `sf_server_timestamp()`, `sf_list_objects()`) - - Functions to assist with master data management (MDM) or data +- Functions to assist with master data management (MDM) or data integrity of records by finding duplicates (`sf_find_duplicates()`, `sf_find_duplicates_by_id()`), merging records (`sf_merge()`), and converting leads (`sf_convert_lead()`) - - Recover (`sf_undelete()`) or delete from the Recycle Bin +- Recover (`sf_undelete()`) or delete from the Recycle Bin (`sf_empty_recycle_bin()`) and list ids of records deleted (`sf_get_deleted()`) or updated (`sf_get_updated()`) within a specific timeframe - - Passing API call control parameters such as, “All or None”, - “Duplicate Rule”, “Assignment Rule” execution and many more\! +- Passing API call control parameters such as, “All or None”, + “Duplicate Rule”, “Assignment Rule” execution and many more! ## Table of Contents - - [Installation](#installation) - - [Vignettes](#vignettes) - - [Usage](#usage) - - [Authenticate](#authenticate) - - [Create](#create) - - [Query](#query) - - [Update](#update) - - [Bulk Operations](#bulk-operations) - - [Using the Metadata API](#using-the-metadata-api) - - [Future](#future) - - [Credits](#credits) - - [More Information](#more-information) +- [Installation](#installation) +- [Vignettes](#vignettes) +- [Usage](#usage) + - [Authenticate](#authenticate) + - [Create](#create) + - [Query](#query) + - [Update](#update) + - [Bulk Operations](#bulk-operations) + - [Using the Metadata API](#using-the-metadata-api) +- [Future](#future) +- [Credits](#credits) +- [More Information](#more-information) ## Installation ``` r -# install the current CRAN version (1.0.0) +# install the current CRAN version (1.0.1) install.packages("salesforcer") # or get the development version on GitHub @@ -88,42 +88,48 @@ information please feel free to browse the {salesforcer} website at which contains the following vignettes: - - [Getting +- [Getting Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) - - [Supported +- [Supported Queries](https://stevenmmortimer.github.io/salesforcer/articles/supported-queries.html) - - [Working with Bulk +- [Working with Bulk APIs](https://stevenmmortimer.github.io/salesforcer/articles/working-with-bulk-apis.html) - - [Working with +- [Working with Reports](https://stevenmmortimer.github.io/salesforcer/articles/working-with-reports.html) - - [Working with +- [Working with Attachments](https://stevenmmortimer.github.io/salesforcer/articles/working-with-attachments.html) - - [Working with +- [Working with Metadata](https://stevenmmortimer.github.io/salesforcer/articles/working-with-metadata.html) - - [Passing Control +- [Passing Control Args](https://stevenmmortimer.github.io/salesforcer/articles/passing-control-args.html) - - [Transitioning from +- [Transitioning from RForcecom](https://stevenmmortimer.github.io/salesforcer/articles/transitioning-from-RForcecom.html) ## Usage ### Authenticate -First, load the {salesforcer} package and login. There are two ways to +First, load the {salesforcer} package and log in. There are two ways to authenticate: 1. OAuth 2.0 -2. Basic Username-Password - -It is recommended to use OAuth 2.0 so that passwords do not have to be -shared or embedded within scripts. User credentials will be stored in -locally cached file entitled “.httr-oauth-salesforcer” in the current -working directory. Also, note that if you use OAuth 2.0 authentication -then the package will automatically refresh it so you will not have to -call `sf_auth()` during each session if you have a cached -“.httr-oauth-salesforcer” file in the working directory. The cache -file is named that way to not conflict with the “.httr-oauth” files -created by other packages. +2. ~~Basic Username-Password~~ + +**NOTE**: Beginning February 1, 2022 authentication via a username and +password will not work in most orgs. On that date Salesforce will begin +requiring customers to enable multi-factor authentication (MFA). The function +`sf_auth()` will return the error message: + +``` sh +INVALID_LOGIN: Invalid username, password, security token; or user locked out. +``` + +It has always been recommended to use OAuth 2.0 so that passwords do not +have to be shared or embedded within scripts. For more information on +how OAuth 2.0 works within the {salesforcer} package, please read the +[Getting +Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) +vignette. ``` r library(dplyr, warn.conflicts = FALSE) @@ -131,16 +137,11 @@ library(salesforcer) # Using OAuth 2.0 authentication sf_auth() - -# Using Basic Username-Password authentication -sf_auth(username = "test@gmail.com", - password = "{PASSWORD_HERE}", - security_token = "{SECURITY_TOKEN_HERE}") ``` After logging in with `sf_auth()`, you can check your connectivity by looking at the information returned about the current user. It should be -information about you\! +information about you! ``` r # pull down information of person logged in @@ -165,11 +166,11 @@ new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n)) created_records <- sf_create(new_contacts, object_name = "Contact") created_records -#> # A tibble: 2 x 2 +#> # A tibble: 2 × 2 #> id success #> -#> 1 0033s000014AgdIAAS TRUE -#> 2 0033s000014AgdJAAS TRUE +#> 1 0033s00001BXHqaAAH TRUE +#> 2 0033s00001BXHqbAAH TRUE ``` ### Query @@ -177,7 +178,7 @@ created_records Salesforce has proprietary form of SQL called SOQL (Salesforce Object Query Language). SOQL is a powerful tool that allows you to return the attributes of records on almost any object in Salesforce including -Accounts, Contacts, Tasks, Opportunities, even Attachments\! Below is an +Accounts, Contacts, Tasks, Opportunities, even Attachments! Below is an example where we grab the data we just created including Account object information for which the Contact record is associated with. @@ -191,11 +192,11 @@ my_soql <- sprintf("SELECT Id, paste0(created_records$id , collapse = "','")) queried_records <- sf_query(my_soql) queried_records -#> # A tibble: 2 x 3 +#> # A tibble: 2 × 3 #> Id FirstName LastName #> -#> 1 0033s000014AgdIAAS Test Contact-Create-1 -#> 2 0033s000014AgdJAAS Test Contact-Create-2 +#> 1 0033s00001BXHqaAAH Test Contact-Create-1 +#> 2 0033s00001BXHqbAAH Test Contact-Create-2 ``` **NOTE**: In the example above, you’ll notice that the `"Account.Name"` @@ -203,7 +204,7 @@ column does not appear in the results. This is because the SOAP and REST APIs only return an empty Account object for the record if there is no relationship to an account (see \#78). +href="https://github.com/stevenmmortimer/salesforcer/issues/78">#78). There is no reliable way to extract and rebuild the empty columns based on the query string. If there were Account information, an additional column titled `"Account.Name"` would appear in the results. Note, that @@ -229,20 +230,20 @@ queried_records <- queried_records %>% updated_records <- sf_update(queried_records, object_name = "Contact") updated_records -#> # A tibble: 2 x 2 +#> # A tibble: 2 × 2 #> id success #> -#> 1 0033s000014AgdIAAS TRUE -#> 2 0033s000014AgdJAAS TRUE +#> 1 0033s00001BXHqaAAH TRUE +#> 2 0033s00001BXHqbAAH TRUE ``` ### Bulk Operations For really large operations (inserts, updates, upserts, deletes, and -queries) Salesforce provides the -[Bulk 1.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) -and -[Bulk 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/introduction_bulk_api_2.htm) +queries) Salesforce provides the [Bulk +1.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) +and [Bulk +2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/introduction_bulk_api_2.htm) APIs. In order to use the Bulk APIs in {salesforcer} you can just add `api_type = "Bulk 1.0"` or `api_type = "Bulk 2.0"` to your functions and the operation will be executed using the Bulk APIs. It’s that simple. @@ -267,11 +268,11 @@ new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n)) created_records <- sf_create(new_contacts, "Contact", api_type = "Bulk 1.0") created_records -#> # A tibble: 2 x 4 +#> # A tibble: 2 × 4 #> Id Success Created Error #> -#> 1 0033s000014AgfhAAC TRUE TRUE NA -#> 2 0033s000014AgfiAAC TRUE TRUE NA +#> 1 0033s00001BXHqfAAH TRUE TRUE NA +#> 2 0033s00001BXHqgAAH TRUE TRUE NA # query large recordsets using the Bulk API my_soql <- sprintf("SELECT Id, @@ -283,20 +284,20 @@ my_soql <- sprintf("SELECT Id, queried_records <- sf_query(my_soql, "Contact", api_type = "Bulk 1.0") queried_records -#> # A tibble: 2 x 3 +#> # A tibble: 2 × 3 #> Id FirstName LastName #> -#> 1 0033s000014AgfhAAC Test Contact-Create-1 -#> 2 0033s000014AgfiAAC Test Contact-Create-2 +#> 1 0033s00001BXHqfAAH Test Contact-Create-1 +#> 2 0033s00001BXHqgAAH Test Contact-Create-2 # delete these records using the Bulk 2.0 API deleted_records <- sf_delete(queried_records$Id, "Contact", api_type = "Bulk 2.0") deleted_records -#> # A tibble: 2 x 4 +#> # A tibble: 2 × 4 #> Id sf__Id sf__Created sf__Error #> -#> 1 0033s000014AgfhAAC 0033s000014AgfhAAC FALSE NA -#> 2 0033s000014AgfiAAC 0033s000014AgfiAAC FALSE NA +#> 1 0033s00001BXHqfAAH 0033s00001BXHqfAAH FALSE NA +#> 2 0033s00001BXHqgAAH 0033s00001BXHqgAAH FALSE NA ``` ### Using the Metadata API @@ -311,8 +312,8 @@ an object (fields, permissions, etc.). You can use the `sf_read_metadata()` function to return a list of objects and their metadata. In the example below we retrieve the metadata for the Account and Contact objects. Note that the `metadata_type` argument is -“CustomObject”. Standard Objects are an implementation of -CustomObjects, so they are returned using that metadata type. +“CustomObject”. Standard Objects are an implementation of CustomObjects, +so they are returned using that metadata type. ``` r read_obj_result <- sf_read_metadata(metadata_type='CustomObject', @@ -362,14 +363,14 @@ each field on the Account object: ``` r acct_fields <- sf_describe_object_fields('Account') acct_fields %>% select(name, label, length, soapType, type) -#> # A tibble: 68 x 5 +#> # A tibble: 68 × 5 #> name label length soapType type #> #> 1 Id Account ID 18 tns:ID id #> 2 IsDeleted Deleted 0 xsd:boolean boolean #> 3 MasterRecordId Master Record ID 18 tns:ID reference #> 4 Name Account Name 255 xsd:string string -#> 5 Type Account Type 40 xsd:string picklist +#> 5 Type Account Type 255 xsd:string picklist #> # … with 63 more rows # show the picklist selection options for the Account Type field @@ -377,7 +378,7 @@ acct_fields %>% filter(label == "Account Type") %>% .$picklistValues #> [[1]] -#> # A tibble: 7 x 4 +#> # A tibble: 7 × 4 #> active defaultValue label value #> #> 1 true false Prospect Prospect @@ -392,23 +393,23 @@ acct_fields %>% Future APIs to support (roughly in priority order): - - [Connect (Chatter) REST +- [Connect (Chatter) REST API](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm) - - [Analytics External Data +- [Analytics External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_overview.htm) - - [Analytics REST +- [Analytics REST API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_overview.htm) - - [Tooling +- [Tooling API](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/intro_api_tooling.htm) - - [Actions +- [Actions API](https://developer.salesforce.com/docs/atlas.en-us.api_action.meta/api_action/actions_intro.htm) - - [Streaming +- [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) - - [Place Order +- [Place Order API](https://developer.salesforce.com/docs/atlas.en-us.api_placeorder.meta/api_placeorder/sforce_placeorder_rest_api_intro.htm) - - [Industries +- [Industries API](https://developer.salesforce.com/docs/atlas.en-us.api_rest_industries.meta/api_rest_industries/intro.htm) - - [Data.com +- [Data.com API](https://developer.salesforce.com/docs/atlas.en-us.datadotcom_api_dev_guide.meta/datadotcom_api_dev_guide/datadotcom_api_dev_guide_intro.htm) ## Credits @@ -439,7 +440,7 @@ on the {salesforcer} pkgdown website at [Get supported salesforcer with the Tidelift Subscription](https://tidelift.com/subscription/pkg/cran-salesforcer?utm_source=cran-salesforcer&utm_medium=referral&utm_campaign=readme) ------ +------------------------------------------------------------------------ Please note that this project is released with a [Contributor Code of Conduct](https://github.com/stevenmmortimer/salesforcer/blob/main/.github/CODE_OF_CONDUCT.md). diff --git a/_pkgdown.yml b/_pkgdown.yml index b99c9fc6..68a7c20c 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -160,3 +160,47 @@ reference: - '`rforcecom.query`' - '`rforcecom.bulkQuery`' - title: internal + desc: Functions included for internal use only. + contents: + - '`collapse_list_with_dupe_names`' + - '`metadata_type_validator`' + - '`parameterized_search_control`' + - '`rforcecom.bulkAction`' + - '`sf_abort_job_bulk`' + - '`sf_analytics_notification_create`' + - '`sf_analytics_notification_delete`' + - '`sf_analytics_notification_describe`' + - '`sf_analytics_notification_update`' + - '`sf_analytics_notifications_limits`' + - '`sf_analytics_notifications_list`' + - '`sf_batch_details_bulk`' + - '`sf_batch_status_bulk`' + - '`sf_close_job_bulk`' + - '`sf_create_batches_bulk`' + - '`sf_create_job_bulk`' + - '`sf_delete_job_bulk`' + - '`sf_get_job_bulk`' + - '`sf_get_job_records_bulk`' + - '`sf_job_batches_bulk`' + - '`sf_query_bulk_v1`' + - '`sf_query_bulk_v2`' + - '`sf_query_report`' + - '`sf_query_result_bulk`' + - '`sf_query_result_bulk_v1`' + - '`sf_query_result_bulk_v2`' + - '`sf_report_folder_children`' + - '`sf_report_folder_create`' + - '`sf_report_folder_delete`' + - '`sf_report_folder_describe`' + - '`sf_report_folder_share_delete`' + - '`sf_report_folder_share_describe`' + - '`sf_report_folder_share_recipients`' + - '`sf_report_folder_share_update`' + - '`sf_report_folder_shares_add`' + - '`sf_report_folder_shares_list`' + - '`sf_report_folder_shares_update`' + - '`sf_report_folder_update`' + - '`sf_report_folders_list`' + - '`sf_submit_query_bulk`' + - '`sf_upload_complete_bulk`' + - '`valid_metadata_list`' diff --git a/cran-comments.md b/cran-comments.md index f900ffd2..fcbb7cfa 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -20,10 +20,10 @@ As such, CRAN archived this package. ## Test environments * Local Mac OS install, R-release 4.0.2 -* Ubuntu 16.04 (on GitHub Actions), R-release, R 4.1.0 -* Mac OS 10.15.5 (on GitHub Actions) R-release, R 4.1.0 -* Microsoft Windows Server 2019 10.0.17763 (on GitHub Actions) R-release, R 4.1.0 -* win-builder (R-release 4.1.0) +* Ubuntu 16.04 (on GitHub Actions), R-release, R 4.1.2 +* Mac OS 10.15.5 (on GitHub Actions) R-release, R 4.1.2 +* Microsoft Windows Server 2019 10.0.17763 (on GitHub Actions) R-release, R 4.1.2 +* win-builder (R-release 4.1.2) ## R CMD check results diff --git a/docs/404.html b/docs/404.html index 036f5dd2..2e77dbaf 100644 --- a/docs/404.html +++ b/docs/404.html @@ -153,7 +153,7 @@

    Page not found (404)

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 37cb2268..c98f91e1 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -124,7 +124,7 @@

    Contributor Code of Conduct

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index 164665d2..7bd77e25 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -146,7 +146,7 @@

    Code of Conduct
    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index b0970062..18ba3939 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -118,7 +118,7 @@

    License

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 23cac49b..a75e5c85 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -122,7 +122,7 @@

    NA

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/SECURITY.html b/docs/SECURITY.html index fc779537..6f276660 100644 --- a/docs/SECURITY.html +++ b/docs/SECURITY.html @@ -119,7 +119,7 @@

    Security contact information -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/SUPPORT.html b/docs/SUPPORT.html index af8ae5d3..9c651adc 100644 --- a/docs/SUPPORT.html +++ b/docs/SUPPORT.html @@ -123,7 +123,7 @@

    Getting help with {salesforcer}

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html index 6402b70a..73e34c62 100644 --- a/docs/articles/getting-started.html +++ b/docs/articles/getting-started.html @@ -153,7 +153,7 @@

    Authentication

    NOTE: Beginning February 1st, 2022, Salesforce will be requiring customers to enable multi-factor authentication, which means that basic authentication using password and security token will no longer work. The function sf_auth() will return the error message:

    INVALID_LOGIN: Invalid username, password, security token; or user locked out.
    -

    Also, it is a best practice to use OAuth 2.0 so that passwords do not have to be shared/embedded within scripts. User credentials will be stored in locally cached file entitled .httr-oauth-salesforcer in the current working directory.

    +

    Also, it is a best practice to use OAuth 2.0 so that passwords do not have to be embedded within scripts. OAuth 2.0 credentials are stored locally in a cached file titled .httr-oauth-salesforcer in the current working directory. The package will automatically refresh this cached token when it expires so you will not have to call sf_auth() during every R session if the .httr-oauth-salesforcer file is present in the working directory.

    +#> 1 0033s00001BXHrOAAX TRUE +#> 2 0033s00001BXHrPAAX TRUE

    Retrieving records @@ -214,8 +214,8 @@

    Retrieving records#> # A tibble: 2 × 4 #> sObject Id FirstName LastName #> <chr> <chr> <chr> <chr> -#> 1 Contact 0033s00001BXDqzAAH Test Contact-Create-1 -#> 2 Contact 0033s00001BXDr0AAH Test Contact-Create-2

    +#> 1 Contact 0033s00001BXHrOAAX Test Contact-Create-1 +#> 2 Contact 0033s00001BXHrPAAX Test Contact-Create-2

    Querying records @@ -235,8 +235,8 @@

    Querying records#> # A tibble: 2 × 3 #> Id FirstName LastName #> <chr> <chr> <chr> -#> 1 0033s00001BXDqzAAH Test Contact-Create-1 -#> 2 0033s00001BXDr0AAH Test Contact-Create-2

    +#> 1 0033s00001BXHrOAAX Test Contact-Create-1 +#> 2 0033s00001BXHrPAAX Test Contact-Create-2

    NOTE: In the example above, you’ll notice that the "Account.Name" column does not appear in the results. This is because the SOAP and REST APIs only return an empty Account object for the record if there is no relationship to an account ( see #78). There is no reliable way to extract and rebuild the empty columns based on the query string. If there were Account information, an additional column titled "Account.Name" would appear in the results. Note, that the Bulk 1.0 and Bulk 2.0 APIs will return "Account.Name" as a column of all NA values for this query because they return results differently.

    @@ -253,8 +253,8 @@

    Updating records#> # A tibble: 2 × 2 #> id success #> <chr> <lgl> -#> 1 0033s00001BXDqzAAH TRUE -#> 2 0033s00001BXDr0AAH TRUE

    +#> 1 0033s00001BXHrOAAX TRUE +#> 2 0033s00001BXHrPAAX TRUE

    Deleting records @@ -266,8 +266,8 @@

    Deleting records#> # A tibble: 2 × 2 #> id success #> <chr> <lgl> -#> 1 0033s00001BXDqzAAH TRUE -#> 2 0033s00001BXDr0AAH TRUE

    +#> 1 0033s00001BXHrOAAX TRUE +#> 2 0033s00001BXHrPAAX TRUE

    Upserting records @@ -295,9 +295,9 @@

    Upserting records#> # A tibble: 3 × 3 #> id success created #> <chr> <lgl> <lgl> -#> 1 0033s00001BXDr4AAH TRUE FALSE -#> 2 0033s00001BXDr5AAH TRUE FALSE -#> 3 0033s00001BXDr9AAH TRUE TRUE

    +#> 1 0033s00001BXHrTAAX TRUE FALSE +#> 2 0033s00001BXHrUAAX TRUE FALSE +#> 3 0033s00001BXHrYAAX TRUE TRUE

    Check out the Tests @@ -323,7 +323,7 @@

    Check out the Tests

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/articles/index.html b/docs/articles/index.html index 766da06e..7047f8cc 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -129,7 +129,7 @@

    All vignettes

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/articles/passing-control-args.html b/docs/articles/passing-control-args.html index 0f2124da..5efaf91a 100644 --- a/docs/articles/passing-control-args.html +++ b/docs/articles/passing-control-args.html @@ -189,7 +189,7 @@

    An example using the Dup #> # A tibble: 1 × 2 #> id success #> <chr> <lgl> -#> 1 0033s00001BXDrJAAX TRUE +#> 1 0033s00001BXHrdAAH TRUE # ... or succumb to the duplicate rules record3 <- sf_create(new_contact, @@ -217,8 +217,6 @@

    An example using the Dup api_type = "REST") #> Warning: Ignoring the following controls which are not used in the REST API: #> DuplicateRuleHeader -#> Warning: `type_convert()` only converts columns of type 'character'. -#> - `df` has no columns of type 'character' record4 #> # A tibble: 1 × 2 #> success errors @@ -300,7 +298,7 @@

    Default query behaviorqueried_records <- sf_query(soql) # REST API is the default api_type queried_records #> # A tibble: 10 × 3 -#> Id FirstName LastName -#> <chr> <chr> <chr> -#> 1 0033s00001844wZAAQ Test Especialização Presencial -#> 2 0033s00001844waAAA Test Especialização Presencial -#> 3 0033s00001844xNAAQ Test Especialização Presencial -#> 4 0033s00001844xQAAQ Test Especialização Presencial -#> 5 0033s00001844xRAAQ Test Especialização Presencial +#> Id FirstName LastName +#> <chr> <chr> <chr> +#> 1 0033s000014B3IZAA0 Rick James +#> 2 0033s000014B3IaAAK Rick James +#> 3 0033s000014B3IbAAK Rick James +#> 4 0033s000012Nd6FAAS Jenny Williams +#> 5 0033s000012NdARAA0 Jenny Williams #> # … with 5 more rows queried_records <- sf_query(soql, api_type = "SOAP") queried_records #> # A tibble: 10 × 3 -#> Id FirstName LastName -#> <chr> <chr> <chr> -#> 1 0033s00001844wZAAQ Test Especialização Presencial -#> 2 0033s00001844waAAA Test Especialização Presencial -#> 3 0033s00001844xNAAQ Test Especialização Presencial -#> 4 0033s00001844xQAAQ Test Especialização Presencial -#> 5 0033s00001844xRAAQ Test Especialização Presencial +#> Id FirstName LastName +#> <chr> <chr> <chr> +#> 1 0033s000014B3IZAA0 Rick James +#> 2 0033s000014B3IaAAK Rick James +#> 3 0033s000014B3IbAAK Rick James +#> 4 0033s000012Nd6FAAS Jenny Williams +#> 5 0033s000012NdARAA0 Jenny Williams #> # … with 5 more rows
    @@ -264,9 +264,9 @@

    REST vs. SOAP API query perfo ) res #> Unit: seconds -#> expr min lq mean median uq max neval -#> qry("REST") 0.3382863 0.3524484 0.4277162 0.3864768 0.5250205 0.5363488 5 -#> qry("SOAP") 1.3420408 1.3607750 1.3666050 1.3679208 1.3706192 1.3916692 5 +#> expr min lq mean median uq max neval +#> qry("REST") 0.4983136 0.5125766 0.6485466 0.5268722 0.6138641 1.091107 5 +#> qry("SOAP") 2.0455009 2.1894474 2.1916884 2.2099502 2.2191440 2.294400 5 suppressWarnings(suppressMessages( ggplot2::autoplot(res) + @@ -290,8 +290,8 @@

    When to use the Bulk APIs for que api_type = "Bulk 2.0" ) ) -#> Request failed [400]. Retrying in 1 seconds... -#> Request failed [400]. Retrying in 3 seconds... +#> Request failed [400]. Retrying in 1.9 seconds... +#> Request failed [400]. Retrying in 3.8 seconds... #> Error : API_ERROR: Aggregate Relationships not supported in Bulk V2 Query with CSV content type # aggregate query @@ -304,8 +304,8 @@

    When to use the Bulk APIs for que api_type = "Bulk 2.0" ) ) -#> Request failed [400]. Retrying in 1.7 seconds... -#> Request failed [400]. Retrying in 3.2 seconds... +#> Request failed [400]. Retrying in 1.6 seconds... +#> Request failed [400]. Retrying in 1.4 seconds... #> Error : API_ERROR: Aggregate Relationships not supported in Bulk Query

    The two queries above were trying to pull all the contacts for each account and then get a count of how many contacts there are per account. If you have a lot of records, using the REST API to return these results may not be feasible. Even though the Bulk APIs cannot handle the same query, they can pull down massive amounts of data quickly. In this case you can pull down all of the Contact records and all of the Account records and then perform the calculation using dplyr, like so:

    @@ -323,15 +323,15 @@ 
    When to use the Bulk APIs for que
                      `Contact.FirstName` = FirstName), 
             by = c("Id" = "Account.Id"))
 nested_query_recs
-#> # A tibble: 615 × 4
-#>   Id                 Name                       Contact.Id      Contact.FirstNa…
-#>   <chr>              <chr>                      <chr>           <chr>           
-#> 1 0013s00000zFdugAAC KEEP Test Account With Ch… 0033s000012Nkz… KEEP            
-#> 2 0013s00000zFdugAAC KEEP Test Account With Ch… 0033s000012Nkz… KEEP            
-#> 3 0013s00000zFdugAAC KEEP Test Account With Ch… 0033s000012Nkz… KEEP            
-#> 4 0013s00000zFdugAAC KEEP Test Account With Ch… 0033s000012Nkz… KEEP            
-#> 5 0013s00000zFdugAAC KEEP Test Account With Ch… 0033s000012Nl0… KEEP            
-#> # … with 610 more rows
+#> # A tibble: 419 × 4
+#>   Id                 Name                            Contact.Id Contact.FirstNa…
+#>   <chr>              <chr>                           <chr>      <chr>           
+#> 1 0013s00000zFdugAAC KEEP Test Account With Child R… 0033s0000… KEEP            
+#> 2 0013s00000zFdugAAC KEEP Test Account With Child R… 0033s0000… KEEP            
+#> 3 0013s00000zFdugAAC KEEP Test Account With Child R… 0033s0000… KEEP            
+#> 4 0013s00000zFdugAAC KEEP Test Account With Child R… 0033s0000… KEEP            
+#> 5 0013s00000zFdugAAC KEEP Test Account With Child R… 0033s0000… KEEP            
+#> # … with 414 more rows
 
 aggregate_query_recs <- nested_query_recs %>% 
   group_by(Id) %>%
@@ -345,7 +345,7 @@ 
    When to use the Bulk APIs for que
 #> 2 0013s00000zFgA6AAK          0
 #> 3 0013s000014jF2HAAU          0
 #> 4 0013s000014jF2vAAE          0
-#> 5 0013s000014jFj6AAE         99
+#> 5 0013s000014jFj6AAE          0
 #> # … with 11 more rows

    The second reason to not use the Bulk APIs is that there is a performance overhead associated with every bulk (asynchronous) job that involves checking the status of the job until it succeeds or fails before retrieving the results.

    The example below is provided so that you can take this code as an example to run your own performance test of queries that return 10K, 100K, 1M+ records to see where the Bulk APIs outperform the REST API.

    @@ -385,11 +385,11 @@

    When to use the Bulk APIs for que #> # A tibble: 99 × 4 #> Id sf__Id sf__Created sf__Error #> <chr> <chr> <lgl> <lgl> -#> 1 0033s00001BXDrTAAX 0033s00001BXDrTAAX FALSE NA -#> 2 0033s00001BXDrUAAX 0033s00001BXDrUAAX FALSE NA -#> 3 0033s00001BXDrVAAX 0033s00001BXDrVAAX FALSE NA -#> 4 0033s00001BXDrWAAX 0033s00001BXDrWAAX FALSE NA -#> 5 0033s00001BXDrXAAX 0033s00001BXDrXAAX FALSE NA +#> 1 0033s00001BXHrnAAH 0033s00001BXHrnAAH FALSE NA +#> 2 0033s00001BXHroAAH 0033s00001BXHroAAH FALSE NA +#> 3 0033s00001BXHrpAAH 0033s00001BXHrpAAH FALSE NA +#> 4 0033s00001BXHrqAAH 0033s00001BXHrqAAH FALSE NA +#> 5 0033s00001BXHrrAAH 0033s00001BXHrrAAH FALSE NA #> # … with 94 more rows # ... and finally delete the account @@ -397,7 +397,7 @@

    When to use the Bulk APIs for que #> # A tibble: 1 × 2 #> id success #> <chr> <lgl> -#> 1 0013s000019IzObAAK TRUE +#> 1 0013s000019J2otAAC TRUE

    Relationship queries @@ -414,7 +414,7 @@

    child-to-parent “lookup” queries ) -#> # A tibble: 513 × 3 +#> # A tibble: 315 × 3 #> Id FirstName Account.Name #> <chr> <chr> <chr> #> 1 0033s000012NkzwAAC KEEP KEEP Test Account With Child Records @@ -422,7 +422,7 @@

    child-to-parent “lookup” queries#> 3 0033s000012NkzyAAC KEEP KEEP Test Account With Child Records #> 4 0033s000012NkzzAAC KEEP KEEP Test Account With Child Records #> 5 0033s000012Nl00AAC KEEP KEEP Test Account With Child Records -#> # … with 508 more rows

    +#> # … with 310 more rows

    Sometimes you may notice that the requested relationship fields do not appear in the query results. This is because the SOAP and REST APIs do not return any related object information if it does not exist on the record and there is no reliable way to extract and rebuild the empty columns based on the query string. In the example below, if there were Account information an additional column titled "Account.Name" would appear in the results.

     +#> 1 0033s000014B3IZAA0 Rick +#> 2 0033s000014B3IaAAK Rick +#> 3 0033s000014B3IbAAK Rick +#> 4 0033s000012Nd6FAAS Jenny +#> 5 0033s000012NdARAA0 Jenny +#> # … with 73 more rows

    Note, that the Bulk 1.0 and Bulk 2.0 APIs will return "Account.Name" as a column of all NA values for this query because they return results differently.

    Finally, one aspect to note is that the Bulk 2.0 API does not support child-to-parent-grandparent relationships as seen in the example below:

     +#> # … with 388 more rows

    parent-to-child “nested” queries @@ -468,15 +468,15 @@

    parent-to-child “nested” queries ) -#> # A tibble: 516 × 4 -#> Id Name Contact.FirstNa… Contact.Id -#> <chr> <chr> <chr> <chr> -#> 1 0013s00000zFgA6AAK KEEP Test Account With Ch… NA NA -#> 2 0013s00000zFdugAAC KEEP Test Account With Ch… KEEP 0033s000012Nl0… -#> 3 0013s00000zFdugAAC KEEP Test Account With Ch… KEEP 0033s000012Nl0… -#> 4 0013s00000zFdugAAC KEEP Test Account With Ch… KEEP 0033s000012Nl0… -#> 5 0013s00000zFdugAAC KEEP Test Account With Ch… KEEP 0033s000012Nl0… -#> # … with 511 more rows

    +#> # A tibble: 320 × 4 +#> Id Name Contact.FirstNa… Contact.Id +#> <chr> <chr> <chr> <chr> +#> 1 0013s00000zFgA6AAK KEEP Test Account With Child R… NA NA +#> 2 0013s00000zFdugAAC KEEP Test Account With Child R… KEEP 0033s0000… +#> 3 0013s00000zFdugAAC KEEP Test Account With Child R… KEEP 0033s0000… +#> 4 0013s00000zFdugAAC KEEP Test Account With Child R… KEEP 0033s0000… +#> 5 0013s00000zFdugAAC KEEP Test Account With Child R… KEEP 0033s0000… +#> # … with 315 more rows

    At first glance this query may appear the same as a lookup query on the Contact object that includes the account id and name. However, the small difference is that every Account is included, regardless of whether or not they have a Contact. This can be helpful when you want to ensure a query contains all of the parent records and their child records, if they exist. Also, note that the plural object name is used inside the nested query (“Contacts” instead of “Contact”).

    Finally, a parent-to-child nested query can also contain a child-to-parent lookup relationship within it. Below is an example where the Owner Id on the Contact is included so you can know who is responsible for the Contacts under each Account.

     +#> # A tibble: 320 × 5 +#> Name Contact.FirstNa… Contact.Id Contact.Owner.Id Owner.Id +#> <chr> <chr> <chr> <chr> <chr> +#> 1 KEEP Test Account With … NA NA NA 0056A00… +#> 2 KEEP Test Account With … KEEP 0033s0000… 0056A000000MPRj… 0056A00… +#> 3 KEEP Test Account With … KEEP 0033s0000… 0056A000000MPRj… 0056A00… +#> 4 KEEP Test Account With … KEEP 0033s0000… 0056A000000MPRj… 0056A00… +#> 5 KEEP Test Account With … KEEP 0033s0000… 0056A000000MPRj… 0056A00… +#> # … with 315 more rows
    @@ -542,7 +542,7 @@

    Troubleshooting

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/articles/transitioning-from-RForcecom.html b/docs/articles/transitioning-from-RForcecom.html index 634e5ca7..3e8d7dc9 100644 --- a/docs/articles/transitioning-from-RForcecom.html +++ b/docs/articles/transitioning-from-RForcecom.html @@ -204,8 +204,8 @@

    CRUD Operations#> # A tibble: 2 × 2 #> id success #> <chr> <lgl> -#> 1 0033s00001BXDtOAAX TRUE -#> 2 0033s00001BXDtPAAX TRUE +#> 1 0033s00001BXHtnAAH TRUE +#> 2 0033s00001BXHtoAAH TRUE

    Query @@ -220,14 +220,14 @@

    Query # the better way in salesforcer to query salesforcer_results <- sf_query(this_soql) salesforcer_results -#> # A tibble: 5 × 1 -#> Id -#> <chr> -#> 1 0033s00001844wZAAQ -#> 2 0033s00001844waAAA -#> 3 0033s00001844xNAAQ -#> 4 0033s00001844xQAAQ -#> 5 0033s00001844xRAAQ

    +#> # A tibble: 5 × 2 +#> Id Email +#> <chr> <chr> +#> 1 0033s000014B3IZAA0 rick.james@gmail.com +#> 2 0033s000014B3IaAAK rick.james@gmail.com +#> 3 0033s000014B3IbAAK rick.james@gmail.com +#> 4 0033s000012Nd6FAAS jennyw@gmail.com +#> 5 0033s000012NdARAA0 jennyw@gmail.com

    Describe @@ -275,7 +275,7 @@

    Describe

    -

    Site built with pkgdown 2.0.1.

    +

    Site built with pkgdown 2.0.2.

    diff --git a/docs/articles/working-with-attachments.html b/docs/articles/working-with-attachments.html index e472f1e7..aef81322 100644 --- a/docs/articles/working-with-attachments.html +++ b/docs/articles/working-with-attachments.html @@ -191,11 +191,11 @@

    Creating (Uploading) Attachments#> # A tibble: 6 × 2 #> id success #> <chr> <lgl> -#> 1 00P3s00000gWmlHEAS TRUE -#> 2 00P3s00000gWmlMEAS TRUE -#> 3 00P3s00000gWmlREAS TRUE -#> 4 00P3s00000gWmlWEAS TRUE -#> 5 00P3s00000gWmlbEAC TRUE +#> 1 00P3s00000gWnCjEAK TRUE +#> 2 00P3s00000gWnCoEAK TRUE +#> 3 00P3s00000gWnCtEAK TRUE +#> 4 00P3s00000gWnCyEAK TRUE +#> 5 00P3s00000gWnD3EAK TRUE #> # … with 1 more row
    @@ -210,13 +210,13 @@

    Downloading Attachmentsparent_record_id1, parent_record_id2)) queried_attachments #> # A tibble: 6 × 4 -#> Id Body Name ParentId -#> <chr> <chr> <chr> <chr> -#> 1 00P3s00000gWmlHEAS /services/data/v52.0/sobjects/Attac… cloud.p… 0016A0000035… -#> 2 00P3s00000gWmlMEAS /services/data/v52.0/sobjects/Attac… logo.png 0016A0000035… -#> 3 00P3s00000gWmlREAS /services/data/v52.0/sobjects/Attac… old-log… 0016A0000035… -#> 4 00P3s00000gWmlbEAC /services/data/v52.0/sobjects/Attac… logo.png 0016A0000035… -#> 5 00P3s00000gWmlWEAS /services/data/v52.0/sobjects/Attac… cloud.p… 0016A0000035… +#> Id Body Name ParentId +#> <chr> <chr> <chr> <chr> +#> 1 00P3s00000gWnCtEAK /services/data/v54.0/sobjects/Attachment/00… old-… 0016A00… +#> 2 00P3s00000gWnCjEAK /services/data/v54.0/sobjects/Attachment/00… clou… 0016A00… +#> 3 00P3s00000gWnCoEAK /services/data/v54.0/sobjects/Attachment/00… logo… 0016A00… +#> 4 00P3s00000gWnD8EAK /services/data/v54.0/sobjects/Attachment/00… old-… 0016A00… +#> 5 00P3s00000gWnD3EAK /services/data/v54.0/sobjects/Attachment/00… logo… 0016A00… #> # … with 1 more row

    Before downloading the attachments using the Body it is important to consider whether the attachment names are repeated or duplicates. If so, then the attachments with the same exact name will be overwritten on the local filesystem as they are downloaded. To avoid this problem there are two common strategies:

      @@ -245,18 +245,18 @@

      Downloading Attachments= queried_attachments$Name, path = queried_attachments$Path) download_result -#> /services/data/v52.0/sobjects/Attachment/00P3s00000gWmlHEAS/Body -#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmpo0EfUa/0016A0000035mJ4QAI/cloud.png" -#> /services/data/v52.0/sobjects/Attachment/00P3s00000gWmlMEAS/Body -#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmpo0EfUa/0016A0000035mJ4QAI/logo.png" -#> /services/data/v52.0/sobjects/Attachment/00P3s00000gWmlREAS/Body -#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmpo0EfUa/0016A0000035mJ4QAI/old-logo.png" -#> /services/data/v52.0/sobjects/Attachment/00P3s00000gWmlbEAC/Body -#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmpo0EfUa/0016A0000035mJ5QAI/logo.png" -#> /services/data/v52.0/sobjects/Attachment/00P3s00000gWmlWEAS/Body -#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmpo0EfUa/0016A0000035mJ5QAI/cloud.png" -#> /services/data/v52.0/sobjects/Attachment/00P3s00000gWmlgEAC/Body -#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmpo0EfUa/0016A0000035mJ5QAI/old-logo.png" +#> /services/data/v54.0/sobjects/Attachment/00P3s00000gWnCtEAK/Body +#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmp6PB2EF/0016A0000035mJ4QAI/old-logo.png" +#> /services/data/v54.0/sobjects/Attachment/00P3s00000gWnCjEAK/Body +#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmp6PB2EF/0016A0000035mJ4QAI/cloud.png" +#> /services/data/v54.0/sobjects/Attachment/00P3s00000gWnCoEAK/Body +#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmp6PB2EF/0016A0000035mJ4QAI/logo.png" +#> /services/data/v54.0/sobjects/Attachment/00P3s00000gWnD8EAK/Body +#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmp6PB2EF/0016A0000035mJ5QAI/old-logo.png" +#> /services/data/v54.0/sobjects/Attachment/00P3s00000gWnD3EAK/Body +#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmp6PB2EF/0016A0000035mJ5QAI/logo.png" +#> /services/data/v54.0/sobjects/Attachment/00P3s00000gWnCyEAK/Body +#> "/var/folders/s2/1mxmzrg52tx7l0pg8lq1320w0000gn/T//Rtmp6PB2EF/0016A0000035mJ5QAI/cloud.png"

      Updating Attachments @@ -281,14 +281,14 @@

      Updating Attachments#> # A tibble: 1 × 2 #> id success #> <chr> <lgl> -#> 1 00P3s00000gWmllEAC TRUE

      +#> 1 00P3s00000gWnDDEA0 TRUE

      There is a function sf_delete_attachment(), which simply wraps sf_delete() so feel free to use for clarity in your code that you’re working with attachments use sf_delete().

       sf_delete_attachment(ids = create_result$id)
 #> # A tibble: 1 × 2
 #>   id                 success
 #>   <chr>              <lgl>  
-#> 1 00P3s00000gWmllEAC TRUE
+#> 1 00P3s00000gWnDDEA0 TRUE
 # sf_delete(ids = create_result$id) # would also work

      Uploading large batches of attachments using the Bulk API

      The SOAP and REST APIs are good for working with a few attachments at a time. However, the Bulk API can be invoked using api_type=“Bulk 1.0” to automatically take a data.frame or tbl_df of Attachment field data and create a ZIP file with CSV manifest that is required by that API to upload. In the example above, we downloaded the three attachments each belonging to two different parent records. Assuming that I have run that code and the files are in that my computer I can demonstrate that all of them can be uploaded at once using the Bulk 1.0 API.

      @@ -303,11 +303,11 @@

      Updating Attachments#> # A tibble: 6 × 4 #> Id Success Created Error #> <chr> <lgl> <lgl> <lgl> -#> 1 00P3s00000gWmlqEAC TRUE TRUE NA -#> 2 00P3s00000gWmlrEAC TRUE TRUE NA -#> 3 00P3s00000gWmlsEAC TRUE TRUE NA -#> 4 00P3s00000gWmltEAC TRUE TRUE NA -#> 5 00P3s00000gWmluEAC TRUE TRUE NA +#> 1 00P3s00000gWnDIEA0 TRUE TRUE NA +#> 2 00P3s00000gWnDJEA0 TRUE TRUE NA +#> 3 00P3s00000gWnDKEA0 TRUE TRUE NA +#> 4 00P3s00000gWnDLEA0 TRUE TRUE NA +#> 5 00P3s00000gWnDMEA0 TRUE TRUE NA #> # … with 1 more row

      NOTE: As of v48.0 (Spring ’20), it does not appear that the Bulk 2.0 API supports working with Attachments, so the Bulk 1.0 API must be used for bulk functionality.

      Finally, you are able to update Attachments with the Bulk API just as shown above in the REST/SOAP API examples.

      @@ -331,7 +331,7 @@

      Extending to Documents and O #> # A tibble: 1 × 2 #> id success #> <chr> <lgl> -#> 1 0153s000002btfWAAQ TRUE +#> 1 0153s000002bthmAAA TRUE

      With Documents, users are also able to save storage by specifying a Url instead of a a file path where the Body content is stored locally. Specifying the Url field will reference the URL instead of uploading into the Salesforce org, thereby saving space if limited in your organization.

       cheatsheet_url <- "https://rstudio.com/wp-content/uploads/2015/02/data-wrangling-cheatsheet.pdf"
@@ -345,7 +345,7 @@ 
      Extending to Documents and O
 #> # A tibble: 1 × 2
 #>   id                 success
 #>   <chr>              <lgl>  
-#> 1 0153s000002btfbAAA TRUE
      +#> 1 0153s000002bthrAAA TRUE
      diff --git a/docs/articles/working-with-bulk-apis.html b/docs/articles/working-with-bulk-apis.html index 593cb2df..a4d4267f 100644 --- a/docs/articles/working-with-bulk-apis.html +++ b/docs/articles/working-with-bulk-apis.html @@ -168,8 +168,8 @@

      Using the Bulk API#> # A tibble: 2 × 2 #> id success #> <chr> <lgl> -#> 1 0033s00001BXDtdAAH TRUE -#> 2 0033s00001BXDteAAH TRUE +#> 1 0033s00001BXHtxAAH TRUE +#> 2 0033s00001BXHtyAAH TRUE # Bulk bulk_created_records <- sf_create(new_contacts[3:4,], @@ -179,8 +179,8 @@

      Using the Bulk API#> # A tibble: 2 × 4 #> Id Success Created Error #> <chr> <lgl> <lgl> <lgl> -#> 1 0033s00001BXDtiAAH TRUE TRUE NA -#> 2 0033s00001BXDtjAAH TRUE TRUE NA +#> 1 0033s00001BXHu2AAH TRUE TRUE NA +#> 2 0033s00001BXHu3AAH TRUE TRUE NA

      A Complete Bulk API Workflow @@ -193,8 +193,8 @@

      A Complete Bulk API Workflow#> # A tibble: 2 × 4 #> Id Success Created Error #> <chr> <lgl> <lgl> <lgl> -#> 1 0033s00001BXDtsAAH TRUE TRUE NA -#> 2 0033s00001BXDttAAH TRUE TRUE NA +#> 1 0033s00001BXHu7AAH TRUE TRUE NA +#> 2 0033s00001BXHu8AAH TRUE TRUE NA # query bulk my_soql <- sprintf("SELECT Id, @@ -209,8 +209,8 @@

      A Complete Bulk API Workflow#> # A tibble: 2 × 3 #> Id FirstName LastName #> <chr> <chr> <chr> -#> 1 0033s00001BXDtsAAH Test Contact-Create-1 -#> 2 0033s00001BXDttAAH Test Contact-Create-2 +#> 1 0033s00001BXHu7AAH Test Contact-Create-1 +#> 2 0033s00001BXHu8AAH Test Contact-Create-2 # delete bulk deleted_records <- sf_delete(queried_records$Id, object_name=object, api_type="Bulk 1.0") @@ -218,8 +218,8 @@

      A Complete Bulk API Workflow#> # A tibble: 2 × 4 #> Id Success Created Error #> <chr> <lgl> <lgl> <lgl> -#> 1 0033s00001BXDtsAAH TRUE FALSE NA -#> 2 0033s00001BXDttAAH TRUE FALSE NA

      +#> 1 0033s00001BXHu7AAH TRUE FALSE NA +#> 2 0033s00001BXHu8AAH TRUE FALSE NA

      Query Limitations @@ -256,11 +256,11 @@

      Using the Bulk 2.0 API#> # A tibble: 10 × 4 #> Id Success Created Error #> <chr> <lgl> <lgl> <lgl> -#> 1 0033s00001BXDuHAAX TRUE TRUE NA -#> 2 0033s00001BXDuIAAX TRUE TRUE NA -#> 3 0033s00001BXDuJAAX TRUE TRUE NA -#> 4 0033s00001BXDuKAAX TRUE TRUE NA -#> 5 0033s00001BXDuLAAX TRUE TRUE NA +#> 1 0033s00001BXHuCAAX TRUE TRUE NA +#> 2 0033s00001BXHuDAAX TRUE TRUE NA +#> 3 0033s00001BXHuEAAX TRUE TRUE NA +#> 4 0033s00001BXHuFAAX TRUE TRUE NA +#> 5 0033s00001BXHuGAAX TRUE TRUE NA #> # … with 5 more rows created_records_v2 <- sf_create(new_contacts[11:20,], @@ -270,11 +270,11 @@

      Using the Bulk 2.0 API#> # A tibble: 10 × 7 #> sf__Id sf__Created sf__Error FirstName LastName My_External_Id_… #> <chr> <lgl> <lgl> <chr> <chr> <chr> -#> 1 0033s00001BXDubAAH TRUE NA Test Contact-C… Bulk-47774-k -#> 2 0033s00001BXDucAAH TRUE NA Test Contact-C… Bulk-47774-l -#> 3 0033s00001BXDudAAH TRUE NA Test Contact-C… Bulk-47774-m -#> 4 0033s00001BXDueAAH TRUE NA Test Contact-C… Bulk-47774-n -#> 5 0033s00001BXDufAAH TRUE NA Test Contact-C… Bulk-47774-o +#> 1 0033s00001BXHuMAAX TRUE NA Test Contact-C… Bulk-94075-k +#> 2 0033s00001BXHuNAAX TRUE NA Test Contact-C… Bulk-94075-l +#> 3 0033s00001BXHuOAAX TRUE NA Test Contact-C… Bulk-94075-m +#> 4 0033s00001BXHuPAAX TRUE NA Test Contact-C… Bulk-94075-n +#> 5 0033s00001BXHuQAAX TRUE NA Test Contact-C… Bulk-94075-o #> # … with 5 more rows, and 1 more variable: test_number__c <dbl>

      @@ -294,9 +294,9 @@

      Performance Benchmarks for Bulk ) res #> Unit: seconds -#> expr min lq mean median uq max neval -#> bulk1_query() 8.056473 8.165432 8.473470 8.304405 8.507582 9.776455 8 -#> bulk2_query() 6.841868 6.862247 7.280646 7.088433 7.542517 8.416911 8 +#> expr min lq mean median uq max neval +#> bulk1_query() 8.189368 8.670841 10.05203 8.987773 9.573661 17.76234 8 +#> bulk2_query() 7.033586 8.555408 11.25908 12.549040 13.558243 13.71369 8 suppressWarnings(suppressMessages( ggplot2::autoplot(res) + @@ -323,7 +323,7 @@

      Performance Benchmarks for Bulk

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/articles/working-with-bulk-apis_files/figure-html/unnamed-chunk-7-1.png b/docs/articles/working-with-bulk-apis_files/figure-html/unnamed-chunk-7-1.png index 956757c7d71e76c22cd9974102a1524dd026716a..f015a1f0af41862eb214648fcca9d74c449c6a26 100644 GIT binary patch literal 41338 zcmeFZc~p*V_%`}@y?6<|B$c5^L{gGUnhYr=MWbdKNt)-`T#_g$novozO7ln~O;Twd zG-#gZc^_B2>)ZR!y}ob%vDf-p%X+HkdG7lf&fz$Y^So}iOVZ+-Htg6yp-?tSoEMd) zP}bN`D66mivlf3*|Eo#^FKe|fh>PMC|7Oo-IOAo#$$4dS3T5|0@_&_Q*QhRqvWFre zdRpElV4&IlsgAC#$Vj-cd2oHy_3h4DnJ%NTr%!LmcOCWmu0yjbew(Q5WjC!$nPIY5 z-)zaGNK}75s4UO&Hg@e9X5~A3ADxfc+wv^Cecz%F0N{adGiz>Ph zk=amOMAzG_B0p^1|G)hK1&zM-rwn#@h#lYI5f)Tvbl69-(kLaQ#^A`L{AQa1Ev^ms z&xneCREfa=F9`0F4D)h!Uli@`52-ig7&UYqnX3!7aU5{Y6rN%VlRY$S?>N9je%4@` z_dWCG-vX`5er=KX=W(8rVaGZasP?wqUlUnlz{Ss>R$Wzh>*kMWw}^-c-BC4JK0(1< zLPA1Yw!}NmPw9@XI@9+fR(&T84Gk9$Pg1oUf1AhS$D(1fZmzDQqo&UH2G)_cJ32Zp z$0+*Rv8~IbJ*?On=NTW*#niwNk2{k~$H&L}1qEsJ_3j!`j8$Xk8r$bQG*lOV_Ig78 zqXMmHjjWSa19e-HRBlCto9C(~87MF^dpvo9X&v;Dj5nx>q~E>U!!9ekx{ALo1|P0gv96)R*e*<5htFc;-M0=y{f8;OGs#UlFAWd{CGL8mb?|CSTbMl z6jJGGmbS~=+Z$;F8BHvt(yvk_MiII2I~dHfH9x zSJ;2eE9c0wor}NnSS#Ld`a+oObIGuSz9qA~{Yq>;_<=hasq8X`Z%BAJE1Qqx#MG1+ zQkP`dR!2w2%Bm_Fyj$7WC=fC^Ie9K^Kt_gAr@ElI9f|%-M)MP~kS)K{9<7|595Ut0 z=|sgCMg2kjTXuGKKb&F|8*kWr9YUTSod_2ZD(CMGAo-}Tmy(;nOyIy&x>d&R8Uvof zq9ScAEoS4udCZS{PPyc-<}Y8qTtB|!!lL|CWVufYk~>q0VtaXbvypgI&8x~`we^|R zugdfmI$1^B{EgBNX^cKnVxP32TvgseQd>r7jX}Z8jLlTi4-&E zr#`ej{r&DsOG}y0Pg&o%9Ubh$Sp4;0og;_UpZahXOYX23vVI{_EV+-oUaV7g&A6i6 z)~LLh`7mu|+Mr?J{(~n=WOW+Lk8Q6{w!c3yF<~Kf@nV6D^IVk!M~#7{r-%sU#5aO^ z+9+~ywb~92f+TfoYinmT9bjek)yW3>40CdFoPY3AnXOy9_HA4o zr)1c7FG1h1r!{Trk=+Y5aZWrOscm=m^Yc-5{X^3C)Axqw1|6rH=^9gv0V3iBKL#2L z@bYfQ4$K=q!9qQF@IcGP<^*}s(a|Yfa=2w;aQok~AXPoa#{VDmq;M%DJ) z*54f+9nB2BpIkpvS9irpRo_{&I>N)1o}S*1_Io*Plb*I>4L+Me#x=l$`SeZNNl8l= zlAB3Om-kp3CFUmEJ3BZy1V@JsR@c_@g=`;mu)LXJeAsuFB*zu2xT1Ec{8OECcde-ypdU} z(9uf#%_YA|X2!Jda}M)ZMPS%%?gb0U15@RV2`?NMQ{lW3@~^mpk_PIA=AV~zDRKa58E}Z1zoWHp-#$2cB8&N2ipzZf!xCwPn%}X=_Wb3jnlWBPBw{Th zjaE~MxA3N2R?x$wKyC9|J3R`8=T9DWuVtX1aXEAY5WXm4mbC)=r-sXs`(x`-+VYuKuOO! zwtA?^D%tgAR8}JIi4*iblKZg(2pc5KY|+tQERQdzRywH^qu)5Rq;|L^Lv?$CRa{Vo zN_XVEULu2sn6_9>qGe0a{ba1r52x;RQiq(bV)eC5OiaXf?%46@&6_v;(*kFk%1!CE zuBNyI!a_aSq5|t?eHzPeS?7#Lr3Y#bmQ7(LWkte-*i=Vf-q#LX1b2zc42UXAx$`k& z<7xftFV+~D`|$O!-}uJhRYv>zTz=-_Y$@#%-Sm=E7DE*Zl3Mz!RP_5dR-~W(m^LL) zqKQA!W?LF%DJuc&UD^qPS#T$fe46UMO9Yp#EDyCa%7lmK0Ny7jyN65dJivVkJXKA~?x=Cod zi6(d^pLJ@^Heruttio00ofziXheHZF=4-Ypx6+o>tHP=o--X4RpBq<;^6fs%`OUGk zT=BAX?8l%e%h>iIjVz(sbAJh_ik4p49aOK}duLWLydotbE91FnvRQUwb-vo+-forq zB1(>3vx>9Uu~QZ0>nM~DQK8HxE{(~z8Us2Cv`oc3^3$@N8u@u^Yb^xss_kWGk14;j z6=}RHPt*3)PywftX@Ge-KiBc&+mJXFpAqUi(EWGjsiCK5H@orN{J}nXoB-^)bN?@x zbCTg-EhQWo>_6f(nU=>zmJ^jK%*V_4ismN!I~s1rl@-NiO*LG}adKQ}r^~5}>ej0T z_p@1^Z)Ni5z4di^c|vCSxYL+-F#BjJx%bryHqObvr=BZD(U$3PHw;c`2+3qL2U!Lg z8om(|7w?FSihWe(&sX##Mpe5eQekwVTSP=-I=!~w(>kV1)^NvDv!AG){{soO3!alVtoyJR8Ek9CzvNa^k98C8@bTo#6mYh8ddocV*vVIzHQllk z_$Jw?c}K09`NhnR-NUXsjZ&{gg!_dej0Vq^>bKvck#@NZrCl{%16qGe%W;iiX;rcmsEBy6-{a+>)$GoUZB zbLFzn<)q!*IkQhN+O*wPo-Q%yUTRw>;x}$8EwVU4797#{Tp7SvA&?DCe{Gy6*(Ro( z*k-(QRJGnIZKn|CWg)FJUPQd3sUdiz0>L_^cXF-&gOn1vNU5;Vc$Zd zq+zQI{85%}tXMMhLe8FTlFK;EmS_f)f z-fGweDPwdbkGhDbR*fb+&`PDrs__>0kbsg%|-^+hyHkx@C)Le@qHTUsK=`Oq#p=M91UQ-go|5NMl1e%S$t# z>9YUT4|cRdD6UYIv3VonJwKcy(lYlWrO-ELp)0jJ$X?6N?&MHv$CJ7b*Ukpm^+lKt zXHA!R7{RbNaY{S>4AQRRQBOy)w=_VEmZ1Z|VE+ z4BPQv0MVmgm9ovs)2OjeRY6l91>1-$=Td#d-#uEFBWvROiN5zC?G;M{6}hMC_?m)WmV5d1FAt$}6cNe+1xV8-2)n>HQ#@U<`7Dk?84YJW99ub={ls+@+ z>AZ{6<`b3PE>$+4_I*sV#gD&bT{@T_r7;;Ka}q+(ifBt=v-zpbq;)7xXG5onY2iB{_dM?QE7ey*4sSn#D^TX z%eM1bqLK4L2NP5Oj~I7&jdNvpvCi!YhjGW6C=FWJmOAm+#J^gIBbmp(clvTcW9v>n zqsPwkDbD^|MwZ5Wa~>l*oxxR51q0dL{@5N|6%8;$$n5; z&bd0>X-VOkw!7WCoIle9{kvt0b*tmFhQPG0ulkGH+TA;Ms(xEebwbE0Ttlb!?{t&7 zjNsC!r>CdmfOg_n2KM|Xy9M52iI8%tZChD_#sj(sta4T3YCHIHW-p402AF(aZ~h>v zp7kTO$ihf;qZ4LkUtZ+cP7_SuWyU|0JwHUx#N-KZ=IWX{TDWsx`?IU5a@$83&5HL5 z1P&J$pBEK0`^itt{(N%+l}&e)s=o)o&G4A^k%=>Es>z0K;euUpo&Zvc=0_?-{mQD)%6`?l$Q@B*V7pwI zZNSaX&wtY}dnD}&dtr&@(ilRNT$5dYjA`dHaWRnWn{ipZNFNL3!wcmBp3SYTIaT~R z-8*;hZth*=HLN>2{Cx%~(q`n-I%_+J4T^CZyFmqQPi#g;Ys}Bj7oJtOgK^G&je5vv zS6mz9dj(cp6QxvyCA7MEe}{eHSD(YE>WI`yW zdehdeTSu2wXAaxNZOqsDDpO{z)A5!7a;(Xz6dHAtc|2YrB0@5z&3t3)?|fdo&+{=H zho5PgfQwB#dEs_U%cD$1>sbT-1puWw+3k?P*B^M_nre~SGB#L3|CD`=g3^)qECnI_ zh@jdC1*VIWwMEaw85sb^+`)TodM{|E_vnsgoXiQ#dcDKrf#$!fC|9=t&j>H8+Z`(Z zA{FTTa5kkbXJ-2M|Imry_<={QO|UfcC;DLw=}JywrCGApW@cue4%;j*R4fZZwa{u# zw?=jAr z{9)_aS`#c`Y;4S!Yy|KTUlk~4wdEsGC{VW`;Rw;a$+QURI@!!xOG_)<^QGgC`*T3esrFv^`z%MvbHBviNRV_+*o*xSDwx545CqWX!qfdA-|H4y&B? zKr5M4pjkktxhpFx%RQ(lH}_P4Rl^NT{ELi}nOM()hq1#xX6Evf{n1%=YbsMR zyN=+!XPyo$nqL~REhO_KRtVddYi}Rt=Kpz*2Dp!D=_gZr;ZEaHrCDi^VG_#o>3~3? zJUwb%Y;IK_F)!wLmwYYn0l^UMb=sbRi4LFP@!-~}(=GPa>GzgyuVZv|_2Xvw4FK3P zc4X=Y+3KlTRGu@PtWm0<2MKi}_Z1rqw(S2=V2=1xm!Nwgvs-BRrRj2qr--oAV!vh) z65_|6w9H>Tac*(Wi~XZfnu~1N%ZtNBmEughNkYmPOm=lWG27{FZMT5G3EkA7GOfNW zzJeUdUItkHQ06wWFXRr|A_D|Jp0Ms^!GhF}Xk{7#jRNe4(ngU29exPT&CRthj8|yN zH#g}EkH3VG%@3v^-jGDdKdglPBS?CuaVA$`VIh%)%I6p7YIB~rx^@dsr%?s1RDlMJ zUo>xM$)gq#6khC=DRS4Ccng7$7*K&5YY@FAFxgn#s6Jwm!%QC26FC_n9@qdK0^Mez ziElGeIdf4qUVb}(~50C;ql zTG-}t#T)2mL6gz?=koVOy-iHdG`FoU(bx`CGxw9(F3p4#<^GDASn7bxhQa3?>x&pI zE6>ptOx9{L1urjjcbIzGH_6KAYw$IhoOJ+Gdh9JD%&)OLS6gA915QFP$1c)6gdn<9ah_?}tFF2DAll1C_k;WwP(SWyzj1*`_3!z7a^ ztm~e@ycG9%?}c!17bFqTmg9YsbFwnsE-7}CeLyt?>(VW6syU1nn3i%Cl`6}=Z3OIXAOwK{WF@5|pGKy%NHs=L&8l8^6gK6g7=hG- zyy@e@w~9p7%xby1ZUDWweB|abhh>m~DvsSs5%TR=B~4<)@lK0#J-xkvp#H|${0NjJ zecS71lgoVA_Wb(Qoa4uiZAHY|%-{KRrdV7!;q{JB6^=vZ9rYDXR)!594>2=03|cuL z5PQO|v@4UO$XBmA>#P}GHBic3@tC_p&^#iXD}1uQme6K8$AyO?3qLb8;TS;6^{W#} zIn-s*ofgOr|J)Mp&=os^EP4zB8*`mFaUx{XrcDJ1Patuf+R8cRjrEVt1v9PC`&)l$ zoXEx7Wp%BP2^ejgu=tP}T_G^j@7nbkFAgG9w*`i|mHPYp{gX7=e5Q&QTmm5jlInHk zbx}m;#3WR$kMDqtuQ!?avU{+*7_pJP`ZAQO5xzPx0eo<_Rwv( zuW-S3?!R6Dm_Xtj6pC_1HlHyFOKKcMaNJokSKk5JJRm^^x!bDl8d>X^pVZFuM7RgK zhHRC>l%f(NmZZ|WnmZr@-@9gP{ae(@G0(}EoR}!BgLq7;0)&!B%SK%BC=K~~rwERL z7>3=d?w`ci$CGD`Di}K|p9IJ0b_d^Nr_#$X?%!3B?7m61J`I%%C~K%MFfQl~3)Ekk zVyv#OPzjTLIqFn1%lHH8YR6*qywK4`PT$2ju<;VN){&nS61Q#{+pA^{-ZCyJ!kzx8 zn?#^(9B#5&sWwbszf^twI8izg+JF^=U&%&1Uw1fg?}g-6hPqPPCY{AJm1)VGw1#rU z&3cEasP3PEQ7cFN+pQWw&t*=l{mwo|u3PeJ`C@sEk9ktLk6-g)-V7!C@}#*$bN@*J zB~Pmsef=1Lg@NqB%FmUvpR3uQ-dBINn8J-}zm7R6p$PBlUw9!pRrYA;RyW_#lQ}Od zmEVSkhZk)?r^c1P{?fSm0`rH=%605mLZfF5c3m;5>)NnGV_E}PoRo|Vsy~5AG0<_N zYV`hoVt*mAzI64?D;()1>vfoRATJ%p$yS z?j%||ca>SyROR3{!kz(u0+^&M{QL7(h-sjR`JEAgGax4Ov?==bHi-pBsF7f>sIOYEe_K&7Rk z?thNnx_%3nc9Pcgc;A5aLzeMD{U}ZWB@Ml(V~vAT(LS%5_wP$Dxmc=n=dJnv9*21> zR^g*+L+988y7Bw3J#9<1$J(OD>FXdwwrk8EHPlB)f@|33NIY}&e>>i|9YqG{YbXdg zw2TR6$dx!+-))zT*hVTX$Buce%T=BcP*RQ8I@i)#D}u(KIvUg_+&{49bs-%J%GYH( zX4HI|zYWTXBE`K+zPfRj4t6FLSSPVpG$h?5mkp=;9*s??6X4={R%;UM=T}^mFls0u zEG&G}fh+7V!Z`#np=9IM>^5y8*XCM-7;w)8Y6s4f!j00))s$S>e@O{NT$jmZQ2NO9 z@A4eABkO?!V-25_>6@}dczJoXo!UdtoO278=05>3Eak~(&z@DJT1{csCM`-m z-%#Wv9XJqY2gbOtNAJSJ$J?x-3o23qCIyO6o1{CQ5}iD{yfnN#G{%MGoby!8n!#<> zV3X(L$3#AecE5==TPBsqTqD>Xk=3DLkNOn}>iK%!K+-`BYTrtW= z)5d6T)O~@wKLe8t!z{X;G&O@w=qXp3R<5!2kdNdnTZ6ifx=SnyM?XhMxi2In#P%OS z?4>sCC`y`lI0b7NHgd|Rsg>Vt9pZ(!gK3RVft_iam|Rj`PjOLa!P>jr)1iA!j0!ag zC@r9HZ)*$&CsK!MJ}b}o-~SXy7to(c-;AmkA#i2!mDlqD0Cy4A{5H5dH#hfjZc3sE zsZ_SslcFWn#HP)g#WXcF<=JQtKU(FYivj_Kvd*O-dixU_o&Ce8xiZe^EgCAASc_y- z;5Wo-4!dlKa2b{k;V3~r%vMGkEJ*?2w{`O)JWlNZFPT4o*P1rI4v9*rwk z$)u_=NCL-VhINhA-mvR);f*ZF%^ci&5B{*5T-HA3louyHsDk_T3f#2mv ztX1}zWb-7$Zi9v}ub6EdK9aWlZbLPNSWQm;XFh>F>=%)l-X=Pnv$l0NTyDEd{RGRu z-@cskL5&owT~>ormfkJ8|6^av%m3AwrmnHS$tY!fY<+V~V(A(Ek|+Iw#>s>1KQCdr zW19nG5*JoeJ_!DU3s7F1dUL5*sq!xhyJEVpjf=k>ef6t(b zPcLKh8Dgf^{L~;3o%WEDsLG?uZf;%ysIgYMBG12@j;=8u^s+ma$PQ`mR zhjc5a7^yETwk|I|emaeI1UEwN>=^OoI(0x^uaOX@#e?M{%L~_&R3K16*2zCdr@jsS zAog7jgvYd-2hXc9GPc?eXRT}twJ)(j=RIv}uI5-{6AJ;VccR~knfZzET+hr*kq9HY z9qcDF*X_2rL{w7JUb0e5yFeyqKN&y<{x9x5b(30fvBG;@Ux2b_}U9E7dn?kS=3Nac|1Cl-XH7gdL_%wa-pns;Ue0KIKMcM zO1{mIdGO9HTZr7|&XIl)1lp^VK$l}=z!ykijOck=wxB1ao%A?FtEL!z`6Y*nBNp+H#P~N=(jnLVN4{H}bzI^7)9hL}(*)coR+NGp@p5fHQ>(h6ii#R(;e1}OIYqODs zr%)1htl^~WX}pr4r4o2EJNnC{p2x+O2XVk?*g@%DDLm17e+hc;+XTq3N7TVl|_ zBI%{3uFj*C|4-K!@1jn5>o`~g+m#QmS#B&ZEzWiMYD!7}O>R?s@gNZKI|(VN>U=jE zk3mKuyY~ow2M(lLYiMZneGhYwM@36>r`$#IY0Ah4vNuxPmVNS=IV2M#xP#ZwFaD~sbVpxb zq(+tyv@XtR-xhn5ctzTaW+53>h zBM*<7=~icBvp<`1ifoD*DsWZ!)_#dkpFSDXCxm@*V+<(Jx?B+?x2L{;?#?mJU3socXaHR zkP)5@ZTNUY+w5)WG}?h>KOv*x~DYMD<;iQrs&)lAbATr2*rC7>=sM#fvq*noc(it%sVFZ{NOs;DB8! zoBaFN$S)Vtowg0X;<@=}qfHcHg)R?`D&L+vX+0Fca_H#MOMxdXkMURL)rMW5>lhpB zDzO}F;GwA^H=qR2!ZX_5JbLu#`}eR5`z5x!pF`8po2I5FDe1`(A5KjT_~Uby{Ra*h zKr8uU=_mGK=DBCJQyO_p+eO2|!!LNLe7yc9Jjm{Ar@V6aU`i`52d8?vJWeS6w^qNu zF^;6)TNkhG6?*3Wh6trNjRUM-ReabKWbvOxV*UE{4Ii%E{o=MVvhoMmxRFcw1qC;z z2I>o^a&NEh>g~Ou#cZBA`9rm^%hmOtj_Z0WA3e5uWfFeEj_IjCuSD`*zEL zy2`pGz!2S(#xklE|1n`B%PQsL<@Gi~E__EL?BUWg=5ta~I@#%#{gFCfyu3o;)HhLO z{k3)_9Guuh%;ViFKI0%QZSDOM7=;q>2nHn_RTIhAVv|>=k!}&;cH{SK?-4V-;k3MH z9ix&Y`F&D$9L1!kHDBX)NElSVf3|^^jYZ<5MbA^_efuu{c4?Efnf+@iI**__IHCum za3KK-RSn90MrM%%dCkr0_?0IaX;DgQC2*K*UztL@-K0U_3DYxP6TmZ(H)~_D2TmIH zgFLo&c9LFJLroFp-Q|DW;b|2K1B`X|spyVd52E0^w`x|JFaa}I|_U7!mjgg;J z=+6q@wqu8Z+1r3OQZJ81UJiM{a)^uT^8YQKg}+5SYx3PE{-g(8E50mgsi{4Gw!|l+ zCfm`zV=O_pL?@;3;_u}xj<8|fOi9(}^}k5NDt$Z|3H<%**L!Gax&+bRpw#<4Y`;Wz zd0r$vgC^mAC@i;d=^Vxppczazm@IkFQ& zUwW&;X&D)f44r3wJ~Xqo=EHm^KT~niyMNy;>~N*XlZo$7I1VR?vWX|7Io6GamF>up zi(Z&-WLw)+Z@DftBO@b&s&^joS%&q;{saOuX0o8_XjU8E#=vk$Vr+a|E?C%+jOG4= z2W*bOL0thzS~Rz_yBuZEl7XZ(6&atz6jUbS(WaR{6LZS)2* zE|G>z+eD|?F1nS}y>`Onkv#c%#DzB$L) zd3J8@m0vNxWzV-yshJ4v^@hCv&3ongyDtWwtnoYcTFhgIU6+rNlyqmnS6|LJESH3= zgF~j%(yYGu>fZ+bHyO_@EX74&Z(kO;wanRvn|;6uFbRX!>?~7$X67@SALiw+^wzor zkOX9M!Ix9>$MZvSj|Z{;C9SQk`J&}&yzbn+Tl4lDl{XE)2-?7}akLocEdKa^T-|%HG36#GoL8uz?HJrz*b9Nv3?>zr(Lp{Urk5v=~wQL7vZ&n%JWO!VJiwgyY$}u!FWPojm&$8&1{j)v^ zD_L%>T(~sPJH7X6X$ikmTvPZt_w8d76VF)&aV}K9Jb>$u-DMEBp$8v~L_>yTx-d^3 z5?pEZ#skH{A~{^$@p(Vn4npXLKzVC4b~j~@gyi}2-&Phz*m3SC&t12MjYqDoNB@jP zfQ;q(_^+~tEc+CeFL`-)BN!6g_*xyRW~^tH=7)WrKE3(}S6Jm`SW}9-IMh;KfB0}z zdmf3(2S;Jt+)U2KYZX+#zr0UE*1#YVr(tjW_l>g%DQSMqMzu4e9X=LMizd$0^ zGhii+CZO;(uw`tFV+LU>*Zp~#C2oyV~5Tc><#AmUY|bl^#^P}Enh!|nd0a~(P)hNo0V)KV|8N(Ve; zq2*A!0%tzXzh&tQnl`o7G_oD|#Yb1N8VkbEsaP5Yh6rMWb&NoGnORvErS4^nqV!HL zK6+sP{u`*{{CDYf?L!|vRT*pjwTz4CyFMEwd$ufP8K>-g1N ziZ{*P#3Z9;l~t=&d4;}ze-PeV{wL5!lO>kE4wIgP)9jbv;NaN7WAI#1P!NV&`s>%P zcT0=&I~&b^l~!W17o`B0h7~n&4&nE60YE+s$Srl++uM%=FKTDlPY)rXWV*SH97WHK zIq@5oLx&Ezt*Kox0bi23ShZ3bC+qct@plO?`7lY^EHp-9we#RF6BtHGS=mLekER`B zyM^qkJLSn2U82vBfp%sLXIH^G4@itnP5p4)vQH;zETpA=&EJ3bAWt1nhK(QeFVp+O z@)UonOaH8y$ z-`~ndKy>C%E%6wHgcT@g`#paJ>$^k~rsCrL&*sgFh(P<*Ip;;@2e{uEkdabY#mSpA z$mX64i;MduE?>U-uWf;laluvH9Uy?V=|NQc{oq`vk$n6zTU^>qz+sFS5Q8Az~gRi2eD*OAnYdg|!pp zj7z()xTr|n%VJ^16r@txDxOmSjR*g{8+)VbU0+jLV!V)c;l>!voR&X}R7!U26vwwLduyB; zxmh>`a+(By`ro%#CXwa>Uf=fVZVgFi=&!i}vhfU=!0pTLwYYev?6tgXW-qgY~r;soC3enxZZgQwu6^s9C&F@dqt$d0B zpF(5Gjh=6B5>(=Hwz)ofBs<)am1Oes%#&Y4i*eaS;;f5WUsA0`Rq0D^g^$-SOL&#( zRV~bp*MMa~ZaGKR@ZQQAI{%*J)I^ocP0%s|FdoM*FHPs{5VHH2Zao|ehds>0Q?bw{kv;d zG~l`cYz`+k;w<{A4@thQdVV1? z*iLD9HfCMZbDSv3q+O?7BO@mWA`BASF^8$#hLrD#} zvxX`X24>LkF#={$9wZcn0TPZAE*&UqVezp%SS0TG^XCFB6~LR8h_2*4G>CE)y3-zh zhX#KYbP6bfgFfff%zn7|lnglc20@W78G7+ow*C9>YZn(v7Sz4M)V!aUkkY~EEPsAp zQ&3QFh?iH<)YNniLeC`lWgjdc9bS2H+IFakKTyD08qwJYNeLj1cI(!+1Rr#rCC28m zi=-5a;8FJiW~2sNd;7x&5B9v6Ke1~w*mhs%7w@^n=~h}~TDTRomalb1dWkonaF7id z>#m49aPd_SBpW3xPeRW#GUij|#L_4U_aKGb{%egq8u=7r)#~YUY)0Qs4K+srwBA4z zPq&+lWa&kpwF>kwvbDg|L}((?%VA-1A)3&zuwFz$GAp0w&qH&T<}MKaI@(@P_T#Ka!rh?l5zIzJ4VNe%Zb`# z<~IKr^7<1U4qhlD?#Wp5#hX<(vHsYAH>ajBK_QHcj0eI>H3&O8mHcyPDE8^ofA8PB z*Mqg)KuukX!28_Gi}_*R8$?G5+^{w(E;|zWI&e)r89i&8$q9>rIxeIzjyz?@6mO7r zKR~QZK>)Zujj+#c}oEUuj>rWHE zfNi*9?&62W!3MOv%uNkOA=%voedY7XShHc!Ki>g7On zD}n3rK3n~um3pSlWpr@n$VVw2Au-2OaLl#-G6|qfVR&v!FGSl)ECcuBjMUWk@Qz5i z@F&QN@3aaYebI_P?}dLKZO8Sv+x2b|2i+q+GC5g;7R}cv&zuyk7a1a6b*FSzX$LmvTcb_*VjW@ns;ODCI;wg5KuF zN;m;&qd~(wcJa%i=T+X5QOM69_DU(%BfEXQk{R8!2ag;nqvzDfOl`64-c4W=puvFy zrD=Y5@yX5;ict!vQ`92JkOZ#n0M!lvuJ&TMEt&Yyipmi2nh_XE{3KW?4 zkac)&e7|Qly=uk(c12;l8>pz{Agpxt*)8UWLY;^}&k&TN)l?tIbq)adRAG(;#RLl3 zD|!)xfRl(fa4rhZqVX9$$vEvvT&?pu2DJO6#Wyg3koE%i3tq6p15$pkM>~p0{9Osx zr-smq7_w^h+Jl0EYDANke=EA)5!&dElNRp@)RpcLB!=lCcMuR}JBQkPcn`fc&NhAr z?ude&(RhS?;HBQA}drWjscREhRvR6D8rG72^z63&R z!gls6uMxJ-dws8};(_#gF-WlfN*dYp+`9sH6YrshMudoaN~Sw~JLk)xeq8tKHbSfe z%4dldJOC4=vwZd}P$gDRUCj)~%+&5b=u~Aji zX*LYMFh}|HaUC9EM|cST1&2pJe1!AzQXy3-f?tI7aLY-@xsP9Z$*Kf=K^XiVD#1|x z^ss7jG#NAK#LEBqogR!%%_)N~^3-Md#Sn^K&O zgE`UY@s~mVfXJUBfc3=sNaMi=ofc_yB)1h?ZrFD4^&z=;?~w=#>(B`G8m39lsYpyr z%@?T{Y?UB3LiM(7+ZGDo6S2asR*+M%52+5=j9lHsD0l_F=@lDn^dm}%6IxN-pNW|C ze&0{F3DV@TLU?C*eWLzOx!_M~D`7?nfaU(@&!6Q#TsmV`VD zdUgT8*~`Llv>jE2>!^LKz=_>Pq#!^^(=ajl@T(#?4oOjB#jtKQ9QW8Qpa?*EAe^Lw zgco@~zhRMx|B^82)!Ee*hFB$w?5UUCY)Euq$|+eOC)hK4*1}jxVI36SXy^q!2(Z76 zE1?`I{J25&!Ta~`A0jYC{+$#l(ck#+v5R(g=`Yxo->#wBUTl;Cm3|}-wW*1(hvSa!Kg(N$ zho4a>DVMSxY)Qu3yLWG49neq>fbim6f86g$9jiz)@1DTvwi`GKBbJ6k=I_b=0_r@^ z;HMD#$h~D_Yuk&%A5~BHp6whO;*fac?p_526fu+ql_>uJB6p{XAdo>yQc5vuCW%oy z6V~)f#5o(qCMl_h_NNJIFj)ufpM-0mDfw76e(eRwo=R}@kLKOdG*!glriZE{3t2sxXWgw;?(t8!kR z*Yu_#sMXqPvQMGRkLxU1Z|9|PChg42A!2jjtO!v@XsUiX#TP@r%~eO8L;;tQkJAwH zpyxUx{$$rP!h=j3P`W7T~mSH zuaayS0hN*KA2Vj)~opY}@(on!N98wfs zn$bRT<-;lHW!!}w?d{vPZ-2LW_sQ!+O=*ujJ^8ryV<2XCiHLv-j~xo?$T!6syNs@0 zeNB=h0?b!+){f(A;+l<=VAH!c7oA-^x%pwoyEt?0fzya;VmP>%4lVPpSm`9GA3#-P zV_^~fK3P*CU_BHKj3_jcLj!9c$Fb6zz*;1qhe`T89)*r~L?iPG$;t08hkSHib^=tQ zA&e%sK0we`7Jxx6!)ow2mIuM0Je6b5o>O@bsg-POQb|QYnSDErcl))gj~*EAfzN}c zKlgl@i}djI`5}_|o0^+FMiJ9)B3-CtJEURlZ)lyNxNs+4VYmDBQeQsFKw+>oM-yg% zwwMeS^<~GLTaCO#+eIxw7IK_?xb$xDjxpw)Sfpw80|&%F8!BZ)7DJ&AG+Q`A)t~(3 zZ`^mEPU9)+8td0TQ#fdIvEAeZ>d4VhQOLSWNJ!|3n{B`X*C29&#CB}#KrHV2_U5i$ zsoxtq4V%*dl1C5irR?GRaD{yX1OtRj=^()y?Ab4Xb5}~Bz)&A`zHFsEBrA%GC}A%_ zi_QU)S9DHbXvI&EvMrI52AeaKGOUNQbtBLcuYlv$MAN~iJ5JqE`+SJ11?ct$46Y$w z`ynJN`4F*9Nrv^Z&`%krh*2Tb6LAH}K!vYa2AFT6b$LnY!VC5hKEnIl>lu zKLvR|f4(h7Jwp*~ABiX+5QcTqvabhc?=pMK`m!D8Nho)ms1zqU(e@)Mp~!J7>|RGF zl;l)60?~u`bW^PcUlGL^!UTbl!DoKVzInVClE>gXXL%ZxFQ!q)Vn!(S8= z&c9Z#=CSCxG&$I)L_|BBMfAO1zMia6b;q}#_5;P$lr-y!8tQigxvOf;@4GRln&?YejrHV-$ zyt@GX_GqCoPw-GHDyOZ}AJ;>>0iUP>uOJFXl5y)&_E7ifMTDyzB2Jm{fuJvO*>jTE zR>ez~zTN7k$*%401Q#M*4;F}^+5=EcPMWsg`<$0IIoln4c+Z|TI4Ah$MStFlbR23& z3xiSacEnRUNPQIy!K5nuB8Zm)+_~>ZjQ`JVcM*XJyXVZFX+M%^Z({?c-%KS@&!fd* z{GzlBg`#r^V3pMS5CD}xsfl*72zP$;`0?>6i3=CxaEk8%7jyu4OJ95uqnz8;{qoUQ zxS+dAwY0SCBF`Ra``gRgdlKbUVsAjrHTDHUelkLG|%FjPRUpogzM{WQ5gH_=P18uN)lGg|Y+ z#i^eUne^&%KxtkEb>O39F{2fu9&BWI`x}ytPQjQhXGVTX&7MRW7fWjdG$MlJSAV`Z zpgt13NpfDjcH=iB#m-;9Ui?hfbY4tibY3tez#VP_aoOy|uCJ(VfT3CZ{CwYE*cKvh zFpC5-K=IKfw6Cx9bQt+3!Kd)pOh4&>6K}8vg4~Rt+SAdf`4RSswFt$Np$41MKT9Vbzs3*B!+XAvm=$_j2` z1>IJJdPyKLY7adx^@F~csM68VA>T8f?KO(OLJAq6oYz4F3BNFH_E=+p?Szb>|G06` zil8R1Sf;&}0$~??U$Bs0t=Vl*b&E|+O;y!UdUIwCw2;~4l(Iw6QxW?*fBw8?^<1r@ zW^&nSTX&hil2yiH_HYT#yos?;l;2-^a|WyN5_-)6&=y4dUMP@%3h=~+o5s4&NJ>7E z4i=6f%{)&@otawo)G3!BoA&iWI7ACw?JWjZ^l-}A8|y1Ie0-^;QrA**Y|n6aU~C(b z%-|8KD$w^nTzHOj(0$vWfm;FOUPnbZ^3t0-;BbZwtcRdBla?Ax7M%d5Rg>@)Ux*h_ zwU%==Z-V7|g+h5+dQr;<2965$k7xVDjo54u*qlrDkqSr*NHs)P;j^FYAqOJGB870~ zZKL879%R$VoY@^bzH|I26IvRccoO!{Anm!BfjUty_FIE1Zj_Dy7Iq2PhYun`LSVXtsnG(* zqBv`Q>W7F8{hHxT+uiq<1UvheS+%BErr$|{9+|R>lXMsfRfnh%>Tq`*wIoqMq=dXU zpbjEl0wSf|`Y9J78@7(a<`%F2N{0m+C(?D(>^k0uAj>sdsN-ED+noIuUOY!MCmRKf zchGrh!7CJ;{Cv8`#^q*@JJSeO8QL09;3R74f>u-ZWL!X&0|}zVjIgsi#}gnbyf6cO z$dw>U3QCNHuf(Aw02^-Dup#}%ZTmLGfY`RIX6J>S9nK*7>aDd|93QMk+D;RU85tl-6@vl-9IEODzv@FKMY^~N zxO~!K<^#5UFD!$|w;&+MN2y(o-6g)mPZ*3GvViMbO>@A!4jwwx`=Sf`6~7CAPq-(#N&4m>s78b^E$QII^(clBa`m8t1792G=m zr?a;=BGY!94S|8Q83;eekx&G>LctlnrEG=UhVfTA+uI?*U0aAwueoJBVBaykQ+qk1 zqIEjMbTO-V(7YV|67&_HTIuK?*n)%(r(Wes*xbrgPmTZLRtrn1jmvZ?_RS_yqsxwt zW>GoIz5T6yNri(N^L2*2;O`gFA5e01d8j$_MPj|-qbE-kk#%rb%!nvt2M-=B_ItY* zB?p{mOl)a}}X^xX%glFo#B_ zjf`dnI(Bw&>pezIsyarM@8Zj2=b&HNw8_N|7kMy`OVd~u6&1BsIkxoi&)T2P0GgCq z+$)DpR$%PY=+gAYp1h%=mS z52KwgK34^T&#}c#E>PBE)zaR=t9APp+gpf)=Vx$8SU9M4)d9d-Ffs*M*{yML3AYh} zcf`eEy5}RVAB(DCgE9nR*~~?PcLYzspdaosPMO+x%(F~S4ubYp8X6xzzxQw)-77kS zxIf{MAWlZh*0C^}(K-Go=U|cI zZLg%2MuLFW{q!e?jik_PC+;MfBHVt2pMN&U^Im^_VmNSl7kW2HTMr%%^=+U&5xjTW zK0Ubf644pH178`>>GVAS)W?$|t>*(EhKs|GAoR(hOt9ONK3j=z`{~A{o4#Zjja!8! zWbdxsWYjQS_$&jKkk#SXaGg@CjA-;p-eT3j6z{t=Bc>&=k3Q3N1Ur0Vb z_=c#gB_)TcXh`yON=r*)U@C0I3b?~hw;)UIpz0AjcdnOc@}$3t?I)fO`Vnm;F=}bD z*jh96TGQQdU*M2n4l2g+%UAh|^e%Wx9*77vwmlOl%BA&u_Q|q)~Y!a{sBU%h!WJ z&Yn!$c6@Vmc3#dXht{rl!geeaEe;V_sAe!THSEBIx4v8S|#NoX>JPJ5BS%rfCa|mO|IWkZj;l+c`HA{)Wi=}V+k+eGgee@gXcX@?EzSKFdUoa9$XF2=3dV+VaaO$Q$TO z!VAKB7-B!Y_$;1%+E41lxFzXi!z8`6opCFqy*%>pllK~B*Gx7B135@k`Z3T zRdHQ#hMdHVd=Mn>j>)cFR3uP?Uz-**^SF56*&m=w#<86ZYSty{?5yNR!QIILgv#_) z8GEbnwOVQ!)zd>viMRTc6LDnolRXZh6`*0|d0*zaOuw1udpT1>Y5g8o!E@Z|{dz1?q!7Qqn`Z1AY7dZ#Kb^d7kf*bpo~-vr z4tu7jtu%z`(}uC3A1*)8pvdm=m>6s$F!F zNEq?pc-H5lC%7ZR;oPwx%nBgE$a$IjukXH}^?rfDJa#uGVFzJNPyqbhN^BfD8ui@c zJ~7l($ywt0U|?JJtHCiB;5k;Y^Ta)neR%A~2XE$`yPwT$4W7mfVrkrqN=kGg4?rEO z53Vhyl-QTwzahQ0N5jGfUz?Tk!sFyp6Y=a`pBY#_>&CXOe_dX4SuGrrfo<6MW3wA9 zna3fN&;}2-wB}PqlN>qN!Z7+|4)b-HcW(9|3Mj-<%Ux@hY~HJ6vN(g`!<|Jr9}~Ox z+RW{zPoD<%MF-qj{O~08-}TIg=oWkW&FNgT_0Gbba9fhLaCt7*ITc?Y<)HO&Ols^< ze7&1HxPRc5q*edo3f492au?&%d5jQEa;TNW*&zZLNvO+5_uX!9AO9}qLUnH}N03sf z*;VBwCENLUSZUVR?0w>A4OhPt3||$u_~x3Bdf_3$%B(24)~5L40i<1g8K=#C3I%^1 z>mIzO@(lkOfpSw}wLDQt%vixxAY5@MKxUj)RXg>g^f0c*UeDoWv7lIOJ%{9RmOv z1^M}+aKe3`0Jq2JZ1dM#Dor(n@7kUCxn?Dg@vpYLCPOG+yc1rx?K+`5ZWR}pxGCb6 zE(q#=l?ad>>oae|46Z6v49y~VL9Il>LAU?m-F~=kz@i;=zhoHPG)SXxse>BQ!*bz% z^XP}*jq~`jX2qjt`Yszv(QpYFzy0uli%^xDr+gzv`TY6*u%j;z(Sr2USg5qnzO!0( z=-|Go;^W8T&@&W^`%nHDKE05OP??jVkBamHKRBKMWO~`piQ z{mOq@BvKL!xpmlw&~cmEdQI|a07knlF5mNRSHIHaJUg%(D<~9!PoB?if{{k-n9$_! zA=ld#M3L!*mxU@gf#X3rXE$~k{CM)XW=9VZ8?QTL3C~YtkvbiIbC2#{1^p<=#OSJ^|;ONZK-bebI+;4P49P9 z^pDTJCHZ54DODej}CqDrCzOodZWECw%`l?ZC4W$6U7xQ)*aF`{Qiy>`D;W1 z4RrG4d`N<)u25?bgWC6<`3q8f^7rEVy0KFzeo^x<^k~B{?u&GHAfR-8O=XeEj@wU) z{gPQ=?^9ywC%nknAqT33kCDyCPcKw7%p|9=8(QAt(JJ2WS$S(dUwX8ns82QIUymMF z^J*_e{Oq(fr66F*61rV!FbuzGom|$8;|W{i!UG=Iy5n#PRJe_#goOJIYGp?$m&x-B z@ta(qhG%2|#?yj~y*Yo(<~~M#m<1mL)k*u?Jf+(R9^C3BHpp(>x`l@1%&yfA@8i0q zusqIw)7YY5y-(?RVD_}$GR8G2L%LUFB}l>As7d|<=cc!1NZDt_pZ3CAacgZe#0vwf z8%bLb4p9_F>$8aDVjikh4!ysEaFit!$K!Rh?L(k83^{lIm|ZKME?I#tii1BJ(jBM1 z{)`cou4n-Q`(vMQ8G#+I(E-{U|^luCjHH4yivA?&Jhc^JZw}c z1mnbyhq1yPk-ZVxM4oCagc2c+`mq-X$VyAebsWZ0Se*2GPu2s5>(i2KG@WQTK5Hjn8`T?+-QZvx+f_5Y7X+5^)o%bXlM$!MtM5(T0Kc z-Jjmrz5>bJVS?CaZ;X+B@k^r?*+Q!=f>jnnI@O!U%;<-TKs9(LT!V0zVk|tXEuOV? z*fD}!@41>ry+%KaR1GC;z&pO+?37-Qjt`){|^YW!X`pZw_&o-Vni?~e!!6Lo_p zgNthSmF@u6Bfi!wp~f1l2Q3wakxm}T(_iXb4{JdH;zVLW0QZTxH}?%KqOSral(}Ux z`uJ(*QKLqYb?iy_UFkDAqK@RE_IFW1EJqjNTW z*|4D@Fo41>xYk@aUPPe&cowIga=g>F3cJ;vV-q`we2pC0ukSt|MdLQNhHHg6Z+xlj z=FlN4Kb%yjV6#K9x_e`L_xBXrp^6Nf)D%@I3qz_Rv4Cf^YT7fPE5*FV4eO09u3!6k zL0}IGR)AS!^s#%P@sZHPV#)z-8akXxNFa2oqB~Fp!V(qXezL{&D1?m0Qlq&gg$IXo zbNd07RAg>j9<6*@t6#@^QC$fbZ1_z_)9dhw0-+&tQ!+9#{t(NF>P-+G9J1B<_Jtf- zsV?D6#PNft^VGDn-vfyRzlFml6>*;XZ>hX?N{Kg%UK5W5m&0^nGeSRjnHwJ?3bUo) z`p2t93K$*KWHQi*UfV-3mJV=f+A!*cg{VU!9EBB4v1n=dqtVshJAWLZ1d#`4F<#+& z6`P0n0WRLer^=qN1EYp+k!85?#B!I>30x6^A1Yy|-;>kCKG*KU`puiCE?TrGsPD#W z+MRvRDHghV4N}Cp!&!Pg5%>y72wlJ6oZ=gG-NV@utRjRC`J4P$viC!8n}dM@SMpW}hJCg?}NHzJQRN)pW~c#m&-eAAUok&rO~A5#gZegtSKjBQo!L zvg6}rLo6l&To}7O7H;M?dnuT)XxCC?VL~$&UPz_2m8+clL&`1*LrL{nPGNRf{1d`n z)tVQtTR7m7QOtgO_Ec^y7dz{ns2S6#Rj4n6v7mhC>sxN**HSKho0#V@M((0eM5KPp}kt0F8Wr zjlQP$WbYP(Cfgl;Gd}o|RzGII;cMUCzuLCR#5o(!rYGurs%t{?oLu&_Yii~b<&)t* ztjkvarKg^)IN&p6UsSnMS*%U19ZdYy;(!-IfttmA6+DL>gU-eN2)MK5G`8&6anUGS zxtTz5RjYzm9XZc&a)-@;=eeR^B=QR;5OLu}*dE<5wvjwWmA~wSq-0Sv1Q5{pyDFuW z^BDnIM-ZK@bCSRH)>hW%;~BcS*R&txq2tJA%;8JLxGXwwW5t!G(i5|^s>{>m@$c#M z5~Z{-8Voax`39BABWiwcB{inXwT1Fwq2LgyBP#i;>2pNQr3tfD>(+DK`pMr)+9~}t zN$Y5G73DUYOV60Ib$I3R!$*$9E)+znTJ)>(b=xs2aYChqK&vKaOJwfjc>c^_F+r#v zFO(hixPCt~v-iZfy#)-&x-3;UP5|5ba-N$YElRwa(6A~|(y-&=; znO@4}jC3GhK+m|UZwSd1jd3Z%LlB)d)3(p)l% zCxur zPlU1dLzka4&%+SNc2B!9M*cW3U-r$&Ms96`9>Fq5Skf+KZ1{0PL+kL`i|DCb#II0A z&&lFD)TA_b40oI2*>EbAe#d#M`1}T6eYNK{W#&24Mi#G$W|$ zc_`jv3R{i#)2C13@(P+O*P`n3`~5DeU{m3vz&=KbbqOWAkM%G4?9TzqUrlQl)Kw!* zLLB(HUIy|rf#Iys$VM%&Qvd$%hI{Ro(3 zc=PV#ZoFPTU8gs80VQPN<~tsV6?1bL4&S=A^WRT==)pGD;Zw*;wo0d`$Z#xdAM3S; zy|D^_c_!I@SXrGtWm3wMCDUqK{~s@4Q``J3*PA)4TxULlg1?i6-=9~;^fKrY@b)Lp zgT4ks&}oL24B6O12?k16iN2F0CZK@EcJAC`(z`on_G~_MtrzH0IB6~3e!mpIG`S&F zo|wXiAB0ATz~iZYf!wpF{{ro`^)_wAd1_uwmr(>m6k6A|wNI0C5HJ$@4f)Y1+>Evr zp6TtvjJ@1UBrlm%m``mORU>s*M!vE$Rfeou;MQMRWn>!j5ey^{!_Jj47j1*wo}+D^ zHqXP_hKalGJh@6Te%lp8;~8E|Fiw*t-3`2XswKvMFUF=L(!UU`;G{Y(;{ z9{Tl{B_IW1$GN-1t)lT+Ep>$3dspM)(D^ zF=GvO8H-uPN+d8ASKsg`*b7mj)imyk2|Q+SbK~VDRktp<+ebZu4ZuaJT)5NjeskW@ z@ex`kqZME^`b_wxBcR|fOhM}2{rd+;DnV2gD*>7!!Ko)#*BN&2el_0? zDksQ17Yd1xGrewp!Dfk?+A!=4ML4o|s_`-`!0ynxXX#=b$(2~A)H1?BD(kv1@<=kq zcfI4s1iUyJLT|ZRgGDnNiEWXWLEZqL!U;-DpgyPK`ezlD!5dQ`EZ!&8Z#F))bA%hk z0cNF`!8?m9c*a6YX@o7W*e`didOMG0545r%cGE4oO)ZvB**VwN2V^382Jhb8TZ6W8 zfg07-tDF2pV2q?Xr*7!jQvaFTT_w-AjrjfFr22PE*|5}tk|8D**8TNCLbW{omgWuO zhZR@!L^?IbjSISVBH$`0N9h+8e}Vsi0rL5^N&cyfM4&m6?hFbCX%02Awkw@8ckV(6 z$ie_h4x`#$^E0wRNA4FF6Xpz`<3Tvm?08zO!wv3J$Q&gfXtW^oa3mkcy2%!=Sk+x>F_P1T8ejM5mP-b>c#@{+rfp4=bf3BYrSG0kF8X4pO&ga>59o_B-xn}e zSSD3X`*~YcftSV8A^l9YA2ug}kM-q%MQFQ&O5p~#tFiQ2!{7f_7s-v~4!+C^pVS3X zz)C9)6wI~LbjP2D4qN$~c`oi0c>TJq=h{=A@fVGnHoXJ=<9?GaJqNr(=S?T4EWrdJ zLl(48i;F!UWh?Wc1Ai8D&~h4eRQ5>+GmS0Y4tOZTtENWQb3A2kNm_wcE!T>Vvo1{B zQ~KFASb&`%Xt%3ZeXcGS&aaR4Y!~35uKFuO~T+k9;E%Esd)8cAa(lambDdr4C_(h~>QrLW-}OVxL6{VO-% zoz!aT6L`I)8S9^YA%k=-E(F!LH+2m(A3-@y9B>G|(HTKvfwk|8tg#U9(WXiRaMDd# zqP4a_XYs;ogLm#cD(#7qe^XcTb1&9)S-njSVfhjZ=-Ik;t^J`7NOF-Bp4u>y56y3h z(Sx^_$N9a=r5H1W;rM5je_pypS-FhuP(X8 zD?hNFU>=E?RU3wF^-}eR2Sl;q>k zG8|;|;GN~;u@Iuu^zL1CLBLJjD(Tk)L>#<<_1Xb5UjJu#AUwQ-EYnIO$MfTHk!r)} z#-0KkJXiZI2i3}+l@L?JG^rhG>f#B6?{kB!c)KH-g197NX_VOy<%NR#^VpG*2uxuiQMrbx*htd4au7V5|&=0U#Q-6iq4GG0N+ zwskSXvb}_*vwor)^8!6KME2QEd| ztx%ZMPAxlNo)H=fzlip{NA3_}%FTSc{lI9Y5WxRG!@8%7QuzcPzP7uE>fkid>?HP? zkDz4(+k|824Ku2NFsOTtR+u{M>IeS0jWNoF<$zP9+S4wre7AsNDJ6f*wY2|&6=1g4 z)vX91Uri+SH)?bUV#OOBcFGrwp7q=;(o8^DSx#M9x?HUAmC~H)AsTD{<-9QyS3-&p}LlwY?YdL$O%;X4*>X* z2cWXbjAtNCbY`4T7`arw7pML&u~LL0_p0_ixai%Bj*O`p-RsYE*A&oo)M zn8QIQSMu#bLbh)|By%owGABly;*D#|hk)knyd*=wu*iyqp9m;N*wPN6&r78(rjxn% z7~AC^8g}+e`sZt;;(Xg)+?kjQ^fkM8?{433_OHyzaP^9KxTT}{;dW+oL(8DhxBdTE zI8oUi1As)8<;ABjSHJeuhCw1PxOe8^kUuv3;{|Z@j?Zn~vucEKh?O*^D^ZkGwea4V zL)T8oI;v_vXDY3;V%ElRXsKncq{s%-bT2=r>&&O%iQXkJVM~WdW$BG1)w~@76)!M6 zqk@?c)8N!Dm`?tUDb-e~h2plyve>$Zf{{PUw4y-!g)}*Vl;+-SMm3I3e8FfE>0j3M zs8SOd96BNcqwlJ^9iiE=7a= zcA)3{(D}xm;CXb=NwG@B_IBawAEA97FBAp_lR+g-?onKT0k$Y+yoh>iNpAQIpkF(&h_)Izkh-AY)_iiPJ^RNR21JJ1x+ zE{!U$Uet0&Nv&k{g1_dcvZT0_))*_3GaO zE)HX)wD(LX3BrPK6hEW0(BP0X%L>!m`E-Em5^Kr!?b`(z3W1_H4cK8q{#l0c?x=Ay z;+9Ism|8>jXNgM7%k8Q02_x5Pnb2MqvLz=i8L|(q{=yKE72xeQT$Tx7`3cJA$kC-K=tx zPbk2+T6jJ@Z|ju+d-En&O*fb}Rz22}W?Fcf?P@WBG3HN*jpCArKAAG}P8){nuUEHj zSMtXMmitixN^_+qi?A<(2`ty6zjosXY<@k6QlN?Xdcrq1+k;3@w zkZ&GO#kg|>Q-xTn@>W-!y5ps{$wi5QZ2!QCa;B7D|8u{UyEyqxJyoI+1opGc10hOm zM8ly3e>_a&FPXfR#hb*!0s~cYx!sM8tvRaNF!Cp2Q>NV4VA@0Qr&&<>wMgmJ{2%;nYUWGA zZKTYjBYI5|t0=OpSVAxi$Pf()gLg_)Tc^{8NvnJmnqP06W2qv(smCV955yyg{>_gzee zEm02uVS*69yDM$E>S_GdZ=Stj6jT+Hq%`VhO zaZ?iKJ!0ZRv+CV7c>b)rnb{PW*1Onv(&tDU%J~I5qzV!~51*0An~QFbY`86cb` z1W>>Gug%QNm{(@nF6a;*3h5NX4Ir~(P?sZ!r@o0ZwALJqagm(7%6n{Y+J_&h};Z&)kk33b^vS2Q8ql zk>O-QWc&Ejn<}UmTZ-rmV&In1VpAs^yeG9Y$G7*}4`SHCy10y1T`_qTmg4W8Pa_&_ z4tGI!6f!1I;`|Lw zTgFFLypbEMf2UsHIzbWI(rU9(-G~+pf&VbAN76UDOkC(S->@O|f-$`q7BB9>`~2Wj z?~yA83vC$GTtRFi<)Jn@x#O1s_xWUDNh2sB#d>+iOO+;l6xx=ZI_-OAa%1JY=Z9GI z4c={rr&vFG;{^EYyd3u39eGk2BYNqBWA4)16D3^8EFU=_?b@}I!M|XplUwv!M&>xL z%+L*N@^|#Ccy^AIpIP!gIE$F|n>J;GE|-FP(b_N0zxqYz<@yJj^{$%qwf>7eppI9| z17Z%U*%d!*;fNQ((+={q@Ix}o-|+P`Sx*LeZd2)y?l0T8MOskNB*p!40ZD`^ zh=P9H3I^rVy}LPoiyr6qa{X6J-`xCHQ-TM(m6$ZeKk5OVJzQL`pNt9gWst~@u(U@V z4W4D{nK)g1ynRAoCqfctV=KIHwrp8!p>E66N#9BhOjH@Swe!AW6TNyae|yJ*5RG6I zg<`=?Ba4Z^eOO!@AWxYFK#P{=GP|UH%gueCDT@Oc;3!T%7&e&~!7Bk%kZdq2-(l*C zj6o4AAm8+K+~lOs^V$Z5eeTe($h)*d_r`ArNDl!9rj~Rl!W76{J78eUkk*gAq>BTt z^bY*5*u`HC4$QfcnyL-1PD`TlwHMP4Z_@SP;PfJFiSd}vk+HSHIK@2)>R@Eu#BbNW zo4K)|Rf`*@O(c|P!x-d0B93>Y(~)8VPsDiSA|9hX3R^HmG$G7U$D4TRM_?~cN|(Y= zeFFZrb4mlhND{CdYH1Laz6Zjhi1{IxzUbWR1m{~EVf-_m!+1t=wsDQwd#szsskjYh z#GMD&vVFy1A}3IL9?3d#<`=upJcu0{a#0o75E9cGhm7}-eHG55Xkh8Eig@uCE^7$< z=l25xLsBa?`%x0WyObtuA9eG9H3&QR$bFS3%$D@YqN!PF8T&tK?AWmmtH(BSJ<9Gd zAd;}9|HO0UmlCIoKd=T9pW_+VpVSNRq-@G;e88*3W!cj~<5m(AWX>B`e`Cs7)oIt5 z+P&Y;e9g~qn)>E9NLWh%5l17nz4XTT@4Cn^rVurJVe;(~RT>8oYuN&JnM^Zs_Ah8f z(wyF@@!R%6ZZ`_N3*u|MivqO_Svrnpfh)yqo%_dgI=5)c5aZV=^8@?%5r9VbXCZd> znf@ct$0KHFUf$215;(-)Hfdb_1ZOOD`Wg(RW22VQ;VSLTh$72!m*w~mY3~{fYdN2< zk1NWs&q-TyrJQzDh0#TtU(cN%H8h}{(F`@|iOP9F_6vt|1+2f3JN#2OIZ zt)BDm9!gq%Jc=uTP1A;nY{C@Wgqdn{a|daD#rxQbj1HIR*sj&vArznDV&%Q|3a8Ir zBsY=0#I2^5Zt`A#ZoU_&?eVNl7a2aIv#x2=rPr^zOuYl`K1LJAX#pBZ`p?F+&aAZ_ zy{o=jBz7h7(lHJ5+}B?Ptj)cd+wO2Zm4y-MQT*+sCTSje=2*OR$bc2^=70I+mk!&$ zdFxD~5QBgJ`G0;l@xbuhj`R8_&+yGvYz@KRoY?}DV9S!cEJ|<8iMdo16)#gHCjIe+ z>fT5jn{CqjErVmG9Gh?phSAvJfRD$wcvvQbX_gQ14X4&>CJrR&M8JLC$0gB;mZEHM zwB0Gk0Wyga->C$FJALb&CVUTCfJd*Aw)P85vVv2MfM*kbBDHt=fxB0F?i;b@k*+4v zYfQU&Ez#)25>4+%g!IXv?MZ{X7-0AB4em4j?#o{T^@(|JOufgY*Vci&PeSkCO_h4| ze**#kF9K)f#}59%tiCNAX}$O7VC{TXK-K>^;%K)JI=P>fiMV@eOJNHc?2uTPR*MQBArBo2yY9i7$^ zi+2}4;i;e6!p~d$Y6z>WdOSsU^K<<5L)eTfJlb^Z_{z-wob#tWNi}{W>Z#uL2`E!E zyZ`R0`j4MDaVm&{yC!}`1muV~h;D?UAU0^3DF&dy*6%D$7O|P|0#RK@2OWn95^ETw z#(RWeh_ENo<_KDBZwfY+F!Iq&cqNT-ZnKP*LwH>OC{ITBC02i!UUumsuhlJD%1iGH zrgvMncI^W0jOwRCKh0#dXU?hV;pmj^^eXXroXU4Fm67Gu<=TDQ& z@mju^;_07;5D|L8;-Z67LW@n4?j|Q~NYbn& z@4Gk^^GJFaT2+*#rl)7`^L-?9ZzHHVWWFMGlqif+WMQ`Oj&))a?_>&pdAH2V=%pe- zvQ%Pimw|;GOC-4$D2w7IpvA4{xs#Xg3GXh&0j&(phP~ScEYEl)Z3f7pG9;2&dEW#0 zS0$eQop+Ak0tveL@OH|;psG-ow?x?fr@_y3%FY-d`5G)yq1 z(I6yk&aU`tC4X@kyUda>F?=@oI7mHOdlnWlAjV3g=^G<2S4=EYx8s%cu^(J0bYl|% zE8`X}To|>Oro)*YJGO84N{QoLIyu{Bv$5KuE5?3U7V9()z?8n&$=H6B%NJKooBR#Q zS$Gy{bh~>s2RQvbKqU5Ve6C0Le*Lnx%})53zcKc1n;vVpw&oZD$M-|{^}Lw-#;Ho+ z#N0%H#-20=cy2}tZl~SE`^H`T-xMv6-z>7~w%Na|Tjx^xspiw88a$x>2`hqbotrml zw6=N6mP=Fm;<0NAT{v1>Lc3vMY%v_7iTQOnTw@29dpWBarW}&n1vj9P6bkt6uJ9aB zcksB_HK&xS+NW}-z4K%n8=I)b!ZuhR7_ux?w`KkMzRA__-jk*>ZO*A`$Uf^b%PgJ> zrk~ewl|8qw18iBQcGgSE%Nvoi0vrgRZKV~UV0E|Ez|XMG4EI3MBo88md%w;TpG$)V z9OBc?i;X|$Z!}>*v$;lQ0PcO32=^ogF7*q}VC?m2i67g7LehL@VER|jY4+2$9aClI z+^O{R3CIB$vb$!k0yD1=7p8yI4!v@D#(7HbfvV;AY@;%#)n12~&-1rMOi5XpSvU)u z@dD)_T_>RJ@BCDe{gL1u2&2@xX$+?$=~A8zRJr2#K#qqm@nm z?A{+@fRNXYaN~x9lDRdthP@nPetn6vWZEbfy0P~^csj@N`lXL^-7%Kz46ZI7 zi(9BP_p{6AO8dkjy|VwfTu2`-w`Av$5W~vSQhFoN2L>+k(=^iM^!3)u);IYojm3(CTBX-@UT9!iiaY-$ z4Jj3wfq{W(HBXzEEWw^_*lbNZ5{-arkJy6NXg%#V(N7|TJm~><<0+Z9$XOV>XT-B{ z%d|Lps|{0iTJ22d*DGSb7?8{uq?IXWKO3EX(%iVGFp4*eQ~&N5Vp!eyzpjekZUjl6 zA!cS}(Id=_J2(98IHSyF0G4xbPYqc8$uF1VUl@1s;$Z2?fuhLJ zYik%%>~hPi)W>Ub0CWA)JXT^v`eIn&&cqLx9LhzNQmLG!fkYby+u*2E#{f}tmp@o6 zbHvj3?j>N7_tG97Gp(p!zkbHv1JzR(v7(pa=a>tYLJndYAdai43J`GN1OX4O|ROJ zy!ii1?srwaNhq`SsmwprN^kFHfcG}FkV23?{%`g&)s`kTL(sX{V=fd6|AaVEe0Gq> z!}-=khUy9r-=p5Cg+kcs>+9#eCVXn2m0tPJTgUbhSGdPrtzi?V_{QT@dCqP@*&OR= zJEY?`LL*Anp*kwdeS_LoxRi#H^cPnOiZv9R082|E|oj`RPcWI z?ux~as-f&*PJ#CV=m>4}Mi~-NxVOZTO_HZ0K`h<>fXn_t%Afs3dR71B82Ys%fa0(o zuZZU|jz-|Kx$|ohxyXh>ercsPCU3W15QIRjM6y#j?l^{xq z@GEG_ZgvHPRTK@?Q?>7e(?&X{L1|a;s#)i;CGDvKPCS5TP1mm~JlO#eQ>s26BNu#v zh=|7_*u)j7v!1uzxkBgji2^{AYJ7%dxv299LqjX!M|pct6yNl;s%`BtZl;*KyY%B? zM{B#L+{3w;_yE~4^Z`4kTOMHURGQCcO3>X87Crc_Pv&C!PiA`fz@|ABU8b48yITFn z!@|rF*5S85vi}>`JT>t~kt*||?O^+}fh~GWxKV!3d;|{NL6Fv^4=Z;SuHy1G7%b03aY*RAcM*7a?3FQSK|2vhG7VVy^&fox0^3eM@NXY!#*DIqks*e85lm0PitrzSLy>oHN^yZ-#&0G-5{ A1^@s6 literal 49612 zcmeGFcT`nb(>)3wbH*$Pf(aD^7!gI12|c2SNKmq3K#(AkGbUOQX^$u>5|o?`f%_#on`1#pcoPN?Wse^}eGWd0Hu^uBuDzc#`3mdA2hM~!l3#9a zDQ%nSB)w2uZwh<2LYum3Xd~lyl zY^B5{-SUdIs(1D+8L#p8>54X2yI4VtRSsYPNaDVvlq1{idtv-jYU%ws^ z8F{C?rSyo2r*BTQ+a*+`xeWyQ-Sr=Y4%P+ZXY$ zOLfbyOh{k5b*ma4(bLoOxb;A$ghBoicB%6NJZ{n~Mty<}|f-8{NKr`^K$X_k_i_Zq2DPznZjfSfDL_ zP*F=ut0vt_U;l^8457gT=g&t)sWrO{_w&u2TiD{_J!i)M{DJaZyoNOpGG@c|>fi`tIGA5haR>iiAT8S9^b4 zkytK@zYw?(g0^|SJ$XC#%pLsox>o7fvHKJyX3u^c7ACSnSa|%s_I9(qd-twhy_${q za>K*p?%R`7YPGq(x2!gu2VY;Can#T-g2UlVb{RvD$}+z0!Yk+5(eDru6;;&VRc|>m zWUHNG!Nw;Be%?8(;gQh7R*MvGuc)lEN>x36JUk~Sho^U+yu4vwdoBNV^B{Q-{@@+0 zNxSv4Zyq^t;6P13^IX<0S3EbdxTK`1yRlI6;;);Ci59ID+qF}zq7~}*D=MlTIB;X) zOrfZqmnW{?xbXpp@%0W;B10JLycZt znUd1=d58Fg?|XuSf|R~<_pf^@PS_VVRQlo0D$Ak13w3pMmKv|JW-VM8K4tF8@%OsB zEj)yzH4yS0i+;2M1MzP<_0P5G3!j7^4NWMk?;TXt)QoiJUElQT>NH8`ku+?DCH5cC zAi=O1M|td6*sE8&((%olAe_Ouf*^Lz`}a!n^4IXLA}w4yvl~BVy$j1fFZBEOlY-mL z_w4f&Qay6y_K=fvXv;h7=jx*&BAYiKUAS-|zqFl2=5#U91quNcZ*b(}%7>jYu@4r% zJ}va!eo_AF)vJ=0O)9BhGO$5qiKhO4TFO_kVb-en#@3W(u|vL+s)6zzC$Fq$zPe!n z-e1zX^^y6-iQyz?ym^kB2Ne)e?w{f>?f$FCpDagmO|s+Er(jkjo2 zW|!`+_LLnthEvSR%PVzT>=gFo$rH66M*)6*i}sqGf>Jh09It=>4Zubj4sy4rR7hYrDL@~_WbW%2#Zl=<`Kg#`z%Fgs{$9R26_w?Jw8Kl?e@*ezIj z?xXFrW9HiyJx-d(ysX~X@o8Bsbq$TOH5I;_PTyFt?pVNtX$uTss$M(|V}K|hiW}WK zllyQ5o34P9Q^qYJ>4@d~ZiNK|1QhoM1O@HEeJy)>;_|ZP%f%fBEOH-;D_B=MCgP&+ zvRue~N6pqfS<{y2y}dDipu^L7QIkox{fQGN9&XgXcIMOl$7lU)$pi4HCbcW1y`ob-E#KxqRNYT(nYNkn5QCqkF4IleS48M-@i`+ z1LMtVcZq5xDRH_x-YssG2->Nw|mRT69dp-;($>XYsom+38cK zl(HGSa&fxm!pl0iMqFGqQZ2e5LN!uFTRXZk)w;RTy1E$qUf0zx%(k?&EPH<1J>mSf zCqI9lqOHUgF6ry|@gRVK=`Kz#c*=k){-bnX&1Jjxmy;}enp9i9z1X+I>Ni>6*b}Cf zmhmGay_wBz&ZDW}r|EC`0TKJ}0NOy;#x-03k7kY6~CborOo%Z}Qrs;e_g z!Nt7m?aga&^vIFNnL~B!2R`bKJb||n)l4{u#i*S;d2+Hn5BDiI=qb;zn7@aGTT_4)iX8;2bez46shr4&-I?DW(fSwhV25(8WLCIocUbj zJ%yrU9qQKF{d#cL%io_lig&jJ;Xu8GleNTJDw2=xux>4?d3ibh{I^Y&I5{|Rn}7bk z$feosW3yOio*mnAI%nRY2b=ch$&RMU^wo?r{`P$DU~ijudCNUv?PT-4INib&%jPZT z3WP;u{iL!-GL9Od zhy6>8V$(xxyM8rR*|!zPohuZnW!^;YpIPl=S!LJV-3u?zlnI-(*g*+#qX6$4XWMl~ zJHz2P=ciR_{MkGqI_}F8XB6Nv#GiaSH8>>XT2ejpjOpv9Cy!-S@JRVQiWZY zm^yU{z{VV>PMbFEcWgvN0bZc{&D_HcS9x{vKl|>evyj~VRiF9zL>_r8L1unraRgl5 zxss^khUd>0;dk!dxf2LW-;f^?5Fj^U!i0fbQ>VcBYt;-ozQ29A?ZT6F3l#nuh1}>~ zoN2@J`}g@ypFX{M?OFx6rkoESzTiDnR8?27%_V)yk}d>pHK_X{#Na=HhrM|J2P&2(xX z=ZIU-X(P4t_eSRP!;_Zd9Hd{Jd2w!JsQ;m?bB3XzAsN&mpRM6ZNyj)pyZSBuI=LxR zrnp}J)|&L=)~wz|%%{7S)l6V@C&8~s4>SbY{k*+T1);ON1&B-O14${u!?a41e>^o#D(!CWI%hK%=>7@hrc}^^ww_pL# zgHmkzpN9*?w8F5HBFmRwzW$9_LfOGbCCrlaGGMVPtX3YpA7JX(tXY;|?BmpV z$KRl}BKf(-X#es^1ij4R7So=FK+h&vLk7>HZE{m4(ekrg-b~g3v|YPy-9Z>n;q%iU zE$VXS8&{^N`fN4E_jn6yudg-hYd;|<<8bWRvu7GmGt!kgPK%oKYPoEA-j}CQ}rCP^sHLZ%;?Z)$=zKhKPn2xh*(TLVgReSK@fkwjl2Ne1n8X9Kx z3elUm_|awB5RF_Q`q;Bw*d`^wOF*J{cm!WrXPNw!va-5BIs-ki&e7jqoHhFP{Pe@^ z7ef~D?ECLN<}D$Eo<{zHH?wcA^q;T#gsW&7#^ni(O~sKM;l%Rj-fCyvw#?BCz;AKq z5eGU_fRyN!X3TM99i+Dzz5$a)FzTtenAhl2Jru&TSSG5XLaU`JT~o|kp`gbuJvli! zCpWh^VCUsH!U8&J$9`mc=$mh4-X@$jbwJc7HzfIDy&+B#7qbAUAPx&r>#>WBi0J-P zZra?ESY7h;#OpZ3Pf?Ay{pZe|;|61wa-lKnS$cB++_+INZl+YgBq19)^;n(a80}O% zVXI?bt()ssU;~Xr6W@|(%}_$?FE35dNHTj2w7>T&!)PXn!q>AVK0@gGYnnjTWyu#q z6HKdP2om@d6eth(=Q)@7j}D#nShQW4Fv_I~)3%)X#P^E$TUgd*#Jvpx@ViaGIi<+K zVidf^&eebREqkW#CZ?4%%iySn20!1o9Tp8rx&E@c^a!A*``jQti%EEgoB?+Wjvkf{ z4)wD;z$>PePw!z=8l!fiZI!>nlb+^MBe;KvT0gS}RlGc~)gsuP3)HX;$NcTebwy7eK=h zxRzikBJZI}W?$rD$lUK6bme}Il>WOy*%x=n{LrKqSVM>w-O7MaKV1q%#Y z%HokS768#(!qFKu6@?=qn9-q1ug4mghQQ8Bp#<1}u%f;@InPlMMz-(PqA&DB=TRqQ z5);ah7^o8TL7Y7muOWWo)p&Z#&1XL4!%$BrcKzU^hviET$xmU)&HU$|fAWzK5l#i? z>kB|iHcycr*ZVzPNe3BSJ&QI?)AV3$*y%H849nuqr8LK+BK=z#SSYk7L7#h zj@RwmkC7Kr?nqI+IGEm%WwM#rwC<%iAK*30EsG;mkv3Ca@+EMe0Yg5vSWPOE z5EpO!`b?jYweSZ7N@NaTY3 z;)~9%E=%M&zS}PBg8Km@%@fyamyU!_8TlbRyD%FGXW`Eecf{?w8{}-HY})m9>Cz+l zSma5PJgxwkBe;;W68-=p1Lg`6qfmCFV7t0(+FogMz?)aI|CYgG&|p$}HngwPuK=yWzYv;tlU&J1HAiQVJLva`2V3JaG2& zBX9@`kw2Q6n=LzkvVEm&H$BZYNi?FoUfj@&k~H(5`ztTJ6FhL}(A~<@P>x}b>$j(6` z$lv69j9?*xn2h69CnDy~ozw9egWdd$G5C{vW34=!ST61~WaF_|R%dh|c63dnU33+P zGY5{Xu_E~*zMur&69Mh6)jRui9by=wqM|Bg06UlNzGl#n|Ck^4M@)d1*Sr}*Qpa$E zaLbmls0775(169yznypGPlL~Q*0aYZ(>oxAYX1J#J;kQu34UGW`0;PGwiPDUp|!Cc zQfxMxU&`hw(n+sJkD`Ktg0eXG?}uHvG9HHe@yv^!oOs%#EID~P0oEK|-cU-eai60T zcK9kfc7NHIV$n#^4u4ua;Zh|C8pXW&9y?3C1<$^TlU^KKcjNl?BMuG@de=b-{AGdW z&Yf#>^VTi3g9mRS>6o{0;fFV7bQWgg$j;?JeLUQ7;t~)-zKJeO@-ORxE0U$m5LE{V zu?um8#$wwd z7_+PK%jGxlwWnTu8@se4_g;~BVkmr+9^%LCk9AYWCuS$yySIQc{t}P3SQfCVNunlPzl7+HFPh+v zVz1>QpT?%UD)YV!UN5QXdFvL>l{eX?*&S+;@#+KDUEj9#er)c^!Cx&_^oJiE;}aIT z=haVJhc9=^%q)~0I<{`X@#vDQK+vb)QL!`lL#2tjx%npNb}T$(A54*T@a4&8<9B6e z)btL5z8vRjTHcdTep4waux8sfITL{mlT3|L`5s#w*7YuI^eSxpeY=Y+LQ+z4)&PI? za(zuRy+sw-U(Yz?p0Z2iMHKXWH@ELHyWQw{%U1o=XH|bJjin}zYEBvH{b7|_*J1Os zcW`h>vaqnQ2RXB{)sD;sxYu3ZeW$}(C*4$@0>TCLIiBOP4l@3@T9Hb*e9?=B459>< zKit9JxG1e#<-O6P(1?hpd!O|a%g4Pmg+&67jngeZpCA{0{nmjae5coxDLy~DZa6&V z*~Wt6zRNq!%nZ|HZnDJtnrliG%jHVy%s*haba=Ckq7x51sZb=|@6Ye!hy0{K(qK6a zTgiG|%I_B&&KU0v22I+|#6PceO?SFg%R?ZL62tVCg0Ek{M))3C)vvaX-(Jd3ZpJS^ zORbRSyY82f9m5;O_9e`n!(Z)F)8>|YW}3tLGN;4B@oVRwtO&f- znp)aiJlK}G*gzn{d>sx_`YNy%OV8!GMl`vIg9kr}`hWbPYq z_VKq>>h~W%>`!@JprD{U=jDnOmr8d$)QUB3bWN~4v0M7Oj`~7ZgZ9AL5BWV`x*E0* z=8dKI zXLB^x-BSw|y!m{re6nke`7C4Jz&&GJ*U~467J@`Tv0c~>MBn39qE_;aOME0KCh(m) zvEV-~0RAVd;uf=R`eRnm|MMRQ4rLAg@-bb5%o`yieLxB{$Wb-5dse@{&is0gvSgdQAWsZU1R<2npOiKxFwyX=fh_6p1Y-tlYU#@^#OOVt+%(St8aM3 zDo_7>a|Aq?aYfP*x0#F8kdPvKC)&~R&kO%zpceb*<>PX|Uj!g8ZrCR~a672^#VOg2 zH**KRKRXl z2YcO8+(W>B^hD|oANcm|8{wYw{?hgd4}E-kkTtkHkBuLKR?# zm=kYO$t;)Xo8_KT%h&^rhn*wJ%F1T-7C8{v2H4#=GT3GsUwP(5qr2|VlPZU@R3E>9fa=ksfk*=B-w?$g znIKqPIOA83U8<^P>9*cHr$3v4v6Lyr*Y}iO@YNd$1-nK50Y5TsF*dMiL&?QSzbzb+(Y%pK7J;G)97I4Xymv_JVcDqx#4)n4(9pGu4f-$vy*FWFB!eJdWYlh>GB`d zQj1ir9&WW3zxeAQyWr|H-tGd0^*#Gt)@d)^J~-5sN4k%JveJwYP|_mHmhDmuJqoJb zt~olf`_;7d4Tqfv?hq`|*L5DYJam7<&h?o?&r!(`c7MAJITi>wNKhKU5u!4*KT_YS ztxB}fe`iuHxWK!@9)dd(3NyeTsS_Z+aN!xjsJY%Vxi5a@VCFQN&6_v(w3s^Ym=z{3 zFW;n~JHVmDBrQ#fDkxxrTZ?6ekSD8|n8Z+RLiKZ8m}cBpoy=G9h!2ja!ZQ|Q0D)u=mCr#p5KR}D3S^K2JD{7MSphL#2-Vo;(Afak&2t%T__*7!p|3c>6 zIdgXXvHvMIdnmjX%vY=R`pvDqa>M;LYhz=bc-v(<-!E?&tID=(c&|sRw`!scR7bnFCRCb{R$WGDuRVxojOC{6Vj7as^9Fw+h&XO-n3rctOS71*b zpLy}kZYaGn^aL`*&a`p2iw%wE%RRBakU7Yc`LRc|)w+6NnC#+86YE6J7HjMC$j<~# zGJo9KA%HyEqN~Se&@_Z2o*y&*8XH zrPT@@okFZf;vxdS1m`(kzP^Z`sZ{XA-C zmjXoa`O)^kbo<^ai@5gUNcEmFqu547HSD`x=Z9525Aqy--5dS>?dw+&HrScpafhsB z9#;SHi;IgJUt;>_Stu4}RW3QrKUyu4iWM#8iIHHx-zPS3RAX z-9^d3(@L-@l7jrz6%|oUO-%wqqvwuCtF2hM5~;AFkZ0(=&)-z#w*eh&m{nX_+WXZ$ z)#q7x3u;Z?7Q@oP9e#r8uWe$rb#;kGKfmxg6BvQ3z`TMjZ zHr72&#bUlM0`2E4$~UP#BhgULdMb)KWX(pWrMp zFbRO#uFg$F_CCDvfM0c6+l$^4#{O=-&W>*Om8mwyZt}V#qvA>vs&!#^wKCS)nQL!$ zfseCJsuao1xB3}c)Um%3XCXFv`d9TxOEoz6kfI_L;_H!&47^@Ek{{!Xl}E;AL;#Z* ze1CJ@?uUm&ckp`0@OQ7Y8~rDQyWhAWIqY^sNh!av!~c&TIEzWIN&p*LtrB-<3mZ(D zDdhF;#}@>3VfIJw^`@mIe9878wFLYM`BvBm-p=J3o6GU;R2OS-d4dxk;vRYn=RVlH z>S=CRvt8}0t5z+&E#;+k^*myc?Wl4bM@#_dStBZHT-*x!1R=nis26n|+hFxq+3+_I z3A}IavD)_dD~N0h5YJZSsdk6KOSGo6qK80Mn^@h1Gk-|P^t$q!L&+>tqd0r z-Wb|Q)FXndj6LL1U$|7~=RTDIz$V}WBBw(YeU))F zAfcFR-~%G8(e9ips(YZ&Y}0j!M5jUqDIh96u|h%uoFM;^?$GF6^%M~A2&cEdnwBn^ z+Tfkhy@FjZ)4A_;)_xrXDIy)-^6LI>zu#JM=lAdP>;e=m?QwaRY{*Fr4`);T3R^HA z>dA$h&sg;H-~3R7s#Kt-%)ovMK~Eiafh@q4h1)XS=9LNCjF z_&aZ=lA@wwWXpvM7wkIT@@f|AA%QK{wyq3DKqJ@`T_)R|zZSDE;|pF zSF0#1KOt^>+Jbfe0w{pj5N5+QX4H1z-x!p}#@t6~nTiKcwlt!mW)N@M`SSxI;4y zM3^PY?TFnXVq!6`t$@!sLHJs$WJ)yflhqPZ?NI|!MTm}Lk1A|wpH-?hNFF=TW<9CZ z!(#0loi5`+OlhqDqpli=CRB2=Jr~EeIkwpkU@vSwzF1y%e(NyKCRMo6d8FR?r+KnQ z?)ZitJJXbksqjyx4nG9!8iT!2yjTss9`{Cir0>VT7f&Z}nO}K48$U}wzzXOrXs00G z0i{GvTrE~7TB6EkHyEzA67fBI_K-lNpy$XJdF`rO>i{SVddzuzH@<2_vBf%4_PEEVVEk*uObcb~v1#jHKdep%v%^6eFJ!>S%MQ-_i01 zBohH;QeyPnjdchvA3kSjIMs`ltonbG=UNrxvUaDpIUeS8zhCaz&|mLAlTC{l$oaTF zGirvw*8LnRGd0Adwl>|Vk4KWba}^{AuKi2%ciikPLu3N7pJHh}5D$8I@4kHs93bF2 z^Wfg_^8XaEuL*BK|S@2W@v1^^?-=Ag=9V!K4hWF1%Q3yubA-u-XhyaA|tqWSJm z>g==zXOJku=Rk)^oUb?A*8NrAb3)FRxOn?s6X;nEa(5{}wgL7$7zjxHLfcRls6OkT zgD-$(vGpY1qOvkjq}4IyC((#en@J-<%s(VB+n!beP~=Kf7ooKLHAaQ0lOe5E8=toF zDQI0K>&JP+$cd&poLA%s+5dia*z(cq+Wf?f9?^85QluPH9lXASF-Dy==kw>*yCV!M z3P>P#ePYGE@87=z=x#AA5*Y?q{;lj$L;N396y)QDKeY8WCuR;u6Tr7fy*GvXHfB3c zj&EcA`TZiV>DyWV8I}@~UU%;XgUU2nJbHQY(2}Pn&yJB7>XnNnYVijs9Q@VQkLvBu z9=mbnH-nc02!b#w1_v}Pir6YHSHMaXk1bt`%m|bhO8+QLK5iW8{p95nraF6A>f4t)3dS3!@-2N)X|ie$h}#B+@?`xh3=U5& z%<#&Kmt)Si7aXw>NE7v{J*~bl(1670x8o5#;0&N_S2BEgEU0;D_%pssAGh)a3tn36 zapa|Z@+AGZr=`tzA!jIUZn=BpwQ>LONR~l8(j*;Q9$@G8_Vz3hef>8V_9>Kq`S>#M z;pNO#*}bo9&Zmyo^}moe?BraNG2kF$E9IwlrynM8pP@foKJYC+<>B&KM0J){N`Nu@ zvVf@kzs-;pIG!7W6@B^g1z1EGoJr*E;FrOZE_v6OPk7lZZ#zz3CHzQd*5p~HiAO@@ zC!h23m@KyHM3g}A%A3#UX6u*t+{#gn6FpsPo{ST>uamr4x(wTEH#X_&x940@Jdc$8-o5cg65d?Y^IRc8As6zGYmxW9q5Pm&+4sqdSfaj4Vs4 zikO{awcw3a!k&HmP?nB*C;z(2B+zhh2Uz?2_wVbZx5;0>0ehs49nHQOd-*viS5U+fX6wYN)*L}WL7VA*Hgw8ceWLdbFi>K63?1{hn}v-k;AO;g(!u~fBDk_UK!)Z&>w57( zR7t>)Lm>48bsf}yf*>M6fn@E{r8`O9itpO9XZ&0PdZOG++SUMnG_KGhQ8UAT9;X0? z0}jFaGiZ%a6cg8=p4-07AU_~WUrTGzTubJYlZp4wpJ^i{q@858lS)qO)~V0~Zrnf+ zm+9G#FBgY?&Vz5`F6ey=QAziLMg%O*>P?%T^Ku1X4PwLsAI!$~M@1ckpoeONjfJ5^ z6@z-K=spIIgcTSTg&m=)7!)!*R0~HzQ}_*)A6Rp#GFY><6xqtrP{q}d%`SH8dyKLm zbf@-(Kd_}JnBULhKs9?LP=2+PRN72CM#9E5*orf-Qp$oMt7`zx#Y+H6C)aMosgOJu zQj)uVelZt*WJA1s^}{Fn$^if6_|7G7;7vpBtUBC;GO8p*D4(Gqc+Jj7jS@LXD8#V_ zr0Rr>l5*ptN1?SYb(3ZS-W7g2M#oPrR%;=fph_|%0;mm|z1G_*Bcp?B^>E8M&dNg% zgHS)+zUWq#jJ_a!@rHJ0&nE$7T9Sekm24ta@e^u1X$F7L{~?3jcyfF&7+d@ZGNoN! zWQ7e>Y30_=13-)us>0B{Iu81lkGGgTktG`*_o885Gv7%C;?(hhx8_wZ+IY4l=hrKDYV7&7F?(94FQa-}VRm_&tc5^_OVdY&a+`7~s@b%+N)n7vm$B6VX;^!f3m}ALQ_*UOO%6dk zr2?&G>Q>-G=&A~#2@r?0^=)?cwSZ9O`4xPy6}_w^)GbMG1APf9t?}ii&=?q(ZGkT3 zA0=i_^`_!wU7T8=qalqFIF=ApgRQ@=#EH2t5G{amWZvS%)$gRo(_;e$=>&#veXJ{> znj1?%)-0Z;bmRI@7}v-2=NoCNm1e~Yw`5(D8^di9Qw^GZR>rXA6vJy zVFmMnbW*eENs|2cuhK6qEzN4M#VVC_BBa`ck&y1>zu)(y-=9i5e@n3NSFTSF*bP>8n8aGh63Sbww=H_O!#YN7NcK;w)Ve0SFF*RuUK1R1Va#5Yilc9~Y!W|u zpyGAflYMIy)*d!|rx_AlbyO|X@yqXr4-__lNPY(4LZn}B zZ?8Idu%dV)^{ZE|@I9SHyW{fQ9hFKEOE_{;>f964j)2lO46Oz4yTruA49gRuq1Oz7 zp6O%pU1u$3MP{Nyyqj48MJU7@K-f#N5m2+v#a%G@rmFN*fYG|PHq)$K%=Uk}N?&jU z)GCb|Ry+2FYbKhcv?P=R!2eyp%l6qghPR(<%^Kbz7W?LohU9&@?oCeHMtK^nV}dXFjk}R5Z8W^&IYFW>Y`zLnK5|w46(qE=@l+nbsoL zPdih=xpZkPsjg`+adS^6mb*)}H8n+8wUmXU#Q-40yVy|NU^TP+x|!I1v!hM}jjKq4 zjNH2fHW_1=f!NT5VhO!$ef`ErH)VCY1Kr`X|mmBlfl3*8Zbb)Qv$!Dm&YgMLL9!2c{JFxQb z;lsz*Ex5dZKnzRi!Ypi*`h{(aByHLQ)S`|(j?Ek)33FPLI22IIi6)gr!3w;pu{xD5 zcbS)Q!8e&v!cU3w-L>l2M}2kaww9J?kOG#?C5N!+A7YGGWKEZ^ncy;247DQx36mmJ zC_t3QM1KA>+%owZLSPea-8~fQcPcP8k>$LseXQIB=mtm&M^b8BALX4pU#iAJE!>C2 zm_u7*Fgh}>inp!eT+klgj-Jm)%z2?P!{^0@ng1mavDqNGcFD}xxdnB z3k2s#9sPI>(pf0_N`^z#j{vkuk9*ols#uxGBm{F3{`}Rz4fK@i#`dS==PQwpIR&>( zHQBsQS%;fR-VlI+9LzCEY$j`!sCEcMm7xiuvQh`_J1Y-SPZc(I!o-R9Iu9`GQsQ7; zddr|&BHdrc@E=X%vN(2QVB?_jDci{S^>!YLNaHTTM8~0M4T3OA|Ef2+rc-(X{^&z zTzOpxy$Y`eb|;rrQBg5nN5u(*(K$GCdN+C;$_yi|M&rhgEebg#fHx}AUiln^sUr;5aNDi6aX(%BCEL2<;A0YGkBoCi60VzpDG zY38sRXWpVkQK_vd3iJRQn{D;!BV&*h0TvqM`AHMffa++ZokzPd$KRCOXI1?Cw1Ta@ zy?22Iv*~(g#_I%Jf`o{CO^S6}tJI`F*sr6?%ABcFr#_0^VcFybLknJ^aBqLg9AV9P z!(hIBPA^jh5ym3*RC}sl$#V9Csv01 z`|rQzmbXk56>kBk_keY3sP}g+0T4xFiEJZkBF+QxxRELV55zRU;fjce{G-pyS{AMd zc7Zz=fL=UHbb0&Oq?Hm95){yx9x}*H(Q(3T9F)d{?Yz9amc{0wvVq;e&m+%d9G9^0 zo*DdGl)y;ixSk-qkmv2}=@Gr-x*5QjS`+{_7Fn+Gj*X?zYSJ%OgQ!8p zYTz9bscqV{$qN|*kh<>=K@-CY>cf=KqAl~boo zxgELI*`90mD?G=JsR`*D7>Ixd-LNpkL-+$c2sJC3|NO_Pzm6BnQ-S6QTImY$Oc`_{ zAzxVC`O+lwU1g=Vj*d=ecefYZZ$)Kg-S_XyP*ADY&O&aEIG*Cr{~U=na-qABy94qd zmQ;1-8NuhxoA)zqTC&sdK!k2)#-+=b@lo@S)r%QBt~rBfGH)6XZ%vKfgh`W{3DC;; zffPgATQhQ`&lm0U@P3=meilK_nUZ0>bEhk|Ev7lDToYon$4JyfHf&HL<55!j*RVJu z7&aLR5LeeEb%OZ{B^i8$m&oG9i(!##wruH+s3#FSax{4F)$nnUAyW%rm&jF+@uZK2 z;@#HP7Ns%tsSXzQ#vNM+G<+vCG!z)|XIY_o`)Yu@iH1*R!uLyoiDq*ToX72r;*$m+utH`t$GCDk`q(0bEy2;j8P|x*O{5# ziHV6pYwIV~*Vpq_&tx1iOK%n;`_X3_(Wt{M;zC{4k`IR6%!|==$X$xWnE7#G6CPoH zppro@!u+7i9XT)avtc!!#r?TI4=$VgbMOYDGxulZUf>k&&mF{7?w|hmvDke+Qaek`X{Ai824oP*v<#RB-a@S+2#$B}-xqOveId6L z7%38g9j$yJh@d}PTg3oO5srd`gBy#&k0P>Z-HzRk769~4P(LE!NUU5PxIp2@JG@tx zC(TBts2^*A6)Db8@ThpbKmnpVUh&fAmyuiI<^5nC!#)sa>DQhyOZ z++J4;mYXJ`-er3LN@6!5vm%x|vS=+spzGmEBv;Vt=wc zxKUvxz|RwukPUiUEB6YS0vQOQzqtn#;@3-&=pTP^CU*-&_tL}Nh3G*k1|I}f&T>>f zK`~QyK;sPz3=E#7t-`WRZWcE%@nz&u?wLXe7sXG$`DfXMM383Gelt%%AQJ43_t(le zfWQ)*W&EiRb9x#J-`SpRM}`=&Q9m1kp1se@TUK;d;dyVD6!8fR90MGjP_HA%c0+5mF`t)v&U2iK>V?~w#&2wp*ZC4zKzhQ{cypbS;w_t5y z4M~?Nu89O9$)lbwu!d(V;sKINWBs9ch0;Si;zDnArPE*wb=6Ls&R64b9%%!K)^1!u z?;Xo)9TOy#CK99^>gym12CB;yY>;SQqK>~H5t`Ta)Kk(@Qd>+awvhs@s;Y_;M73fR z)T!6)Wiy_$W+L}F*^2-KM~ACNwSPucW;hNSVhaFL?z(=A5#6*&8I@CH8ux?=;z1Hn zgzRI64hkGfBTO)N*>nmC5K+URI@Ys0J379gqpJJ6`+9(rk2RK=u|QR{#8ki-5l_-cie z&du~jNTN5{po3nnpNj~lLjpxjYHMX=s``&%zlb(O2U>a7X^GDtKPn*MRK^_@*1nzw zOAvY|P8&(c1zsWmV3>puloWP710mmtPB*c_eVc}61H`8f|0z#_d`p-OH$&n=R1i-6 zhVIhE9H<(f=lcn(r1lpqZxtJk=u2~KW(*$l;p8*EwAPZL1-8yRVqQYP8eghYh)crV zz6`E|7#9>AeD2fzjezp^gy9*Qp`j=k?yWZc{q!VULky_92E3QIFj$VJyXrb$&}1^5 z*?%YI0WQk-P(^^{Ho$dogq@w8X^sJ|#zvdt9bMhsMF6NEI;7bJ_#pL~Lc^K&^#s;k zM@ccxU@z*QbbiRQR+N->e&bC5xK)qy2(9=!V zQ5zuo$W6#@KL-`GZoqT&uI6&TjcXkTl%Urefj(6P+$KjQ+59w;i|AdI$%Fpn@1e}m z=742cL1Q;4OL!THC4Rcj9Iw~EkPt!JSykXVZjvw?SLvaorQy|W7kfREQc{{owV9cj zDcp#u3Q)Lhw3!dfV2C=F%bXf42b$zY2po=drA^(< zZ0e0~h(}w{C0gGD{tCR(xtb@>n@ybueRl2My@HsOf%exkne)RL=m~MpkB{h6k^?oT zIbpTpdReS-ymyUpa(0jf)-^V+W)lO79%+O2HTbeFZt!_4jD9J2%@i7H!^TZ5LS&tx zqxz>fT2me5hLsM8;zP*)CW;|sZJ5b*Hq()&^msZCy|%q}-oPMC2NK!i(L-x{dm73U zV=)0@JsUEH64>na2%LP4WV@*kzA{S`KAD<|keaVxj~O$D>Ooy!#|&-9?s)6iu`@C< zI8@eyrE$&dG}mU5z$Sn~L;()xyBOAS{AZpy znj5hXj7i9SJZtxjKxNJK5rl_UuFS3>n>am} zxiv{UiJ3*Jy@DMR6GID)PzgWT9?|*MFy0W+2iTVisdxc5=v1f`C+qm)c~dG64h!F^gN-8MiYZ zy3BlN2r6X72J{G6>3H&s9{^Rj(d@`uxDq~GPrwz7E&;3MyySodY!yFn!qODe7;9Xp~r|NtRecRA0tzpAx3j|El zma40(UskV`0PZb?Y)OO-J0O_=obPlUaxBxiFJ_8}LhUE@1m{$7u;X}ZHE2E)ICBLK z5O6TU>SxASv$ zU}vJ(D}P83zhHz;eVPs$)5Ww?PBF&D{e;|AYxEEvdbI6J|Jo7gF{oyNl}V$t7zxI8 zKL_aqHP&CIc;&^t@IuMIL)12z=s{d?mHmX@x5r*K_xZb(nT{s-Atf=U2{XakQ3UG-AeJ}tJl)Y-I zRm*gpt3De+IrjJU?dMR{7CrUch4C;4vnC3YXPOZqI6-8_Skc7wuX4fZm7@OFm^Ol= zJe63^^@x&;4TSwm%p0n(lCiqBb@KsJ1d=8v8fLkSA!uk(*Wdw#9$pV_@h4-SO0{3l zZ%v2n@AD2R98N5%5&~&c6LUb(foZnT$wPw!QU@k9h}bgrsj>|Ru=my(8vxzuI#<5W z!9*?a!3UV`2F&Kb&}v64korZqL97ppImKPf z3HUEV^k_Kj$U~6g#xCwhW-0nfg`+8CTP$jAu?Oz1S(r3=ML39kl7OyY zgM~yovxzyr4~)SFR3JU1SxhJo3A15WhSeGAFC&!-sGmkPM(a4o3;nzhaJ*!0$y-nI zVJ_yTsP&L=K{y;)ILjI=I(dr1#-g;|NqA z*c{wuberolm-9RKMk_7735krKpC2a(oy=gV^O=`Vyv6axq0o(b zJi{lhxrtvtPHR>A-fhnO6UoS4a?zaOTu1@)RR0p%Dn4d!YjUEpr${1Tu` z)lfx2wz9eTbF~<)bIgVbaABX)3B)em{;YVK?Q`lBADMnlHaERcF`)hi#03!sSYa52 zA@k8@t|L^c^;o!B9?*yrgkVY-mixwk4|2Yanb}hz=b;PrJwP6PS;(58t6c=7j^P51q>D`PUtqvpNpBYGLaYSpoDc-7$gDB zO1$^Fb^}>RR@;BSVGFYcn*vojB6}!s9Y493nqKZf)>Nw?17KXqVGNu@V!-TIpCfm1 zeKVnLOhMwdf=%KfL=6UU#CR|!#2S5R7~e#p!pFx)_#Dz#Ff?13uP^2rg4qm;ZQwF| zOCe}dv$9HHjyeXFUmTiC^+t?MfZRldLlpgCnf^D7h3@^kHfzcYiq&=RMn*;oHzFA< zLD6;wMaK3~?(^Fx5#v<*+712+GcL5#Y`!qJYm~X*ESB?047foaepPriMkZhh|LqTp zF&EZ|7lJimXVd`L9GZ{V%8$YGNsH{;=+GU640E*})v+y7Pz8$*SYsQd1 zf=sph^NuzV6|o*yf3Az;})N{Ssk>FHl?TvO`^&d=+h=++Hq}b@ADNBm<~mHwTRprzs5r>Gg;Z zvfN&-O}qH$0Suw6t)`BOWqZz*Y(KqxX^C1(fs;q&Gq zHlYhoZL~*sw9er?Sy8W;Js4`u@%%$&}oJ+!*JL zXLVlT9?c4fRt>uwzF_QJP}ehvuFhdJ1!Ey#Jw+tACZco+jVm+;ly<$h zY*Dl#lzQtrp^xEAjU+sae2n}|GG3P(Z$LBx8^+*Nf&tj6XBs-Dhv+J%S~Wa8!EnH+ zjdo3KK+80;18T!a>RJI8L-R7voC!guc^4DsP@O~%8p`~LW;yUmND?>*f@{=cqFh{9 z#ZkwPzI^#ILM!<>-uR0wG=d>}xVKyxz4g=rjHxNqgG9s8gjXZyrO7lnp&%K@fiRTk zkWO)y3JCJJQ5Pmg?g`2|X`!Vt|8J!hV$jFOsy~*Ns)L?B3L46y+&FPH3iGJKtuN^X zyRjSPLIMtG7geREPc-z9k`;wMlqL5wm>x<>{<8-t9!YlB1)iW^8)J%N&g(%Or!KsQoKP3 zSg((bfW}812`gxz$T@@G#;~#>q9LLizhn9H{cIA9;N||UG#Pyzt8n0eGA@)VNoq7S z61d(kOOFHt+#XGeg4Bgna5wcnjaUQSj12J*sA&uwOePly7_xTB5;?Wz9>=%?Xjr9F z1W)NJ<5*@ZVFJGcy=km{Br+kSPvndsiKXa{%~Qu35j|F+XliR`N67L&k^Ld6jG`GE z1yeZQPOUPxcK{PQhc+#9YwJ={RUl&|6$Su8>8KloSx3o!fWE+9 zH=t7k<=5;P&NIQ(Lt;F~W|W(QvQE2T%q+%1Aj=5C(8y~+9FhOD0H7jusvWvKx=N22 zZ}lNT4}M`sW_EG0Dwci}JtY+15V}8}da5~>Q&g3&-0I)1n-fwCVEAfa7u$WOxXKM_tQ zob4U!G6l%oxH>}{9P9vE>qpyn?=?b68XlYw8I}7z_{GVk_74nD6r(v&3Kx>MbMZvL zbWGkQBZ1@tIS_T2{@#Fgzg54np@Y zx=kI6yKvyJrO!WXz%Bo*ukTH*UJpq|mi-K_>lX<`d8G)~3^z{!kZJ&3MWnH(MK<_n@;On+vvDWy0=g zZ~r?U#}f1<=HSXhdAizMtpoR$YA}$dDUO>sT?s7Mbe$Qj`3mrhfR8k@kp>X&^?RWa zO*sb&FJ1NK%O5f*_IA-Z34ST+XnTaK-|+IF3MmXdqfK8GNZoZB zH-ln%DFD(_y$z3@kE$1U=;sHh1Ruy($1WB@7^^evy?(8K}LCz!ZWT! zy+Z{K269pmD16qx@6G0Jt6cK0y1L+1em1-Ct5ja2M^kt`zts`2L*vC6kBK~s!r(YjsyZ{=aXC;%7*4%}-HlwvxRXQ7Dt%5BmZk;F}#H^xS09Kj2khKLy}G9!KZzL3nI$3wFM|7h1g*93y^lQY?d%X1b`m9mPx?=dWS|cSbZ-K`?H>F<82;$WRcTv$C!xE##U2 zYlIB;uvEtt!1}<$vcoF64jorPK9Qn|CNv|U(u#{-oIMQ0wosav72^)x8Vo%33X|$B z4;>A3H`Orta=M0_CO0Ku)yS%ZEAOSDi8N%FfDBBP6NF$(lm2LQGYVrgEb(*bc%?I# z(GJbyYIMlMiLU9?0+B=Z0~+*l$>XHIX4NN16;b3Ufk2GZd_d5;;wTgl~73(m~CPT6MrmqlmuIK=1~aPiMKv&gSQ5kQRa-N(;9r6W*<`cP zrITjgQfoKtxpinT-xT36f*c#}`yG-rPdmcTbzH29@zBFT?HmCFJOIv`px!WMqi}*S z^MNXmG+_pW0IiASWUGB5EY0YzZuysibNEk)A=O>m_O7U>*tz$9Vs zKF>O>1&~eyiQsOHFzZ8Ix;oAFBE*{e(Z=ZTUVp-0D-O7i5OM&@OKOlH_ec|jsm5c0 zN!he5q@1Y*vj7y#QAJ!TOTDi{z0BA7)a*tXiX z36BwTK#47lh$vCp0NA3of{2Kqf(Q~61Ox=;S^Lnxxm7bYRZ}%nHGhnC>t3%M_SyT} z-?zfM-u13K$1wMJi1nQ1A6?D>GmZi_5n!_@h`<58wHHpujQ3!Pg-0OO$cG=O4Hq7d zz9(s#>f)`Kn6VOFV2_L|KTpT~`N!_;0GcsP%nSf?F}>W=E(s`AS5APl| zU%{1Eyu7|z8nLB&9T)YgEX`B2UZu+b>24y??0v)Yr;-Y-N4Lq3M7nNuZPltokaKDN zM*brQtZx=c!C>nod`WR`@^pB!Q|0wL=|Av#S=(wL4W$-{B=sJm*Z1tvmH3Q~h^HKulQCE4O~A%Vr-O7b@OFAe9_Tl?R^TYM zo6t*FAN{1I7i}gJ?gI(gEtu zI*?RFBCbe4k)-q_y_dQ(2VD`VK|D(|@~B7wsccEyA<`DeBCJ`zeg=I4MX}piIUIlw z2Lh^YWX=c4CW(A{a1Wz*=-$XSnIb!+o3Jyca~004ARBk87Z*IdusEtk_5NsEjk@!R z-oHFwl(u4T$PvrA&c1fx346``mUUkr5^52Wn36em{{7w|{{G`F=YH3FO!x7-^h@-E zyr1QMcu>%2NYUY*gF43<930UhYiP_;PtT-1#~wty8(C1gRY#y|ym#r%7kxt=(k2i5 zYe;dSmH|GCUJr{)6I%hOj363e&m!KA?VY2nVZ6^mPryqtmgn5uQPrf<1+E`yc_3%I(kqLk1Aj%OM8#> z0!h@e|0^n*99sxi;0(oh7~_w%^mvQ-6jFj2$II4%0Qw``Dh#S@ zTRiP7PP(*TA^hgHxQ_yf-#886d)l>pd4=jEiR}koyYwIZ^wUr4;C+1i>OyLS)AS(@ zuViw^libqJpDpMs%%p7dqyG3<03wn)=u^|6U(NV)!KgXCj0G~`}JBT}$FX8Qr;CuT`K_3AX zq;Q3d|Nad4ng`?b;0wUol(9;kJHOdFrZ(2Rt6Fr%j#rvgem6Ji_J$0)Qu5Fl0`DdLA?gd$- zF=W5~3vT^FPt6eyFyV9N>(`yQ2}!WQlIqlN>H+Em3S%Mf0`&04jU^R-Wtp0hnTlJb ztW{#dzWa|>b*3YcXvtGRn#7#6jvTLwDh#V2A{KWArZXPr5LzHxmndLeW%+vXELdI- z;Q_q6f((y1-=~N2yB<_aJCr~OKub&~N_Oo9dPr~Xq2!e_+4s2>B($#8l^fNXojYSj z2TQAn<}?1#{Vb3?#C))X>dYT%8~s{Ahu-gEj#-5IOTF=gs+Pl z--72~%`gk1pz^>r7)nv$%}=~lX|+Hl!RbwkplbSRq_`%A#UM0)mafiepd`*`({bST zVO{))u%%ujg}~+YUjbVGP3$8mTKzD#3d)!Xi%$=0w07CD_gxB}ierU!>g~LeOb>QY za+ki<*RMER7(D_1e!bVV;p@AT9=`eX(8wu!yUnVjGqw+lw)-Z-fY=|qe5H}2dP#6H z63xCsV#6PWp(a}s{bF#%gVFgqpxa;%XRpbN!7RF1TU%Fb*!816c$zmZcfgtTeLRxt zzhc) zWuD#98Ll#E_1`uFe1*tiReENx)r81MT%U1a#4Kx<;&av$@Q#093GC$=Z;SQmW@u>m z^!xHoNK4Giy%5SfVSHSFVY+pOjf%9HNEt)J;%JSBSa$;OzcDO=j9((8e}to!t43`EO!Tf4XBlEGg~*t}S`T(^1i=ToQ8 z4U9f@>J&X-Hr5WAuD%udCP!X5`Bvy(G%|_&dt`1{`we9YF4?J*H;0~i74+c#gL+f3 z*}=)Zf|F0$t}ZjUk@`8my0T(m;n0yetKAY7SN`dCraFFs;fW5LPMz57M6O7#MbP}> z?<58s3|jlq_Fd%$t*$rr<;J@G!-o&|=cF#bv~1j|OIscGyxWstbg1ZegR&cOYwI|$ z6k&IlxK*?%6@cxwqaH;!MJrXXY&| zou7BM@Hj*7sjUy}3zOqO7`{zV7FSi6F} zGdA{@I0aTwTat|*&#ys&UnompbTIvmDD>Ika2eC|W%2we zGrL*%!0Uqp*=S3xBO?9LC~}Kghl2@IYz}e*o9I8^Q@Jy2&M3lt)PcqV$pPri0A+C;;InDJ@nf29~O+r5n;dK-iO{Uy@l}svw4bTlVN?L>WpJ1dfvps{Zv6Hus`Bq z!nq1pSJze#VV$W|W`8EHq%=d=6n>RthiLiZ6z`Lts5HRpLwKMsmiBP>>1G7KL2d(U znckx!`l7ng44NKX;ar3XHCDEK{zByQLqVd;D0pj(%X5-v!@}U6rkl3+HOB1syKJd?@gzHI2i9zfwp_3=YiDyVzLMk@K6`a#?X1`EvY9(G$f&UH_lXUaKhOHiSg@> zfD(#Wolrc5u_vSMo+ce`#Xg!2G4L~9Sa6T!`=sp68M->f*`vq6{c2JUOrf5PLJ
        @uq3#g7B$&qLo;h`XsV4+UjWC3gx* zAk_(G@yj0O!oA$5KgC2zpLi$cV0Vc=)4E8b$&^EPH}u2lJ72i3&vn}Yo}bZ{ z^pgYM+?lnHfq73&%b?p}H_VNDqO#`8YRVU=o5CNZofrBABl$MTzQ)>uSsagrz> zsynH|izdDQ(z)4^D4KUWornl?Yfw>ZmmD2=a=c2#qBs-+U}Mgt4kX>}w1IIKbBLE0 zt}||b-)3>#-7R(ieIkbQ?%^rPIa{{NIwwj5a?k{`wuVT)^Yl?nuuvO-Y|5G6Rdw?d zQIixd$h^0l-(H{%rA}o3orYY1n(Xo!7zjNvhxC(neWse7Vi2_d_uubN?`i+eEFky9 z+WN?Gx?R}F>#X>Gv`r%>oKfY@rpjbCHm=CLMf@b#1!N{?zLd+o$k;~BAm~-2o8PLV z%6?U`OWN*8Ev9UIZHL{InN0l4EQk~q5t~-)m>Zw2Ri{2IhtVP_{fF>Gn`GKYJbP$F zqee;NtAbf<99145^I3U;ib?`?%&eG5+~jH!(ayfOClQdAY8Fo`)N(QDMJ^PfZ$YV&B<$}0vC z092|GcWxw&j9c(87hr9c>=OIue~zM^s!`j(X%}`-t-45U#>esXUv>3rFKCJll4>o+ zNyH-r%7DQ$hX(yWkKU*GLk9B5&^PjF9GVrjr~QS^op$|_)QOXl7xd5}!RNp$^afUr zKRA$ZFC!zvi+I?M#(OZeB|B!iaAAJ|I|b$?4-P5_wfw^}Y@M%k5BN+y_fv8!MN>;J z)w#nJ5Kbvwfh0PoU#HPOGT~EE(ZG(K++W@!HwN>Y2IjXe>tQ=Gnn_YHfNQR=2FCe! zNGAT)pO!y}C^~D4->q#L(QpCZZ#Fh|wP?$b_2#7j9LGM+1dx4&q`z1m;L|@%Zi&hk z7s_E%UCV%PrgFDHq)m`o@x93J42qGo3;rneYCn3*2Aqhmd$G1hO0ymo;{<^Pr~%Mk zF8-2qD|pJbHT*xhKHOV#GG7P*fjj#Q+aIy_mliiPV6GFp9=v~~w?BySh-YnY31xv> zZARLRg}aZ21o7$SypW_d>kbT;H(NG=*CWIvK{bfVCaw*@y9gm1Fl6PKrEOIM{vz0y zBp)xrM@Okg*Fvwle!)RF81#=PL@Q~NFrA0N#&9~5nPDxk876}wiT&iAubCoRI$Af z3>4H?D#*Z1O`A6LLi%KUSm=&_h#ZP(aPxz^K#PKytOk?!oHSKB9aW}Xe;zy5j>Jrc zKN4R)ZHv^%HK_$+s+*6h<&nwi0~q*#PRl4WK}0#X-L(iuj$rWW-()$pRKuOCppvNX7Jw@$19~aiJb0` zON&$qu|7=Gx?O9#2S5pE-~u&U z#sJH-Mf$PT5+q6Ughb0^AwA}YUA?6~Fs-RV^>*LVlWsm?cLM#cN{g~ja|oI(g=eAr zv~S;Dx$4pZo(TdvFMDh%IzezZB(P8`(_1mw@=?yk%yU0&*PXoEWVCh_VmI>WQc(go z1;>6FmBxW4f)GXp__FPSpH#7~gu%kI6ElAHY)2P31p);^&t`CM^)gI|94;IJxR)(& ztacsgHC1)ArXKeXMFk{RUJt7H0R9IBat_9;U$<7OmbZbpWQ!0i83-~?VsQw98Fad+ zFK@n=FA=bgBh=Zzz~I8$H*Ph@pl~}tn9PMGp%{C-k|a!I zD=;4>#06nzlH*9(9Jp0qEtMJu{LP5myq*%?JW#ER@8j!q)5?B0Jt6jyAYH1!U}zO+-Ir%5f-{F&?nftj64a@jGv0r|SBrD5O7Id8C(bWwtu&Qa;Mxxvph zZ)-Y+`Vvw8a?Ub^_A3RUTFoJ>R&T-$uIm1_pXWs3RMF=u(>0f~tHWF?!}Mf+fT&{w zM_(lF^yh^)jjUU9Vl%$O?~0|SE6l_8&gJ0XU^pl~Vz$`KY%f*J62lXTWE31Cb8&-i zRYe_AudjyI3|CUdz)PPwxvWHEM#HBMf7i7Aa@hs$w^>t(rlYFL?I3!LjBguWv!BG& z5^c6Q_M@t>A;e(TV!h1J;RmOba1~&E#5)vt{i3UHC|3~!13b31`Z(FL> zEvz<;l1Q?A$I73yi{6li-pNB&y?o4`0)zO2-b+Ao5G-_zBpM_7>M`&7pA_QTR_zU; z8(&lsH{@B0TjtO5eZ=%4O(qSK9H~pd@i?+4XRoR}Oc)_1WftM332PD%`2$-@>F-o1 zudjD@u(-Bz4s#QyJsMeh66bB_m=m#GYirt?QXvs+T3UA``65E)$p4{h{feR{on(M* z$aS6Jw|e3zJj8TSN{*7>oPN}>+{ zTr$)TgyE7vN^)4S=qQ_|oZ_F*xcu<`Y^lTYLH;*0CvDU|ckTVH=>#Ci`|An45JY`q z=<_XYabXJWbAH(8oBcTla#K`1#DfVHZr{nUz8>_28_ z@ov;08eVNx?(@9(ZejjQqn$(^?1ITf^IQ?w6ygUtooKZpaQXu1;% zHfc9c#}+c`nsi#G>%yEZJeLLW5FT3`<$kg^F#nxetV>wL;Cl3h!Iv}NSn!JSQ|LNu z!Jyq97ujN0qm!e~(8AecW`GY5@nUSnk)E?A>yJO=aq!^uBQLF438L?8x_#?6Xdp21 zzP3h%kDb>3jbWh<<;zKx#9E`Pa?gED&4#h3{;<*{yA|s!%v?grlC}A-BK`Sh5q8t) zktCR393KZf2`2Nnldn+U$VJn3d-8(|UF4-0! zzmWZK6vib!i9DU0I6;`DSXfin6eEYYRr{ePFjusiN$TJgiS4H3YkUTgnO>njGz?$`~v5 z9FiA7ieNKPQ{D?ehEXJn$;(P!d2Ofb+uGSRp_UHO$a`vgPjM{1V1M35?*I*Oq5dSa zJX=DOw3#_R)+j{5lJqj#AjQS&j<2^$H7naT3d2w3wD6AS6HySvz4;Q$2>Y1g{guoO zDwWYAn*qtu&7OohSkqtiUJ7!6YQkVAtjNY(WV^oAJA8N1>$z=9YvQSGzaq3I;0;p7 zPjf}(!)nv(Izlaod3OYI=2^n$3xq|_OW_h?d){LK1<3;0kOmQ%C5x@`NL=CaCZ+iE z=c|3c%!Htf!r2T0y2X>{t6~j+v84biT7FnkDZPPOF~_o*T#myU=3IIi@nZPdjV`$b(W7DTMgY=gR=a;Ypn5*@%{OV&9yEf}~DRmZ&v zcTFlQEBEeu^Fz(K`*u6#M}{opRC6nSZ_)QM^??~U?ls4*JY}?+m5BSl{r8TOfeuBI zgyNpM)GXGRA}tYz?6h0ic$hBdm9W!&CBhh2p&|-Hvt-O-ZbHaBEPYb?I{K{+OjF`$ zQ$vAfv1ekVE24o8g#;-U;m%Te7B7|Fa(Qf2glNwD~ zhGjcW4~k0##qnui#CyK4tx^>>(8l7MYDtFywk$8DCJo)I{J5F+$FW}ITQVqDxKMgh zc#wHpw|wObYJ94v2aFsVZlo%wvA8_XNZx_%K!;#H^YHayMJn6ouNKx@&XHry*JQx$ zCpnr0x>VPjol(|68@!DW!zlW*C3%Eo)FmI?{F$|iu34)XM`F`KyZr=)Vs8!TLt|KM zQq3FL26Uh_gkjG$7U3K0Wzw7W>aDa_w|NXyC3=i%$(^gJN~42)TBGmKG>|XhYjm*T z=L4h4??;V8;%w zUt~HO#X7FjexbNkpc*?am4buMDLkhfzC_N9|*`Q5V zCFEsEzZ%v2^fOWv?{PI6FLC))p6}J=#$r|4AD3C7!+{jAp8Da#hY|~ehsd^6Rkc;_ z+1eOqh7%;A{2I-gvG^#rpgyiEF?K{aB&UDe;q_bVrBA&XtZ`3knKRwX;C67Qo zgi|qNC3&2xX^@zdTZJVT> zoU+lU>`>x7)2ROR2q=SSq)N6C+euw4il{7tWFBYp$XwAT689{*1L$mMXSLqF5@9>aZcdlyZPP;DQcq zc4aP+I&qF|T6?%j>^iZwsw?f4U01jr8qtdu&jbzNx=S59+k^^LOXNNh$hd@(m@bB8 z&VFUR%YMRk3%RX5i2D)Kpr9 zi*(Gdlcc(`a+PVymw)wb-S#DcDwSHA%VEIeeV@Z3Wh~LYxlj_` zW43-ffaN{-WCFMF`AqfKu}>l!zYzcRudTSEwQ_~MSs|1zo_nu&4%Z&D;NaN9<{sob zf?hrKW~5}KvY{+bhOTyb?8wPBBX^OjEYD@@=v50kkGM>&Q7}MZ4PBDqs@nZzq`j+B zX%^yTPt{1Pm9XSz`r`&->tRP>)g*@kT>JA-+D*GuyJ^z~dQNOjM>2t*o?1AvSVG;& z+xI-by8IyFOjotMZV5}Zch^g~J5zHhjX@}_C;_tpi?ChL`Ku>Y2B3z&qefDvAm44N zoQ*8)(XB3iFz}HNk+z~hPvK=-If_!RDd;Jq%0p01JEA3huWaM3Vw(ParCgf z>Z2#!q10c83~lzL2`qJvR*GWS560Onz#FO-Yi&sBC#@XI!nD)yxG9ydT+rETskD2K z8|R@XEEH;r17)+g_gBoJdv#;dK4`US4e+MKjvVrB(>o;!%0`Qu8bWF!?M8~3TcEYE z9os=bokj&gUkxzu4EpyX$IjzQ>z7hAN{C7&2cY1pEWpj#%F8hwMxrC#spO36Cr}iH zP`_>ZYf3mtU;z4(Bh8{Qpn=%Z1=>|k?pjtFIU_ z_fOgf8T+0>9O#ywnsSOVi5WO<@$25WP_;(F z6u0V%w7TB+-6VJU*A@?=O~-R$S0yNEskJR%nn;!FghSNwG%L^`vTyqZ=f9$#ltW93 zCUM1KJ!xhCFRz%djTdc9O_f$b`?S-5rEsovCmwR6JJ1Xu`>>vrss9ZTVn=G9N>>0j zu-iUrNnc*MR@jrtwLICwAskKz!#|d%wFmsG-?ZBT*#_<}wTMS-M=}i&sl(E1^so=( zWZ7={7G5JF=*B8OiJX=|x-vvD8~NH;bHonth2_XUmE-}Bi_*1WpQ-IPFyHPE>u4(x zA{xY|Z$6Xi0^;(LJi9bkCWqh_S1mXnVF2naFHP%es1YfyCSQxp+5AP8 zs%X!d17OO^EBh_89jvFrk%Q>857=CiyIk>IFLx=%FSa)60wJ)^?4U&&FCq8QNQ1=j zz@eURMK8R0U#nhfD!Z+zjuYrB)_IMAa#TAWq|)d^>h$987{NW@iwzojc<}^E2=sAz z!`)Szi!%k8R9ohUCCjN|Ao}gse5J(F=+Zg z-8O~~6lb_^t9BJT6Us=3fnw`wWcxrK8caSCF3qoS)5&pAU4Y!wPvU=f9c^%MWh!4X z2xU1u{sfJXCs0**nQn1IICNAO+c|$nbJWHP3xV~&P}bvrOq)xEh$mW{27l;=IP?YQ zU(%G4&FOf8!_ZTcq(7a|H_}F;X;qAN2ij}{!s$V0P*f#txpsKzdv)$_uc_9nX}S7G zgv6wEL(+qx&9!TI0;d01085q_vo9RXt-IFj2Tl_ak!ubzOP*M5i1JL^v{C()U2!%~ zh#WlzH)!DWO!4QpY%23$mnc49P0I8{Tt*4!!v5P326l##`U^rWqodSMvEQr*c%ilp>ER%dqm7%;5c;`*2b$yubH$bi-1L|Ia8m`>`ms!q>@Y6+!;00hfMS?r8<${utd1^hFZLMdMFS(JlJB|`DTWth%b zrj02#KnSAIBQp{KG%&^fLq$9Em3Aw(j0Jjtj5Qs+BCmpeOfPD|B;kMEwDH^sIwoy^ zGzw!2`V66TcewZ5XM#ScoEj-%;evhyJw%tXVn9zCFX$KzTJ|%gbl-1i>f2oiB|ToC z`u@Lk0f+=MSLIkV{_X?kq2yhT1g`Gkou=0 ztf60-7MseuZFv%wQpW=AMqhJ){US9WsXKc)?+%m+P@=H`tw48jsiPEBlR@a7UsDaAeh}h!fZi1@H<`jLtzNgq$ z=dd*M;Ih^A#^=O#(C*540VIb4staeQA_`?be}}XvivP#q8Lu6IV}MihK_YJIpGi^C z*wk`J?X*waYWqlXHEW|b3ajDfg=XE&f2OPGv=}uaS94H1sV)nn9)7pHFY37myuFuR zTWSQbD(xn4@1K{#$X!OlPOsINYiY(TRt;Ft);-Qf)Gy@Dq*5mXgsIdajVvq;oT?8Q z1fky1@ke@jW`?>IW~ik%)C2(PcqL`Wr<`B<>rZ5ce#cob8LOmjLw{h4N;xiv0Xoh5 z%<}>2g{Ejy033alN}W)GK=I8n;JHPmwr0X`L;Q#OBV@mR@j+0amJ#v`3t(c`r%h5t z6xl|bP^G(*%z6`nDOC&lBwZ_uXMwizpS zrm>;R&C;RE>hJ1ETn9-j%{NB9xzwM<{2K5jS`vIT(idhkfywD}A9~?@*GY_Xxv!Apu(*o4F~ZE|P z&N}DOwKyA1oXvn?lTSBC^tXDrNs3XIVy8CA9|*dayH4rs%qdsD33_M?-xkW!RfnQY zO9Lyc_kWzdG>~K#7(OM`DI(Z9rywRF%fUv5g;%6G^@($3Vy$&_iL<8kVb?Z~>Z%I2 ziungm)5vT^AL>2i||i_{W9o!z>&9VZAC62L{H zhgQiLpczBMA3Vko(Ff4#I9?g=NVot@7Ta3JmXl`nR*R+t=Y5G|=Z-FA!9OYxI2(IJ zO)-^M_`i2HJgEW1zyCqykt$uL^gyZ20m^5zE5Aj?2s>7PSJI2v)c-h}{l{Pp zlt2G_2U+%lYQ#RuhNATm|FH~Ah&0G;^D9svsnh1Yiku6MCBg4I3I(BP;Fj>42ZyeH^Q+*ti0E}gM}Z$%z>t$}VdRvIONu{5?0wnU z-}Rc)L$g(DY0{;@I$5aPh%yOVLIlkKr5`;0;8F4EBp>bRcG>Bb*(yS+o3H5>vUxvZ zY1W>RcV!3=y=n*IZG#JjGr~vmZlNHucj7;;|HkuhqDhj5=9If*tsKl8nrsr^WA+r3?;oy?j&yFc&u_%rp;ajjzWc7zH{*Z4+;GkE8{Niu{Wi5v6VtQx#@%x4 ze&|4Bvx^IdS(K=uth+)={f<$MmsmtDE$j>Gj%&-|f)A>LIo-Tc}MlMZr(u}AmJbg;G9>vV8^=^0UYu9&sXurs? z*7k)h<)2Y}n3`FMVhCbKen_%OdvWCC9gTw<*ZVp$Q2&i#t?#EbHJvJvAL)`^KrnOb zB=D3TJ-f

        =E0bBG+oiIbqMhqkuVpidhmRa?za>mZ(goH|eY6^H*BYi%iICGbxTI z^>p1D-U&Ux>Mt=S=-xHy4Wh*I9w8YazgLD<(jY5M%N+a2;{rXZeOct=7D(I(yXS@{tJUWL4L#pD=2ER>*|atAq3&t!?w=9QXi=k|=5c z{++1!hf@CvN_B|e2_cw9{}p+=dB``9ZcKV$cGfZe?c>LfEobRJJ5sO9e}8Aoo^N9f zUeie;{bxHGb;vKiJrQzTZ{Ig~UlQtykQk}kcJI+6XO(UnpYt&L$|1G|fNaWShQ#~W0-;MeCAL`IX6v0ZYfl{8 zYYM)3js(*8`t{k=>!(hfIPvfrB!D<6YI8&__PTIHx_vbYoX^4z3P`W>!)M*wk3~dM zfrcYiEfpDD_HyZLZ)ymdjN&RM_vnO;R^eNKoHRXVstl+<6I9EZps^&{#xM##VA5RM z4NQ-N?6mk{T!8>Z!0fMQm~aAGyTvOfmy86ag1%ZB77?1$z3s8ErBJ{Gueg^4cGmho zxBjx(x4!TA-laHk*8K+$5{L~yeD3YLu%)IddZ*Q-5qW{%zU*CmDya{0BpNT`%jHxY z>F^gJM=(We-r5A{ZNeI6WaW|8)gNnZ!E9GffCW5FG6a-YBngM|DD$1Am_xr#JetUE z6)9;COg@k7w5p58m$h;R#!)d9@epXJV?Z~3&6~5v>}$#o2aoMN`zFvS@28h$XBXD# z>wY#As8u~6`f%|~vRVBZxreiMeb^Pnbk2aR_wMDs1rZyZ5LXsg%^FXUd4qtL99>G; zf+>g~){ceU^!4waxn0+im#^j?p?u z8bV;=e*C7-O$rTWvfH#db39Xap1of6VG`AlEggEL>s!AI31x3xlx_u}=%}8RIvTh} zlL&1{kRgNpV}D8_bb-6@zJu5ttt)D5Nz#sEdplTSLuG6Wlm&~P!(Ga+dcAnti~GLU zq3FfjJN926%RBcGjREt@nMONy?C_&Pq#0rI{53UMjTf;=;@V$LQ_BVfM$VWyv#Xj& zA<8aG74f<}Fg(BNW3}-c!(Y_%-)*qxA)7KS1wPB6Ud<=`v8&%A!(YbCf46>q`JvxZ zzP$Ee-(S_eJyk)SphXntEN1?P#!Gm3J*kyGA>xouZjp#6?tr1HI+lc5kx2J5HoBAd z)9jMAmyN2)bCcZuH0@2}V^{yg9?a%t@vr}}7MMqE9%vOAk#i7hk*>8Co^(gjyL^_- zv||RCTixZ-%T$7$;&|>`^qqm$ckL zIZ397jMoSN8tD31rz(BFQ#tgtmBoIm*><|jk2woh05pve~N}lvy=MiR?_BhNKZP7 zIGqFk7KufWh;VyBcPsNZMjyPp=u_Iwt*yV^lM-D4tXVl z)iX0kx+a;OEh>%Zx~j|Lj~;_nqk1BNsQFCoar2C{kSp&h((EcT3{3ukt`xF1Yce#B ziKqz(h#-J5goeWJ4P2*ke&{=S%!d^16ihaK=Lf(Zs8A2$X@qx+A+BmSBHfHFFZy2$ zW2A9Zw9kZYCIKRgyo^q;RkQq^kEi^|V&Bp(_K#Q>RJZjF3}n`ov_FYb8Y(r`kBln< zV!pju7;ae0GdgQ9zp|s5!owz<{lN>jQxn+!()2qmH(jNwXRi0}yuXg)4rpocMDHEP z{8wiCf9}IKU9u<@Oh*W8N+6i-i5LuUX}RWW9}|pZ=I-NI`zDJePG-JO} z&Z3q(tSgA&Z*5Z^{(1pNcl3^h*Ilp`@c|oQS?(`x@04-Cc~c#e0Q9bk!e9xw1@7Fo z`8`lcSt|xvQ8UEw6J7}MJ~U8zf2-N=-WcT zx3IL#xi%^DQ3=Qtag>-DimX!I9|PvQ%iy#~P*`x4w`F~SWdJ}$AxgM*wDAZWMuhZi zbE>AGw7p6-NVoZgb1QoZCNoa@)-L03)S4$xo=EdUXfc9HiG<9GemY(x^V&-Kgrv!V zu)=4_piy!aOea zw^sXYik*)=^h@}Z`3kbFFl047G9x9uABU+9Ji07cqNj3Q6Kfcdex%g&e2lQ zB}~>+i;SJP2dsP#OcG<1Wuyn)aRQ%X$7!<+wv2|kD0-|&@=AL`JNnp>=HfC)tV=x( zbNLykBxN(#Xc=iovDh5FUb#4K9?fkFCe1_fn+bY>*_TcR{{5?Q6+DEW>BBsN0vq5y zvX9*fz##|I)+@~gRof_U`$@@srQyBJMo1<*RIDiiLnOpCH{$X zXyTmXjkNOkWEqE~Hlyu!4<=xi-3P~^dx%f&2cX~=5m{%)!j@)MR;Qiv;a;!Egd<>k zBi`13X8yWi)Dbqf)a*fjhY9k1--afyG^6^~DXt}J{CeFm|By8Dd7~(YsIq%os`0vJ z&=MP{?@<{`y|#YXse5qc`CjrQzj??IS?^iF>V0q z+uLh-bdmX=>@s|K`1l)vrBx6o247?2l(v|um>lDl)N{xfE%Pe5vtu!w4~tEkHiZn^ zZ(Q!<^pycvo-sJ`cfjx0R!+0Au?e{b9b=yQI1_T2L|$(FYa8?q4p;;=Gi6d=$Qqg& zz?{@ih${ULl?|&x{?wGrPNOHK=jOXFT2=@Ll74xO$j=m2au&03b{emZubg7+=kn{q zdeq=sr`qq&yr0#Qs(H#4!6VG?Hm`R%X#5i@ixRBhp6QqfwGUsHEkmN>>^(D5B6+X| zjT8@c^INRR`U=;~U&)VLQlG)UIN-Dee^9iE+~(aUR24^@4yWq!&WVISJ=HxjImxl3P295ktFEP`fT{u>&Ez8ZC} z!KE!Xc;hK-%cysyU)$&Ha!`Lp^1#r-+s}{{)0^>NH=PHYSDG+1XaAC@m(D5`af0GE zw_p{%4K0{uWn?-1{G(IS%cp@iqHmTk32xQjsUtT%yu0F$ zD(^!KWhiZOxqDFW8G3;uu`W8eq@A^;k11Uz$?%)Ot3xN5PLeL6qBI&aTU%ewtAowV zG5*q;CPGnS-<%s1qc>yal8-SaRsXsVk#(dZC1dCU-)5C+LQ9`y=`>M1n=?J&9Mz0rlvlw^IMZkoSqVO;nf=jF?N^=_ngneFGi zD5|i`&d#o-+1||JNICqk$>Mp?+Q;yo<23*(2Dke~Y(52Qc6qNi;FVC8gjh*sOhn;@ zqZDsn|FqM)R?JXL>H9V?V&m%hvwUW*a;ErU`2mk*srmf$Ox4xNS)aVtoFB?*yBCJ* zwkn>Jh&_r85gH%HHNfK={J6;0!3{3ZSrGq{J9 z7R3L@Dd>1};^`4{%RRgR+6uF~MrS;Rr6?64~d%absw-l<2t`|P5 zAGNQVlKoLV7qtF`sgiPyF6(CyeEMSa$!TZUh4b5_h)yF)VV10Fzn_VIizCC<=$|lQ zj0C92rhrhC4MPhmHWz%OGQB-oaZvU8NoyCmsGgd=`*F4d$gB*wewzK+PV;0@&@wsz zaZ9348M7H7hC%x&S}kvnk0mk~?>BBxRL2x_ehjjhse(bu{t; zqKW#&{;O1b5rA-3KaoM9%;0I(qQwNiP5oXF@W)?c9R%m{zq(FK#Cq6J+1DmBQelokmo679%jk>SOCj&r`lxEY z@Sb3c(O<@cm^^Sr<1O{s99n>5)`nYQlMHd9DJ4;R(q22Z#4GuKdI`9<<7sxlvuD}s zT8m2xvd5RLrmDQcKC*0OgWLW1w&lKRKG zwQTnPD#dcID?%YsNS)ma#3~}`_Nb93hi`oNRd;^MK!TVZTNSe{YgfB_`zsP9%b!ud z|3?bModifying Metadata

        -

        Site built with pkgdown 2.0.1.

        +

        Site built with pkgdown 2.0.2.

      diff --git a/docs/articles/working-with-reports.html b/docs/articles/working-with-reports.html index 2ee553d5..e9054056 100644 --- a/docs/articles/working-with-reports.html +++ b/docs/articles/working-with-reports.html @@ -189,8 +189,8 @@

      Running a Report in your Org#> 3 0036A000002C6MY Jack 99 Steven Mortimer 0016A0000035mJ5 #> 4 0036A000002C6Mb Tim NA Steven Mortimer 0016A0000035mJ8 #> 5 0036A000002C6Mc John 23 Steven Mortimer 0016A0000035mJ8 -#> # … with 9 more rows, and 3 more variables: Account Name <chr>, -#> # Billing City <chr>, Account Owner <chr> +#> # … with 9 more rows, and 3 more variables: `Account Name` <chr>, +#> # `Billing City` <chr>, `Account Owner` <chr>

      Note that the sf_run_report() function will, by default, run the report asynchronously. This means that a report instance will be requested and then the function will wait to retrieve the results. The advantage to using an asynchronous report is that the results of such a report are stored for 24 hours and can be retrieved again saving CPU resources, if needed. A more in-depth discussion on synchronous vs. asynchronous reports is available here https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_get_reportdata.htm. However, for reports with a relatively small number of records a synchronous report may be faster without having to do the round trip of creating then querying a report instance.

      @@ -216,13 +216,13 @@

      Filtering a Report on the Fly#> # A tibble: 14 × 8 #> `Contact ID` `First Name` `test number` `Contact Owner` `Account ID` #> <chr> <chr> <dbl> <chr> <chr> -#> 1 0036A000002C6MW Rose NA Steven Mortimer 0016A0000035mJ4 -#> 2 0036A000002C6MX Sean NA Steven Mortimer 0016A0000035mJ4 -#> 3 0036A000002C6MY Jack 99 Steven Mortimer 0016A0000035mJ5 -#> 4 0036A000002C6Mb Tim NA Steven Mortimer 0016A0000035mJ8 -#> 5 0036A000002C6Mc John 23 Steven Mortimer 0016A0000035mJ8 -#> # … with 9 more rows, and 3 more variables: Account Name <chr>, -#> # Billing City <chr>, Account Owner <chr>

      +#> 1 0036A000002C6Mm Edna NA Steven Mortimer 0016A0000035mJE +#> 2 0036A000002C6Mk Tom NA Steven Mortimer 0016A0000035mJD +#> 3 0036A000002C6Ml Liz NA Steven Mortimer 0016A0000035mJD +#> 4 0036A000002C6MW Rose NA Steven Mortimer 0016A0000035mJ4 +#> 5 0036A000002C6MX Sean NA Steven Mortimer 0016A0000035mJ4 +#> # … with 9 more rows, and 3 more variables: `Account Name` <chr>, +#> # `Billing City` <chr>, `Account Owner` <chr>

      This second example shows how to return only the Top N number of records and combine the filter using the logical “OR” instead of “AND”.

       +#> 1 0033s000012Nl0r KEEP 1000 Steven Mortimer 0013s00000zFdug +#> 2 0033s000012Nl0s KEEP 1000 Steven Mortimer 0013s00000zFdug +#> 3 0033s000012Nl0v KEEP 1000 Steven Mortimer 0013s00000zFdug +#> 4 0033s000012Nl0u KEEP 1000 Steven Mortimer 0013s00000zFdug +#> 5 0033s000012Nl0t KEEP 1000 Steven Mortimer 0013s00000zFdug +#> # … with 3 more variables: `Account Name` <chr>, `Billing City` <chr>, +#> # `Account Owner` <chr>

      I was able to determine some of the potential ways to filter by first reviewing the reportFilters element in the existing report metadata and also reviewing the list of report filter operators.

      First, you can always take the report filter specification from the report metadata and tailor it to your needs. Below is an example showing how to get that metadata for our report. You can select specific elements to better understand the structure of the report.

       diff --git a/docs/authors.html b/docs/authors.html index 61758f55..d1cf2a70 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -149,7 +149,7 @@

      Citation

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/index.html b/docs/index.html index e682de06..165cc290 100644 --- a/docs/index.html +++ b/docs/index.html @@ -198,7 +198,7 @@

      Table of ContentsInstallation 

      -# install the current CRAN version (1.0.0)
+# install the current CRAN version (1.0.1)
 install.packages("salesforcer")
 
 # or get the development version on GitHub
@@ -227,25 +227,22 @@ 
      Usage
 
      
 
      Authenticate
 
      
-
      First, load the {salesforcer} package and login. There are two ways to authenticate:
      
+
      First, load the {salesforcer} package and log in. There are two ways to authenticate:
      
 
        
 
      1. OAuth 2.0
        2. 
-
      2. Basic Username-Password
        3. 
+
      3. Basic Username-Password
        4. 
 
      
-
      It is recommended to use OAuth 2.0 so that passwords do not have to be shared or embedded within scripts. User credentials will be stored in locally cached file entitled “.httr-oauth-salesforcer” in the current working directory. Also, note that if you use OAuth 2.0 authentication then the package will automatically refresh it so you will not have to call sf_auth() during each session if you have a cached “.httr-oauth-salesforcer” file in the working directory. The cache file is named that way to not conflict with the “.httr-oauth” files created by other packages.
      
-
      +
      NOTE: Beginning February 1, 2022 authentication via a username and password will not work in most orgs. On that date Salesforce will begin requiring customers to enable multi-factor authentication (MFA). The function sf_auth() will return the error message:
      
+
      INVALID_LOGIN: Invalid username, password, security token; or user locked out.
      
+
      It has always been recommended to use OAuth 2.0 so that passwords do not have to be shared or embedded within scripts. For more information on how OAuth 2.0 works within the {salesforcer} package, please read the Getting Started vignette.
      
+
       library(dplyr, warn.conflicts = FALSE)
 library(salesforcer)
 
 # Using OAuth 2.0 authentication
-sf_auth()
-
-# Using Basic Username-Password authentication
-sf_auth(username = "test@gmail.com", 
-        password = "{PASSWORD_HERE}",
-        security_token = "{SECURITY_TOKEN_HERE}")
      
+sf_auth()
      
 
      After logging in with sf_auth(), you can check your connectivity by looking at the information returned about the current user. It should be information about you!
      
-
      +
       # pull down information of person logged in
 # it's a simple easy call to get started 
 # and confirm a connection to the APIs
@@ -259,23 +256,23 @@ 
      AuthenticateCreate
 
      
 
      Salesforce has objects and those objects contain records. One default object is the “Contact” object. This example shows how to create two records in the Contact object.
      
-
      +
       n <- 2
 new_contacts <- tibble(FirstName = rep("Test", n),
                        LastName = paste0("Contact-Create-", 1:n))
 created_records <- sf_create(new_contacts, object_name = "Contact")
 created_records
-#> # A tibble: 2 x 2
+#> # A tibble: 2 × 2
 #>   id                 success
 #>   <chr>              <lgl>  
-#> 1 0033s000014AgfSAAS TRUE   
-#> 2 0033s000014AgfTAAS TRUE
      
+#> 1 0033s00001BXHr4AAH TRUE   
+#> 2 0033s00001BXHr5AAH TRUE
      
 
      
 
      
 
      Query
 
      
 
      Salesforce has proprietary form of SQL called SOQL (Salesforce Object Query Language). SOQL is a powerful tool that allows you to return the attributes of records on almost any object in Salesforce including Accounts, Contacts, Tasks, Opportunities, even Attachments! Below is an example where we grab the data we just created including Account object information for which the Contact record is associated with.
      
-
      +
       my_soql <- sprintf("SELECT Id, 
                            Account.Name, 
                            FirstName, 
@@ -285,47 +282,47 @@ 
      Query
                    paste0(created_records$id , collapse = "','"))
 queried_records <- sf_query(my_soql)
 queried_records
-#> # A tibble: 2 x 3
+#> # A tibble: 2 × 3
 #>   Id                 FirstName LastName        
 #>   <chr>              <chr>     <chr>           
-#> 1 0033s000014AgfSAAS Test      Contact-Create-1
-#> 2 0033s000014AgfTAAS Test      Contact-Create-2
      
+#> 1 0033s00001BXHr4AAH Test      Contact-Create-1
+#> 2 0033s00001BXHr5AAH Test      Contact-Create-2
      
 
      NOTE: In the example above, you’ll notice that the "Account.Name" column does not appear in the results. This is because the SOAP and REST APIs only return an empty Account object for the record if there is no relationship to an account (see #78). There is no reliable way to extract and rebuild the empty columns based on the query string. If there were Account information, an additional column titled "Account.Name" would appear in the results. Note, that the Bulk 1.0 and Bulk 2.0 APIs will return "Account.Name" as a column of all NA values for this query because they return results differently.
      
 
      
 
      
 
      Update
 
      
 
      After creating records you can update them using sf_update(). Updating a record requires you to pass the Salesforce Id of the record. Salesforce creates a unique 18-character identifier on each record and uses that to know which record to attach the update information you provide. Simply include a field or column in your update dataset called “Id” and the information will be matched. Here is an example where we update each of the records we created earlier with a new first name called “TestTest”.
      
-
      +
       # Update some of those records
 queried_records <- queried_records %>%
   mutate(FirstName = "TestTest")
   
 updated_records <- sf_update(queried_records, object_name = "Contact")
 updated_records
-#> # A tibble: 2 x 2
+#> # A tibble: 2 × 2
 #>   id                 success
 #>   <chr>              <lgl>  
-#> 1 0033s000014AgfSAAS TRUE   
-#> 2 0033s000014AgfTAAS TRUE
      
+#> 1 0033s00001BXHr4AAH TRUE   
+#> 2 0033s00001BXHr5AAH TRUE
      
 
      
 
      
 
      Bulk Operations
 
      
 
      For really large operations (inserts, updates, upserts, deletes, and queries) Salesforce provides the Bulk 1.0 and Bulk 2.0 APIs. In order to use the Bulk APIs in {salesforcer} you can just add api_type = "Bulk 1.0" or api_type = "Bulk 2.0" to your functions and the operation will be executed using the Bulk APIs. It’s that simple.
      
 
      The benefits of using the Bulk API for larger datasets is that the operation will reduce the number of individual API calls (organization usually have a limit on total calls) and batching the requests in bulk is usually quicker than running thousands of individuals calls when your data is large. Note: the Bulk 2.0 API does NOT guarantee the order of the data submitted is preserved in the output. This means that you must join on other data columns to match up the Ids that are returned in the output with the data you submitted. For this reason, Bulk 2.0 may not be a good solution for creating, updating, or upserting records where you need to keep track of the created Ids. The Bulk 2.0 API would be fine for deleting records where you only need to know which Ids were successfully deleted.
      
-
      +
       # create contacts using the Bulk API
 n <- 2
 new_contacts <- tibble(FirstName = rep("Test", n),
                        LastName = paste0("Contact-Create-", 1:n))
 created_records <- sf_create(new_contacts, "Contact", api_type = "Bulk 1.0")
 created_records
-#> # A tibble: 2 x 4
+#> # A tibble: 2 × 4
 #>   Id                 Success Created Error
 #>   <chr>              <lgl>   <lgl>   <lgl>
-#> 1 0033s000014AgfXAAS TRUE    TRUE    NA   
-#> 2 0033s000014AgfYAAS TRUE    TRUE    NA
+#> 1 0033s00001BXHr9AAH TRUE    TRUE    NA   
+#> 2 0033s00001BXHrAAAX TRUE    TRUE    NA
 
 # query large recordsets using the Bulk API
 my_soql <- sprintf("SELECT Id,
@@ -337,26 +334,26 @@ 
      Bulk Operationsqueried_records <- sf_query(my_soql, "Contact", api_type = "Bulk 1.0")
 queried_records
-#> # A tibble: 2 x 3
+#> # A tibble: 2 × 3
 #>   Id                 FirstName LastName        
 #>   <chr>              <chr>     <chr>           
-#> 1 0033s000014AgfXAAS Test      Contact-Create-1
-#> 2 0033s000014AgfYAAS Test      Contact-Create-2
+#> 1 0033s00001BXHr9AAH Test      Contact-Create-1
+#> 2 0033s00001BXHrAAAX Test      Contact-Create-2
 
 # delete these records using the Bulk 2.0 API
 deleted_records <- sf_delete(queried_records$Id, "Contact", api_type = "Bulk 2.0")
 deleted_records
-#> # A tibble: 2 x 4
+#> # A tibble: 2 × 4
 #>   Id                 sf__Id             sf__Created sf__Error
 #>   <chr>              <chr>              <lgl>       <lgl>    
-#> 1 0033s000014AgfXAAS 0033s000014AgfXAAS FALSE       NA       
-#> 2 0033s000014AgfYAAS 0033s000014AgfYAAS FALSE       NA
      
+#> 1 0033s00001BXHr9AAH 0033s00001BXHr9AAH FALSE       NA       
+#> 2 0033s00001BXHrAAAX 0033s00001BXHrAAAX FALSE       NA
      
 
      
 
      
 
      Using the Metadata API
 
      
 
      Salesforce is a very flexible platform in that it provides the Metadata API for users to create, read, update and delete their entire Salesforce environment from objects to page layouts and more. This makes it very easy to programmatically setup and teardown the Salesforce environment. One common use case for the Metadata API is retrieving information about an object (fields, permissions, etc.). You can use the sf_read_metadata() function to return a list of objects and their metadata. In the example below we retrieve the metadata for the Account and Contact objects. Note that the metadata_type argument is “CustomObject”. Standard Objects are an implementation of CustomObjects, so they are returned using that metadata type.
      
-
      +
       read_obj_result <- sf_read_metadata(metadata_type = 'CustomObject',
                                     object_names = c('Account', 'Contact'))
 
@@ -395,17 +392,17 @@ 
      Using the Metadata API#> $fields$type
 #> [1] "Picklist"
      
 
      The data is returned as a list because object definitions are highly nested representations. You may notice that we are missing some really specific details, such as, the picklist values of a field with type “Picklist”. You can get that information using sf_describe_object_fields(). Here is an example using sf_describe_object_fields() where we get a tbl_df with one row for each field on the Account object:
      
-
      +
       acct_fields <- sf_describe_object_fields('Account')
 acct_fields %>% select(name, label, length, soapType, type)
-#> # A tibble: 68 x 5
+#> # A tibble: 68 × 5
 #>   name           label            length soapType    type     
 #>   <chr>          <chr>            <chr>  <chr>       <chr>    
 #> 1 Id             Account ID       18     tns:ID      id       
 #> 2 IsDeleted      Deleted          0      xsd:boolean boolean  
 #> 3 MasterRecordId Master Record ID 18     tns:ID      reference
 #> 4 Name           Account Name     255    xsd:string  string   
-#> 5 Type           Account Type     40     xsd:string  picklist 
+#> 5 Type           Account Type     255    xsd:string  picklist 
 #> # … with 63 more rows
 
 # show the picklist selection options for the Account Type field
@@ -413,7 +410,7 @@ 
      Using the Metadata APIfilter(label == "Account Type") %>% 
   .$picklistValues
 #> [[1]]
-#> # A tibble: 7 x 4
+#> # A tibble: 7 × 4
 #>   active defaultValue label                      value                     
 #>   <chr>  <chr>        <chr>                      <chr>                     
 #> 1 true   false        Prospect                   Prospect                  
@@ -518,7 +515,7 @@ 
      Dev status
      
 
 
      
   
      
-
      Site built with pkgdown 2.0.1.
      
+
      Site built with pkgdown 2.0.2.
      
 
      
 
       
diff --git a/docs/news/index.html b/docs/news/index.html
index 2106aa5c..334be866 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -104,13 +104,14 @@ 
      Changelog 
      
 
      salesforcer 1.0.1
      
 
      
 
      Dependencies
      
-
      • Increase the package’s default Salesforce API version to 54.0 (Spring ’22).
        • 
+
        • Increase the package’s default Salesforce API version to 54.0 (Spring ’22)
          • 
 
        • Added a deprecation warning that using basic authentication (password and security token) will no longer work since Salesforce announced that all customers will be migrated to MFA beginning February 1st, 2022 (link). Many thanks to @klaw2 for highlighting in #113.
          • 
+
        • Remove deprecated use of dplyr::across() and add logic to circumvent a new warning emitted by readr::type_convert() when no character columns are present
          • 
 
      
 
      
 
      Bug fixes
      
-
      • Changed the naming convention for dashboard-related functions to contain the action verb sf_{action}_dashboard (e.g., sf_copy_dashboard)
        • 
-
      
+
      • Changed the naming convention for dashboard-related functions to contain the action verb first (e.g., sf_copy_dashboard instead of sf_dashboard_copy)
        • 
+
      
 
      
     
      
 
      salesforcer 1.0.0 release
@@ -375,7 +376,7 @@ 
      Features
-  
      Site built with pkgdown 2.0.1.
      
+  
      Site built with pkgdown 2.0.2.
      
 
      
 
       
      
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index e2446077..7efee627 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -1,5 +1,5 @@
 pandoc: 2.16.2
-pkgdown: 2.0.1
+pkgdown: 2.0.2
 pkgdown_sha: ~
 articles:
   getting-started: getting-started.html
@@ -10,7 +10,7 @@ articles:
   working-with-bulk-apis: working-with-bulk-apis.html
   working-with-metadata: working-with-metadata.html
   working-with-reports: working-with-reports.html
-last_built: 2022-02-27T18:29Z
+last_built: 2022-02-28T05:38Z
 urls:
   reference: https://stevenmmortimer.github.io/salesforcer/reference
   article: https://stevenmmortimer.github.io/salesforcer/articles
diff --git a/docs/reference/VERB_n.html b/docs/reference/VERB_n.html
index 2f0f67af..e18fec00 100644
--- a/docs/reference/VERB_n.html
+++ b/docs/reference/VERB_n.html
@@ -136,7 +136,7 @@ 
      Note
      
 
      
 
 
      
-  
      Site built with pkgdown 2.0.1.
      
+  
      Site built with pkgdown 2.0.2.
      
 
      
 
       
      
diff --git a/docs/reference/accepted_controls_by_api.html b/docs/reference/accepted_controls_by_api.html
index 8570c807..63ade120 100644
--- a/docs/reference/accepted_controls_by_api.html
+++ b/docs/reference/accepted_controls_by_api.html
@@ -140,7 +140,7 @@ 
      Note
      
 
      
 
 
      
-  
      Site built with pkgdown 2.0.1.
      
+  
      Site built with pkgdown 2.0.2.
      diff --git a/docs/reference/accepted_controls_by_operation.html b/docs/reference/accepted_controls_by_operation.html index c015dd65..f056c5d1 100644 --- a/docs/reference/accepted_controls_by_operation.html +++ b/docs/reference/accepted_controls_by_operation.html @@ -142,7 +142,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/bind_query_resultsets.html b/docs/reference/bind_query_resultsets.html index eaf86833..754f5a1d 100644 --- a/docs/reference/bind_query_resultsets.html +++ b/docs/reference/bind_query_resultsets.html @@ -147,7 +147,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/build_manifest_xml_from_list.html b/docs/reference/build_manifest_xml_from_list.html index 2f0b38c1..413cc927 100644 --- a/docs/reference/build_manifest_xml_from_list.html +++ b/docs/reference/build_manifest_xml_from_list.html @@ -142,7 +142,7 @@

      References

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/build_metadata_xml_from_list.html b/docs/reference/build_metadata_xml_from_list.html index f8a696c9..19acc05d 100644 --- a/docs/reference/build_metadata_xml_from_list.html +++ b/docs/reference/build_metadata_xml_from_list.html @@ -151,7 +151,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/build_proxy.html b/docs/reference/build_proxy.html index d8ebc68a..4de101cc 100644 --- a/docs/reference/build_proxy.html +++ b/docs/reference/build_proxy.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/build_soap_xml_from_list.html b/docs/reference/build_soap_xml_from_list.html index 3f91658c..716f630a 100644 --- a/docs/reference/build_soap_xml_from_list.html +++ b/docs/reference/build_soap_xml_from_list.html @@ -169,7 +169,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/catch_errors.html b/docs/reference/catch_errors.html index 0e2f68f3..05d78df2 100644 --- a/docs/reference/catch_errors.html +++ b/docs/reference/catch_errors.html @@ -136,7 +136,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/catch_unknown_api.html b/docs/reference/catch_unknown_api.html index 64cc87a8..bf7e216d 100644 --- a/docs/reference/catch_unknown_api.html +++ b/docs/reference/catch_unknown_api.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/check_and_encode_files.html b/docs/reference/check_and_encode_files.html index c92d8355..8b9d90e7 100644 --- a/docs/reference/check_and_encode_files.html +++ b/docs/reference/check_and_encode_files.html @@ -152,7 +152,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/collapse_list_with_dupe_names.html b/docs/reference/collapse_list_with_dupe_names.html index 75e91d9f..f5e65a91 100644 --- a/docs/reference/collapse_list_with_dupe_names.html +++ b/docs/reference/collapse_list_with_dupe_names.html @@ -149,7 +149,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/combine_parent_and_child_resultsets.html b/docs/reference/combine_parent_and_child_resultsets.html index d3565602..2a12e943 100644 --- a/docs/reference/combine_parent_and_child_resultsets.html +++ b/docs/reference/combine_parent_and_child_resultsets.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/compact2.html b/docs/reference/compact2.html index b2959548..7731e5e8 100644 --- a/docs/reference/compact2.html +++ b/docs/reference/compact2.html @@ -143,7 +143,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/drop_attributes.html b/docs/reference/drop_attributes.html index e04d3ded..b1ef2968 100644 --- a/docs/reference/drop_attributes.html +++ b/docs/reference/drop_attributes.html @@ -145,7 +145,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/drop_attributes_recursively.html b/docs/reference/drop_attributes_recursively.html index a1462f7b..125fdd03 100644 --- a/docs/reference/drop_attributes_recursively.html +++ b/docs/reference/drop_attributes_recursively.html @@ -152,7 +152,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/drop_empty_recursively.html b/docs/reference/drop_empty_recursively.html index fed365a6..bce3587a 100644 --- a/docs/reference/drop_empty_recursively.html +++ b/docs/reference/drop_empty_recursively.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/drop_nested_child_records.html b/docs/reference/drop_nested_child_records.html index 3c8646bc..169aae69 100644 --- a/docs/reference/drop_nested_child_records.html +++ b/docs/reference/drop_nested_child_records.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/extract_nested_child_records.html b/docs/reference/extract_nested_child_records.html index a8b3a0d5..0c628105 100644 --- a/docs/reference/extract_nested_child_records.html +++ b/docs/reference/extract_nested_child_records.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/extract_records_from_xml_node.html b/docs/reference/extract_records_from_xml_node.html index 2f6da447..d3363aba 100644 --- a/docs/reference/extract_records_from_xml_node.html +++ b/docs/reference/extract_records_from_xml_node.html @@ -147,7 +147,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/extract_records_from_xml_nodeset.html b/docs/reference/extract_records_from_xml_nodeset.html index ac1ccf68..26c49247 100644 --- a/docs/reference/extract_records_from_xml_nodeset.html +++ b/docs/reference/extract_records_from_xml_nodeset.html @@ -147,7 +147,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/extract_records_from_xml_nodeset_of_records.html b/docs/reference/extract_records_from_xml_nodeset_of_records.html index 7f4dc4c3..1e016d05 100644 --- a/docs/reference/extract_records_from_xml_nodeset_of_records.html +++ b/docs/reference/extract_records_from_xml_nodeset_of_records.html @@ -154,7 +154,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/filter_valid_controls.html b/docs/reference/filter_valid_controls.html index faffd705..707b1745 100644 --- a/docs/reference/filter_valid_controls.html +++ b/docs/reference/filter_valid_controls.html @@ -146,7 +146,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/flatten_tbl_df.html b/docs/reference/flatten_tbl_df.html index 680b003c..6904e0b8 100644 --- a/docs/reference/flatten_tbl_df.html +++ b/docs/reference/flatten_tbl_df.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/format_headers_for_verbose.html b/docs/reference/format_headers_for_verbose.html index 4ce72d9b..79e25222 100644 --- a/docs/reference/format_headers_for_verbose.html +++ b/docs/reference/format_headers_for_verbose.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/format_report_row.html b/docs/reference/format_report_row.html index f0e2ec58..5fa6ca82 100644 --- a/docs/reference/format_report_row.html +++ b/docs/reference/format_report_row.html @@ -169,7 +169,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/get_os.html b/docs/reference/get_os.html index 0a969be5..ffdc8f8d 100644 --- a/docs/reference/get_os.html +++ b/docs/reference/get_os.html @@ -143,7 +143,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/guess_object_name_from_soql.html b/docs/reference/guess_object_name_from_soql.html index b9919575..bd41553c 100644 --- a/docs/reference/guess_object_name_from_soql.html +++ b/docs/reference/guess_object_name_from_soql.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/index.html b/docs/reference/index.html index 22e09460..3d016b29 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -256,9 +256,57 @@

      Dashboard Functions

      Functions to create, retrieve, update, delete and query dashboards and their data.

      +

      sf_list_dashboards()

      + +

      List dashboards

      + +

      sf_describe_dashboard()

      + +

      Describe a dashboard

      + +

      sf_describe_dashboard_components()

      + +

      Describe dashboard components

      + +

      sf_get_dashboard_status()

      + +

      Get the status of a dashboard

      + +

      sf_get_dashboard_results()

      + +

      Get the results of an existing dashboard

      +

      sf_get_dashboard_data()

      Get dashboard data in a tabular format

      + +

      sf_filter_dashboard_operators_list()

      + +

      List dashboard filter operators

      + +

      sf_filter_dashboard_options_analysis()

      + +

      Get an analysis of the filter options for a dashboard

      + +

      sf_refresh_dashboard()

      + +

      Refresh an existing dashboard

      + +

      sf_copy_dashboard()

      + +

      Copy a dashboard

      + +

      sf_update_dashboard()

      + +

      Update a dashboard

      + +

      sf_set_dashboard_sticky_filter()

      + +

      Set a sticky dashboard filter

      + +

      sf_delete_dashboard()

      + +

      Delete a dashboard

      Metadata Functions

      Functions to create, retrieve, update, and delete metadata.

      @@ -447,7 +495,7 @@

      Backward Compatibility with RForc
      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/is_legit_token.html b/docs/reference/is_legit_token.html index 305014c3..6af962ad 100644 --- a/docs/reference/is_legit_token.html +++ b/docs/reference/is_legit_token.html @@ -137,7 +137,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/list_extract_parent_and_child_result.html b/docs/reference/list_extract_parent_and_child_result.html index de003f37..d328cf2c 100644 --- a/docs/reference/list_extract_parent_and_child_result.html +++ b/docs/reference/list_extract_parent_and_child_result.html @@ -146,7 +146,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_folder_child_operations_url.html b/docs/reference/make_analytics_folder_child_operations_url.html index 65b8a84a..a38985b4 100644 --- a/docs/reference/make_analytics_folder_child_operations_url.html +++ b/docs/reference/make_analytics_folder_child_operations_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_folder_collections_url.html b/docs/reference/make_analytics_folder_collections_url.html index 870f878b..f9ad9e23 100644 --- a/docs/reference/make_analytics_folder_collections_url.html +++ b/docs/reference/make_analytics_folder_collections_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_folder_operations_url.html b/docs/reference/make_analytics_folder_operations_url.html index ae0012ba..66810fda 100644 --- a/docs/reference/make_analytics_folder_operations_url.html +++ b/docs/reference/make_analytics_folder_operations_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_folder_share_by_id_url.html b/docs/reference/make_analytics_folder_share_by_id_url.html index 7611eaaf..4b3eba2f 100644 --- a/docs/reference/make_analytics_folder_share_by_id_url.html +++ b/docs/reference/make_analytics_folder_share_by_id_url.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_folder_share_recipients_url.html b/docs/reference/make_analytics_folder_share_recipients_url.html index 771dc3ff..0149bc1c 100644 --- a/docs/reference/make_analytics_folder_share_recipients_url.html +++ b/docs/reference/make_analytics_folder_share_recipients_url.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_folder_shares_url.html b/docs/reference/make_analytics_folder_shares_url.html index e1ab17ce..1e0b1b97 100644 --- a/docs/reference/make_analytics_folder_shares_url.html +++ b/docs/reference/make_analytics_folder_shares_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_notification_operations_url.html b/docs/reference/make_analytics_notification_operations_url.html index 3e2b9cef..5abe5269 100644 --- a/docs/reference/make_analytics_notification_operations_url.html +++ b/docs/reference/make_analytics_notification_operations_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_notifications_limits_url.html b/docs/reference/make_analytics_notifications_limits_url.html index 9cf20ba9..c9557c6b 100644 --- a/docs/reference/make_analytics_notifications_limits_url.html +++ b/docs/reference/make_analytics_notifications_limits_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_analytics_notifications_list_url.html b/docs/reference/make_analytics_notifications_list_url.html index a78a7a57..47456c92 100644 --- a/docs/reference/make_analytics_notifications_list_url.html +++ b/docs/reference/make_analytics_notifications_list_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_base_metadata_url.html b/docs/reference/make_base_metadata_url.html index 7c2daeee..9646198d 100644 --- a/docs/reference/make_base_metadata_url.html +++ b/docs/reference/make_base_metadata_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_base_rest_url.html b/docs/reference/make_base_rest_url.html index 76269c62..3da0b49f 100644 --- a/docs/reference/make_base_rest_url.html +++ b/docs/reference/make_base_rest_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_base_soap_url.html b/docs/reference/make_base_soap_url.html index 084884fb..85d8b4bc 100644 --- a/docs/reference/make_base_soap_url.html +++ b/docs/reference/make_base_soap_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_batch_details_url.html b/docs/reference/make_bulk_batch_details_url.html index 3e3ab9b3..5fe99179 100644 --- a/docs/reference/make_bulk_batch_details_url.html +++ b/docs/reference/make_bulk_batch_details_url.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_batch_status_url.html b/docs/reference/make_bulk_batch_status_url.html index 453d2d2b..d9a56787 100644 --- a/docs/reference/make_bulk_batch_status_url.html +++ b/docs/reference/make_bulk_batch_status_url.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_batches_url.html b/docs/reference/make_bulk_batches_url.html index 9e88f8b2..9339e113 100644 --- a/docs/reference/make_bulk_batches_url.html +++ b/docs/reference/make_bulk_batches_url.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_create_job_url.html b/docs/reference/make_bulk_create_job_url.html index eceaa5b0..8f3e70be 100644 --- a/docs/reference/make_bulk_create_job_url.html +++ b/docs/reference/make_bulk_create_job_url.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_delete_job_url.html b/docs/reference/make_bulk_delete_job_url.html index cfb34e8f..7d42659b 100644 --- a/docs/reference/make_bulk_delete_job_url.html +++ b/docs/reference/make_bulk_delete_job_url.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_end_job_generic_url.html b/docs/reference/make_bulk_end_job_generic_url.html index fc67081a..26d8fa92 100644 --- a/docs/reference/make_bulk_end_job_generic_url.html +++ b/docs/reference/make_bulk_end_job_generic_url.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_get_all_jobs_url.html b/docs/reference/make_bulk_get_all_jobs_url.html index b7c642e0..c4e83577 100644 --- a/docs/reference/make_bulk_get_all_jobs_url.html +++ b/docs/reference/make_bulk_get_all_jobs_url.html @@ -147,7 +147,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_get_all_query_jobs_url.html b/docs/reference/make_bulk_get_all_query_jobs_url.html index 9977739b..94ca061b 100644 --- a/docs/reference/make_bulk_get_all_query_jobs_url.html +++ b/docs/reference/make_bulk_get_all_query_jobs_url.html @@ -148,7 +148,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_get_job_url.html b/docs/reference/make_bulk_get_job_url.html index 7aa7d324..cb8748cb 100644 --- a/docs/reference/make_bulk_get_job_url.html +++ b/docs/reference/make_bulk_get_job_url.html @@ -148,7 +148,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_job_records_url.html b/docs/reference/make_bulk_job_records_url.html index e9ab644d..00197dc8 100644 --- a/docs/reference/make_bulk_job_records_url.html +++ b/docs/reference/make_bulk_job_records_url.html @@ -148,7 +148,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_query_result_url.html b/docs/reference/make_bulk_query_result_url.html index 3756cf4b..ed551603 100644 --- a/docs/reference/make_bulk_query_result_url.html +++ b/docs/reference/make_bulk_query_result_url.html @@ -152,7 +152,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_bulk_query_url.html b/docs/reference/make_bulk_query_url.html index b35e9c0d..9386824b 100644 --- a/docs/reference/make_bulk_query_url.html +++ b/docs/reference/make_bulk_query_url.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_chatter_users_url.html b/docs/reference/make_chatter_users_url.html index 5c201df4..086fa5bc 100644 --- a/docs/reference/make_chatter_users_url.html +++ b/docs/reference/make_chatter_users_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_composite_batch_url.html b/docs/reference/make_composite_batch_url.html index 93c95b55..ba00d003 100644 --- a/docs/reference/make_composite_batch_url.html +++ b/docs/reference/make_composite_batch_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_composite_url.html b/docs/reference/make_composite_url.html index 1b680358..da299766 100644 --- a/docs/reference/make_composite_url.html +++ b/docs/reference/make_composite_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboard_copy_url.html b/docs/reference/make_dashboard_copy_url.html index 00c0ed96..03b30890 100644 --- a/docs/reference/make_dashboard_copy_url.html +++ b/docs/reference/make_dashboard_copy_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboard_describe_url.html b/docs/reference/make_dashboard_describe_url.html index 4745cbe1..fae91178 100644 --- a/docs/reference/make_dashboard_describe_url.html +++ b/docs/reference/make_dashboard_describe_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboard_filter_operators_list_url.html b/docs/reference/make_dashboard_filter_operators_list_url.html index 70c2d261..690b9faa 100644 --- a/docs/reference/make_dashboard_filter_operators_list_url.html +++ b/docs/reference/make_dashboard_filter_operators_list_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboard_filter_options_analysis_url.html b/docs/reference/make_dashboard_filter_options_analysis_url.html index 61519e22..1c84f77f 100644 --- a/docs/reference/make_dashboard_filter_options_analysis_url.html +++ b/docs/reference/make_dashboard_filter_options_analysis_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboard_status_url.html b/docs/reference/make_dashboard_status_url.html index 239cab2e..d6294bb1 100644 --- a/docs/reference/make_dashboard_status_url.html +++ b/docs/reference/make_dashboard_status_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboard_url.html b/docs/reference/make_dashboard_url.html index e8af014d..13ebed22 100644 --- a/docs/reference/make_dashboard_url.html +++ b/docs/reference/make_dashboard_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_dashboards_list_url.html b/docs/reference/make_dashboards_list_url.html index b43ac837..ab20ef57 100644 --- a/docs/reference/make_dashboards_list_url.html +++ b/docs/reference/make_dashboards_list_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_login_url.html b/docs/reference/make_login_url.html index dff36d2d..dbac3822 100644 --- a/docs/reference/make_login_url.html +++ b/docs/reference/make_login_url.html @@ -142,7 +142,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_parameterized_search_url.html b/docs/reference/make_parameterized_search_url.html index c5275963..212b25c5 100644 --- a/docs/reference/make_parameterized_search_url.html +++ b/docs/reference/make_parameterized_search_url.html @@ -144,7 +144,7 @@

      References

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_query_url.html b/docs/reference/make_query_url.html index f5d7134e..3d016b2b 100644 --- a/docs/reference/make_query_url.html +++ b/docs/reference/make_query_url.html @@ -145,7 +145,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_copy_url.html b/docs/reference/make_report_copy_url.html index 8305e3bd..acb550dd 100644 --- a/docs/reference/make_report_copy_url.html +++ b/docs/reference/make_report_copy_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_create_url.html b/docs/reference/make_report_create_url.html index 7ccf6a49..8b979b21 100644 --- a/docs/reference/make_report_create_url.html +++ b/docs/reference/make_report_create_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_describe_url.html b/docs/reference/make_report_describe_url.html index f380f151..60f42fb7 100644 --- a/docs/reference/make_report_describe_url.html +++ b/docs/reference/make_report_describe_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_execute_url.html b/docs/reference/make_report_execute_url.html index 6b5a15b8..2ecf5fb3 100644 --- a/docs/reference/make_report_execute_url.html +++ b/docs/reference/make_report_execute_url.html @@ -148,7 +148,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_fields_url.html b/docs/reference/make_report_fields_url.html index 15c54425..915ed66d 100644 --- a/docs/reference/make_report_fields_url.html +++ b/docs/reference/make_report_fields_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_filter_operators_list_url.html b/docs/reference/make_report_filter_operators_list_url.html index 08be97e0..3cb9e0e1 100644 --- a/docs/reference/make_report_filter_operators_list_url.html +++ b/docs/reference/make_report_filter_operators_list_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_instance_url.html b/docs/reference/make_report_instance_url.html index 23645133..fcc5530a 100644 --- a/docs/reference/make_report_instance_url.html +++ b/docs/reference/make_report_instance_url.html @@ -142,7 +142,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_instances_list_url.html b/docs/reference/make_report_instances_list_url.html index 0231a61d..9821851b 100644 --- a/docs/reference/make_report_instances_list_url.html +++ b/docs/reference/make_report_instances_list_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_query_url.html b/docs/reference/make_report_query_url.html index 12f66661..68408d57 100644 --- a/docs/reference/make_report_query_url.html +++ b/docs/reference/make_report_query_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_type_describe_url.html b/docs/reference/make_report_type_describe_url.html index 10fc3005..5ae696a7 100644 --- a/docs/reference/make_report_type_describe_url.html +++ b/docs/reference/make_report_type_describe_url.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_types_list_url.html b/docs/reference/make_report_types_list_url.html index a1fe4b76..b4239b24 100644 --- a/docs/reference/make_report_types_list_url.html +++ b/docs/reference/make_report_types_list_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_report_url.html b/docs/reference/make_report_url.html index baad4b76..4761a491 100644 --- a/docs/reference/make_report_url.html +++ b/docs/reference/make_report_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_reports_list_url.html b/docs/reference/make_reports_list_url.html index 28584488..9d2c6384 100644 --- a/docs/reference/make_reports_list_url.html +++ b/docs/reference/make_reports_list_url.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_rest_describe_url.html b/docs/reference/make_rest_describe_url.html index 8959357a..a5409b83 100644 --- a/docs/reference/make_rest_describe_url.html +++ b/docs/reference/make_rest_describe_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_rest_objects_url.html b/docs/reference/make_rest_objects_url.html index e035cacb..dcdb86d3 100644 --- a/docs/reference/make_rest_objects_url.html +++ b/docs/reference/make_rest_objects_url.html @@ -138,7 +138,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_rest_record_url.html b/docs/reference/make_rest_record_url.html index 8b89e8aa..c1d54cd9 100644 --- a/docs/reference/make_rest_record_url.html +++ b/docs/reference/make_rest_record_url.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_search_url.html b/docs/reference/make_search_url.html index 9a9295d0..52477406 100644 --- a/docs/reference/make_search_url.html +++ b/docs/reference/make_search_url.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_soap_xml_skeleton.html b/docs/reference/make_soap_xml_skeleton.html index 44fb80f0..70358229 100644 --- a/docs/reference/make_soap_xml_skeleton.html +++ b/docs/reference/make_soap_xml_skeleton.html @@ -159,7 +159,7 @@

      References

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/make_verbose_httr_message.html b/docs/reference/make_verbose_httr_message.html index f99eb593..c8023a7e 100644 --- a/docs/reference/make_verbose_httr_message.html +++ b/docs/reference/make_verbose_httr_message.html @@ -155,7 +155,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/map_sf_type_to_r_type.html b/docs/reference/map_sf_type_to_r_type.html index 31c4e43f..2c985bb8 100644 --- a/docs/reference/map_sf_type_to_r_type.html +++ b/docs/reference/map_sf_type_to_r_type.html @@ -145,7 +145,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/merge_null_to_na.html b/docs/reference/merge_null_to_na.html index 8e780e11..21257e29 100644 --- a/docs/reference/merge_null_to_na.html +++ b/docs/reference/merge_null_to_na.html @@ -141,7 +141,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/message_w_errors_listed.html b/docs/reference/message_w_errors_listed.html index 1e49e3f2..5e1555a8 100644 --- a/docs/reference/message_w_errors_listed.html +++ b/docs/reference/message_w_errors_listed.html @@ -140,7 +140,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/metadata_type_validator.html b/docs/reference/metadata_type_validator.html index ccf03784..e69dfae2 100644 --- a/docs/reference/metadata_type_validator.html +++ b/docs/reference/metadata_type_validator.html @@ -15184,7 +15184,7 @@

      Details

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/parameterized_search_control.html b/docs/reference/parameterized_search_control.html index 81769ce6..bb789adf 100644 --- a/docs/reference/parameterized_search_control.html +++ b/docs/reference/parameterized_search_control.html @@ -175,7 +175,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/parse_error_code_and_message.html b/docs/reference/parse_error_code_and_message.html index c9472f8d..407cbee1 100644 --- a/docs/reference/parse_error_code_and_message.html +++ b/docs/reference/parse_error_code_and_message.html @@ -135,7 +135,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/parse_report_detail_rows.html b/docs/reference/parse_report_detail_rows.html index d8c5242f..91b39e6f 100644 --- a/docs/reference/parse_report_detail_rows.html +++ b/docs/reference/parse_report_detail_rows.html @@ -205,7 +205,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/patched_tempdir.html b/docs/reference/patched_tempdir.html index 8e2a6a84..f10e7427 100644 --- a/docs/reference/patched_tempdir.html +++ b/docs/reference/patched_tempdir.html @@ -146,7 +146,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rDELETE.html b/docs/reference/rDELETE.html index f73db966..c21bb591 100644 --- a/docs/reference/rDELETE.html +++ b/docs/reference/rDELETE.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rGET.html b/docs/reference/rGET.html index 35ff7117..d51dc771 100644 --- a/docs/reference/rGET.html +++ b/docs/reference/rGET.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rPATCH.html b/docs/reference/rPATCH.html index 2554813f..7971af3a 100644 --- a/docs/reference/rPATCH.html +++ b/docs/reference/rPATCH.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rPOST.html b/docs/reference/rPOST.html index e310b89b..0c03f4a1 100644 --- a/docs/reference/rPOST.html +++ b/docs/reference/rPOST.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rPUT.html b/docs/reference/rPUT.html index 5f5acc79..555c19f2 100644 --- a/docs/reference/rPUT.html +++ b/docs/reference/rPUT.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/records_list_to_tbl.html b/docs/reference/records_list_to_tbl.html index 520cf19f..8cf87699 100644 --- a/docs/reference/records_list_to_tbl.html +++ b/docs/reference/records_list_to_tbl.html @@ -148,7 +148,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/remove_empty_linked_object_cols.html b/docs/reference/remove_empty_linked_object_cols.html index 3965555f..1683b93f 100644 --- a/docs/reference/remove_empty_linked_object_cols.html +++ b/docs/reference/remove_empty_linked_object_cols.html @@ -140,7 +140,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/return_matching_controls.html b/docs/reference/return_matching_controls.html index 8259ee77..67086117 100644 --- a/docs/reference/return_matching_controls.html +++ b/docs/reference/return_matching_controls.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.bulkAction.html b/docs/reference/rforcecom.bulkAction.html index 1dcf6316..b8fdbbf5 100644 --- a/docs/reference/rforcecom.bulkAction.html +++ b/docs/reference/rforcecom.bulkAction.html @@ -191,7 +191,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.bulkQuery.html b/docs/reference/rforcecom.bulkQuery.html index 6db65e60..98187bb2 100644 --- a/docs/reference/rforcecom.bulkQuery.html +++ b/docs/reference/rforcecom.bulkQuery.html @@ -161,7 +161,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.create.html b/docs/reference/rforcecom.create.html index d97907b9..9262689d 100644 --- a/docs/reference/rforcecom.create.html +++ b/docs/reference/rforcecom.create.html @@ -144,7 +144,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.delete.html b/docs/reference/rforcecom.delete.html index 97d316e0..7f6d55b2 100644 --- a/docs/reference/rforcecom.delete.html +++ b/docs/reference/rforcecom.delete.html @@ -144,7 +144,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.getObjectDescription.html b/docs/reference/rforcecom.getObjectDescription.html index 6a437f31..9e423054 100644 --- a/docs/reference/rforcecom.getObjectDescription.html +++ b/docs/reference/rforcecom.getObjectDescription.html @@ -146,7 +146,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.getServerTimestamp.html b/docs/reference/rforcecom.getServerTimestamp.html index baa73abe..72145212 100644 --- a/docs/reference/rforcecom.getServerTimestamp.html +++ b/docs/reference/rforcecom.getServerTimestamp.html @@ -135,7 +135,7 @@

      Arguments

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.login.html b/docs/reference/rforcecom.login.html index 92d8fed5..85fc3c19 100644 --- a/docs/reference/rforcecom.login.html +++ b/docs/reference/rforcecom.login.html @@ -150,7 +150,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.query.html b/docs/reference/rforcecom.query.html index 2796fa82..e5f3105d 100644 --- a/docs/reference/rforcecom.query.html +++ b/docs/reference/rforcecom.query.html @@ -145,7 +145,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.retrieve.html b/docs/reference/rforcecom.retrieve.html index 3beb7715..360f9d14 100644 --- a/docs/reference/rforcecom.retrieve.html +++ b/docs/reference/rforcecom.retrieve.html @@ -167,7 +167,7 @@

      Arguments

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.search.html b/docs/reference/rforcecom.search.html index 71e3f0c2..e035b8d8 100644 --- a/docs/reference/rforcecom.search.html +++ b/docs/reference/rforcecom.search.html @@ -137,7 +137,7 @@

      Arguments

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.update.html b/docs/reference/rforcecom.update.html index 44381ff8..f5a9d91c 100644 --- a/docs/reference/rforcecom.update.html +++ b/docs/reference/rforcecom.update.html @@ -146,7 +146,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/rforcecom.upsert.html b/docs/reference/rforcecom.upsert.html index b754c94a..d8cbe0b6 100644 --- a/docs/reference/rforcecom.upsert.html +++ b/docs/reference/rforcecom.upsert.html @@ -148,7 +148,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/safe_bind_rows.html b/docs/reference/safe_bind_rows.html index b0d01d13..d5c70d47 100644 --- a/docs/reference/safe_bind_rows.html +++ b/docs/reference/safe_bind_rows.html @@ -150,7 +150,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/salesforcer-package.html b/docs/reference/salesforcer-package.html index 6d16780b..08a352bd 100644 --- a/docs/reference/salesforcer-package.html +++ b/docs/reference/salesforcer-package.html @@ -141,7 +141,7 @@

      Author

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/salesforcer_state.html b/docs/reference/salesforcer_state.html index ec3fce44..aab545f9 100644 --- a/docs/reference/salesforcer_state.html +++ b/docs/reference/salesforcer_state.html @@ -130,7 +130,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/session_id_available.html b/docs/reference/session_id_available.html index 6e107dd2..ff1be365 100644 --- a/docs/reference/session_id_available.html +++ b/docs/reference/session_id_available.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/set_null_elements_to_na.html b/docs/reference/set_null_elements_to_na.html index 9ecd91de..3f151012 100644 --- a/docs/reference/set_null_elements_to_na.html +++ b/docs/reference/set_null_elements_to_na.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/set_null_elements_to_na_recursively.html b/docs/reference/set_null_elements_to_na_recursively.html index 838a59e2..de2fc8a1 100644 --- a/docs/reference/set_null_elements_to_na_recursively.html +++ b/docs/reference/set_null_elements_to_na_recursively.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_abort_job_bulk.html b/docs/reference/sf_abort_job_bulk.html index e945d694..3d435d94 100644 --- a/docs/reference/sf_abort_job_bulk.html +++ b/docs/reference/sf_abort_job_bulk.html @@ -157,7 +157,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_access_token.html b/docs/reference/sf_access_token.html index 4334f19b..83ea52ef 100644 --- a/docs/reference/sf_access_token.html +++ b/docs/reference/sf_access_token.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_analytics_notification_create.html b/docs/reference/sf_analytics_notification_create.html index 5d566d36..55554267 100644 --- a/docs/reference/sf_analytics_notification_create.html +++ b/docs/reference/sf_analytics_notification_create.html @@ -135,7 +135,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_analytics_notification_delete.html b/docs/reference/sf_analytics_notification_delete.html index 649e8ca8..bfb68d23 100644 --- a/docs/reference/sf_analytics_notification_delete.html +++ b/docs/reference/sf_analytics_notification_delete.html @@ -132,7 +132,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_analytics_notification_describe.html b/docs/reference/sf_analytics_notification_describe.html index 12d82a28..9845c59e 100644 --- a/docs/reference/sf_analytics_notification_describe.html +++ b/docs/reference/sf_analytics_notification_describe.html @@ -132,7 +132,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_analytics_notification_update.html b/docs/reference/sf_analytics_notification_update.html index 5d04b42f..53ab0142 100644 --- a/docs/reference/sf_analytics_notification_update.html +++ b/docs/reference/sf_analytics_notification_update.html @@ -138,7 +138,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_analytics_notifications_limits.html b/docs/reference/sf_analytics_notifications_limits.html index 6f265a49..faaf524c 100644 --- a/docs/reference/sf_analytics_notifications_limits.html +++ b/docs/reference/sf_analytics_notifications_limits.html @@ -151,7 +151,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_analytics_notifications_list.html b/docs/reference/sf_analytics_notifications_list.html index 223f0c80..0bdb59a3 100644 --- a/docs/reference/sf_analytics_notifications_list.html +++ b/docs/reference/sf_analytics_notifications_list.html @@ -156,7 +156,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_auth.html b/docs/reference/sf_auth.html index df338f7c..2b08d874 100644 --- a/docs/reference/sf_auth.html +++ b/docs/reference/sf_auth.html @@ -226,7 +226,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_auth_check.html b/docs/reference/sf_auth_check.html index 3b109ba6..d41202da 100644 --- a/docs/reference/sf_auth_check.html +++ b/docs/reference/sf_auth_check.html @@ -150,7 +150,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_auth_refresh.html b/docs/reference/sf_auth_refresh.html index 9a9396ae..77ee9ffb 100644 --- a/docs/reference/sf_auth_refresh.html +++ b/docs/reference/sf_auth_refresh.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_batch_details_bulk.html b/docs/reference/sf_batch_details_bulk.html index 1e68a82b..4d3014d8 100644 --- a/docs/reference/sf_batch_details_bulk.html +++ b/docs/reference/sf_batch_details_bulk.html @@ -173,7 +173,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_batch_status_bulk.html b/docs/reference/sf_batch_status_bulk.html index ea49debe..c57acafd 100644 --- a/docs/reference/sf_batch_status_bulk.html +++ b/docs/reference/sf_batch_status_bulk.html @@ -172,7 +172,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_build_cols_spec.html b/docs/reference/sf_build_cols_spec.html index f9893e6a..1143e0ee 100644 --- a/docs/reference/sf_build_cols_spec.html +++ b/docs/reference/sf_build_cols_spec.html @@ -137,7 +137,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_close_job_bulk.html b/docs/reference/sf_close_job_bulk.html index 4abe4cfd..c110154d 100644 --- a/docs/reference/sf_close_job_bulk.html +++ b/docs/reference/sf_close_job_bulk.html @@ -166,7 +166,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_control.html b/docs/reference/sf_control.html index 3a51efeb..1b6504f5 100644 --- a/docs/reference/sf_control.html +++ b/docs/reference/sf_control.html @@ -291,7 +291,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_convert_lead.html b/docs/reference/sf_convert_lead.html index 9711ec76..3431d24e 100644 --- a/docs/reference/sf_convert_lead.html +++ b/docs/reference/sf_convert_lead.html @@ -253,7 +253,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_copy_dashboard.html b/docs/reference/sf_copy_dashboard.html new file mode 100644 index 00000000..0bc8539e --- /dev/null +++ b/docs/reference/sf_copy_dashboard.html @@ -0,0 +1,159 @@ + +Copy a dashboard — sf_copy_dashboard • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Copy a dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_copy_dashboard(dashboard_id, report_folder_id)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      report_folder_id
      +

      character; the Salesforce Id assigned to a created +analytics folder (it will start with "00l").

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_copy_report.html b/docs/reference/sf_copy_report.html index 8d49ce95..f39ac4ef 100644 --- a/docs/reference/sf_copy_report.html +++ b/docs/reference/sf_copy_report.html @@ -202,7 +202,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create.html b/docs/reference/sf_create.html index 5418d8b9..84f02bbb 100644 --- a/docs/reference/sf_create.html +++ b/docs/reference/sf_create.html @@ -200,7 +200,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_attachment.html b/docs/reference/sf_create_attachment.html index 3991d307..65d3e1d7 100644 --- a/docs/reference/sf_create_attachment.html +++ b/docs/reference/sf_create_attachment.html @@ -223,7 +223,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_attachment_bulk_v1.html b/docs/reference/sf_create_attachment_bulk_v1.html index a8518827..50885e2a 100644 --- a/docs/reference/sf_create_attachment_bulk_v1.html +++ b/docs/reference/sf_create_attachment_bulk_v1.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_attachment_rest.html b/docs/reference/sf_create_attachment_rest.html index c852e591..d4ca4972 100644 --- a/docs/reference/sf_create_attachment_rest.html +++ b/docs/reference/sf_create_attachment_rest.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_attachment_soap.html b/docs/reference/sf_create_attachment_soap.html index 25be2f2f..e4f48eef 100644 --- a/docs/reference/sf_create_attachment_soap.html +++ b/docs/reference/sf_create_attachment_soap.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_batches_bulk.html b/docs/reference/sf_create_batches_bulk.html index 4472edb8..40cf1465 100644 --- a/docs/reference/sf_create_batches_bulk.html +++ b/docs/reference/sf_create_batches_bulk.html @@ -183,7 +183,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_bulk_v1.html b/docs/reference/sf_create_bulk_v1.html index e5b08a62..8c0de212 100644 --- a/docs/reference/sf_create_bulk_v1.html +++ b/docs/reference/sf_create_bulk_v1.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_bulk_v2.html b/docs/reference/sf_create_bulk_v2.html index 7706e6d6..97c838fb 100644 --- a/docs/reference/sf_create_bulk_v2.html +++ b/docs/reference/sf_create_bulk_v2.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_job_bulk.html b/docs/reference/sf_create_job_bulk.html index 44978a11..c74809e2 100644 --- a/docs/reference/sf_create_job_bulk.html +++ b/docs/reference/sf_create_job_bulk.html @@ -222,7 +222,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_job_bulk_v1.html b/docs/reference/sf_create_job_bulk_v1.html index 62ab6d32..f72bbfca 100644 --- a/docs/reference/sf_create_job_bulk_v1.html +++ b/docs/reference/sf_create_job_bulk_v1.html @@ -174,7 +174,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_job_bulk_v2.html b/docs/reference/sf_create_job_bulk_v2.html index 25afba52..87d3a0cb 100644 --- a/docs/reference/sf_create_job_bulk_v2.html +++ b/docs/reference/sf_create_job_bulk_v2.html @@ -176,7 +176,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_metadata.html b/docs/reference/sf_create_metadata.html index 839c9807..12242741 100644 --- a/docs/reference/sf_create_metadata.html +++ b/docs/reference/sf_create_metadata.html @@ -219,7 +219,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_report.html b/docs/reference/sf_create_report.html index 7a19bcdb..76286d5b 100644 --- a/docs/reference/sf_create_report.html +++ b/docs/reference/sf_create_report.html @@ -223,7 +223,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_rest.html b/docs/reference/sf_create_rest.html index 2ec1f5e6..1b6daabd 100644 --- a/docs/reference/sf_create_rest.html +++ b/docs/reference/sf_create_rest.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_create_soap.html b/docs/reference/sf_create_soap.html index 9f247230..92a0e615 100644 --- a/docs/reference/sf_create_soap.html +++ b/docs/reference/sf_create_soap.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete.html b/docs/reference/sf_delete.html index 5a56ac45..a02b25e0 100644 --- a/docs/reference/sf_delete.html +++ b/docs/reference/sf_delete.html @@ -194,7 +194,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_attachment.html b/docs/reference/sf_delete_attachment.html index 046eba60..6ccb95e1 100644 --- a/docs/reference/sf_delete_attachment.html +++ b/docs/reference/sf_delete_attachment.html @@ -194,7 +194,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_bulk_v1.html b/docs/reference/sf_delete_bulk_v1.html index 44cfd2fc..8fd52bdc 100644 --- a/docs/reference/sf_delete_bulk_v1.html +++ b/docs/reference/sf_delete_bulk_v1.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_bulk_v2.html b/docs/reference/sf_delete_bulk_v2.html index 9700a115..cbde937e 100644 --- a/docs/reference/sf_delete_bulk_v2.html +++ b/docs/reference/sf_delete_bulk_v2.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_dashboard.html b/docs/reference/sf_delete_dashboard.html new file mode 100644 index 00000000..f1055ea3 --- /dev/null +++ b/docs/reference/sf_delete_dashboard.html @@ -0,0 +1,156 @@ + +Delete a dashboard — sf_delete_dashboard • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Delete a dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_delete_dashboard(dashboard_id)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      +
      +

      Value

      +

      logical

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_delete_job_bulk.html b/docs/reference/sf_delete_job_bulk.html index cb15b8c7..5704365f 100644 --- a/docs/reference/sf_delete_job_bulk.html +++ b/docs/reference/sf_delete_job_bulk.html @@ -146,7 +146,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_metadata.html b/docs/reference/sf_delete_metadata.html index 426bc75a..7a862ab3 100644 --- a/docs/reference/sf_delete_metadata.html +++ b/docs/reference/sf_delete_metadata.html @@ -168,7 +168,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_report.html b/docs/reference/sf_delete_report.html index c24c31e8..1bedf69f 100644 --- a/docs/reference/sf_delete_report.html +++ b/docs/reference/sf_delete_report.html @@ -178,7 +178,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_report_instance.html b/docs/reference/sf_delete_report_instance.html index d003d164..aaa35c7b 100644 --- a/docs/reference/sf_delete_report_instance.html +++ b/docs/reference/sf_delete_report_instance.html @@ -174,7 +174,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_rest.html b/docs/reference/sf_delete_rest.html index 249025a0..fb4521ee 100644 --- a/docs/reference/sf_delete_rest.html +++ b/docs/reference/sf_delete_rest.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_delete_soap.html b/docs/reference/sf_delete_soap.html index e1d11da0..86167ec8 100644 --- a/docs/reference/sf_delete_soap.html +++ b/docs/reference/sf_delete_soap.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_describe_dashboard.html b/docs/reference/sf_describe_dashboard.html new file mode 100644 index 00000000..8392f051 --- /dev/null +++ b/docs/reference/sf_describe_dashboard.html @@ -0,0 +1,175 @@ + +Describe a dashboard — sf_describe_dashboard • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Describe a dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +

      Returns metadata for the specified dashboard, including dashboard components, +filters, layout, and the running user.

      +
      + +
      + 
      sf_describe_dashboard(dashboard_id, as_tbl = TRUE, verbose = FALSE)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      as_tbl
      +

      logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

      +
      verbose
      +

      logical; an indicator of whether to print additional +detail for each API call, which is useful for debugging. More specifically, when +set to TRUE the URL, header, and body will be printed for each request, +along with additional diagnostic information where available.

      +
      +
      +

      Value

      +

      list or tbl_df depending on the value of argument as_tbl

      +
      + + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_describe_dashboard_components.html b/docs/reference/sf_describe_dashboard_components.html new file mode 100644 index 00000000..204455c1 --- /dev/null +++ b/docs/reference/sf_describe_dashboard_components.html @@ -0,0 +1,159 @@ + +Describe dashboard components — sf_describe_dashboard_components • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Describe dashboard components

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_describe_dashboard_components(dashboard_id, component_ids = c(character(0)))
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      component_ids
      +

      character; a vector of Unique Salesforce Ids of a +dashboard component.

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_describe_metadata.html b/docs/reference/sf_describe_metadata.html index 30cd6918..8611faf6 100644 --- a/docs/reference/sf_describe_metadata.html +++ b/docs/reference/sf_describe_metadata.html @@ -148,7 +148,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_describe_object_fields.html b/docs/reference/sf_describe_object_fields.html index 5aa02462..4b7a75e5 100644 --- a/docs/reference/sf_describe_object_fields.html +++ b/docs/reference/sf_describe_object_fields.html @@ -148,7 +148,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_describe_objects.html b/docs/reference/sf_describe_objects.html index b8795bc2..076b8d12 100644 --- a/docs/reference/sf_describe_objects.html +++ b/docs/reference/sf_describe_objects.html @@ -170,7 +170,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_describe_report.html b/docs/reference/sf_describe_report.html index 1d333c01..9e00a6e7 100644 --- a/docs/reference/sf_describe_report.html +++ b/docs/reference/sf_describe_report.html @@ -198,7 +198,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_describe_report_type.html b/docs/reference/sf_describe_report_type.html index 6ee62c3d..5edd11ec 100644 --- a/docs/reference/sf_describe_report_type.html +++ b/docs/reference/sf_describe_report_type.html @@ -192,7 +192,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_download_attachment.html b/docs/reference/sf_download_attachment.html index 2cc9bb1e..c8edb233 100644 --- a/docs/reference/sf_download_attachment.html +++ b/docs/reference/sf_download_attachment.html @@ -191,7 +191,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_empty_recycle_bin.html b/docs/reference/sf_empty_recycle_bin.html index 1c794f2a..2fd2f119 100644 --- a/docs/reference/sf_empty_recycle_bin.html +++ b/docs/reference/sf_empty_recycle_bin.html @@ -181,7 +181,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_end_job_bulk.html b/docs/reference/sf_end_job_bulk.html index 87657f37..6324cc89 100644 --- a/docs/reference/sf_end_job_bulk.html +++ b/docs/reference/sf_end_job_bulk.html @@ -154,7 +154,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_execute_report.html b/docs/reference/sf_execute_report.html index b0aefecb..f3cba4aa 100644 --- a/docs/reference/sf_execute_report.html +++ b/docs/reference/sf_execute_report.html @@ -303,7 +303,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_filter_dashboard_operators_list.html b/docs/reference/sf_filter_dashboard_operators_list.html new file mode 100644 index 00000000..8958bac1 --- /dev/null +++ b/docs/reference/sf_filter_dashboard_operators_list.html @@ -0,0 +1,150 @@ + +List dashboard filter operators — sf_filter_dashboard_operators_list • salesforcer + + +
      +
      + + + +
      +
      +
      +

      List dashboard filter operators

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_filter_dashboard_operators_list()
      +
      + +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_filter_dashboard_options_analysis.html b/docs/reference/sf_filter_dashboard_options_analysis.html new file mode 100644 index 00000000..5e4ea924 --- /dev/null +++ b/docs/reference/sf_filter_dashboard_options_analysis.html @@ -0,0 +1,167 @@ + +Get an analysis of the filter options for a dashboard — sf_filter_dashboard_options_analysis • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Get an analysis of the filter options for a dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_filter_dashboard_options_analysis(
+  dashboard_id,
+  filter_columns = list(),
+  options = list()
+)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      filter_columns
      +

      list; a list of fields from the source report +which you check filter values against. Each object in the array has these +properties:...

      +
      options
      +

      list; a list of objects describing a dashboard filter. +Each object has these properties:...

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_find_duplicates.html b/docs/reference/sf_find_duplicates.html index aa4785e9..f9049351 100644 --- a/docs/reference/sf_find_duplicates.html +++ b/docs/reference/sf_find_duplicates.html @@ -182,7 +182,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_find_duplicates_by_id.html b/docs/reference/sf_find_duplicates_by_id.html index 1c86b159..b4f9045e 100644 --- a/docs/reference/sf_find_duplicates_by_id.html +++ b/docs/reference/sf_find_duplicates_by_id.html @@ -173,7 +173,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_format_date.html b/docs/reference/sf_format_date.html index 0ff93a4c..0ce9e14b 100644 --- a/docs/reference/sf_format_date.html +++ b/docs/reference/sf_format_date.html @@ -141,7 +141,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_format_datetime.html b/docs/reference/sf_format_datetime.html index b2a669fb..c9fe6e53 100644 --- a/docs/reference/sf_format_datetime.html +++ b/docs/reference/sf_format_datetime.html @@ -142,7 +142,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_format_time.html b/docs/reference/sf_format_time.html index e05abda1..8453c0f6 100644 --- a/docs/reference/sf_format_time.html +++ b/docs/reference/sf_format_time.html @@ -174,7 +174,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_all_jobs_bulk.html b/docs/reference/sf_get_all_jobs_bulk.html index 051a3a57..a36d25a6 100644 --- a/docs/reference/sf_get_all_jobs_bulk.html +++ b/docs/reference/sf_get_all_jobs_bulk.html @@ -174,7 +174,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_all_query_jobs_bulk.html b/docs/reference/sf_get_all_query_jobs_bulk.html index 5e8f434d..8ca7de95 100644 --- a/docs/reference/sf_get_all_query_jobs_bulk.html +++ b/docs/reference/sf_get_all_query_jobs_bulk.html @@ -180,7 +180,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_dashboard_data.html b/docs/reference/sf_get_dashboard_data.html index 75848e7d..e98c704c 100644 --- a/docs/reference/sf_get_dashboard_data.html +++ b/docs/reference/sf_get_dashboard_data.html @@ -124,10 +124,11 @@

      Arguments

      start with "005"). Note that this will throw an error if the User is not allowed to change the running User, or if the selected running User is invalid.

      dashboard_filters
      -

      character; Dashboard results are always unfiltered, unless you -have specified filter parameters in your request. Use this argument to include -up to three optional filter Ids. You can obtain the list of defined filter Ids -from the dashboard metadata using sf_dashboard_describe.

      +

      character; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +sf_describe_dashboard.

      Value

      @@ -146,7 +147,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_dashboard_results.html b/docs/reference/sf_get_dashboard_results.html new file mode 100644 index 00000000..1be34506 --- /dev/null +++ b/docs/reference/sf_get_dashboard_results.html @@ -0,0 +1,177 @@ + +Get the results of an existing dashboard — sf_get_dashboard_results • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Get the results of an existing dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +

      This function allows for pulling specific data from a dashboard. There is a +convenience function (sf_get_dashboard_data) to get the dashboard data +in a tabular format returned as a tbl_df.

      +
      + +
      + 
      sf_get_dashboard_results(
+  dashboard_id,
+  running_user = NULL,
+  dashboard_filters = c(character(0))
+)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      running_user
      +

      character; the Salesforce Id that should be assigned +as the runner of the job. This should be from a User record (i.e. the Id will +start with "005"). Note that this will throw an error if the User is not +allowed to change the running User, or if the selected running User is invalid.

      +
      dashboard_filters
      +

      character; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +sf_describe_dashboard.

      +
      +
      +

      Value

      +

      tbl_df

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_get_dashboard_status.html b/docs/reference/sf_get_dashboard_status.html new file mode 100644 index 00000000..23e1798c --- /dev/null +++ b/docs/reference/sf_get_dashboard_status.html @@ -0,0 +1,171 @@ + +Get the status of a dashboard — sf_get_dashboard_status • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Get the status of a dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_get_dashboard_status(
+  dashboard_id,
+  running_user = NULL,
+  dashboard_filters = c(character(0))
+)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      running_user
      +

      character; the Salesforce Id that should be assigned +as the runner of the job. This should be from a User record (i.e. the Id will +start with "005"). Note that this will throw an error if the User is not +allowed to change the running User, or if the selected running User is invalid.

      +
      dashboard_filters
      +

      character; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +sf_describe_dashboard.

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_get_deleted.html b/docs/reference/sf_get_deleted.html index 7c0665ff..0817f43d 100644 --- a/docs/reference/sf_get_deleted.html +++ b/docs/reference/sf_get_deleted.html @@ -155,7 +155,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_job_bulk.html b/docs/reference/sf_get_job_bulk.html index e35fd6dc..9fa477b7 100644 --- a/docs/reference/sf_get_job_bulk.html +++ b/docs/reference/sf_get_job_bulk.html @@ -163,7 +163,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_job_records_bulk.html b/docs/reference/sf_get_job_records_bulk.html index bccd6065..043672af 100644 --- a/docs/reference/sf_get_job_records_bulk.html +++ b/docs/reference/sf_get_job_records_bulk.html @@ -179,7 +179,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_report_instance_results.html b/docs/reference/sf_get_report_instance_results.html index 7e82857e..f44bb2b2 100644 --- a/docs/reference/sf_get_report_instance_results.html +++ b/docs/reference/sf_get_report_instance_results.html @@ -250,7 +250,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_get_updated.html b/docs/reference/sf_get_updated.html index 59d50911..b7f574c6 100644 --- a/docs/reference/sf_get_updated.html +++ b/docs/reference/sf_get_updated.html @@ -155,7 +155,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_guess_cols.html b/docs/reference/sf_guess_cols.html index d1b5f6ee..4a7f775c 100644 --- a/docs/reference/sf_guess_cols.html +++ b/docs/reference/sf_guess_cols.html @@ -135,7 +135,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_input_data_validation.html b/docs/reference/sf_input_data_validation.html index e16b7dda..dc0803ea 100644 --- a/docs/reference/sf_input_data_validation.html +++ b/docs/reference/sf_input_data_validation.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_job_batches_bulk.html b/docs/reference/sf_job_batches_bulk.html index a65bbc70..c85f1632 100644 --- a/docs/reference/sf_job_batches_bulk.html +++ b/docs/reference/sf_job_batches_bulk.html @@ -163,7 +163,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_api_limits.html b/docs/reference/sf_list_api_limits.html index 62cf9013..0e3acc2f 100644 --- a/docs/reference/sf_list_api_limits.html +++ b/docs/reference/sf_list_api_limits.html @@ -164,7 +164,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_dashboards.html b/docs/reference/sf_list_dashboards.html new file mode 100644 index 00000000..3a523899 --- /dev/null +++ b/docs/reference/sf_list_dashboards.html @@ -0,0 +1,170 @@ + +List dashboards — sf_list_dashboards • salesforcer + + +
      +
      + + + +
      +
      +
      +

      List dashboards

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +

      Returns a list of recently used dashboards

      +
      + +
      + 
      sf_list_dashboards(as_tbl = TRUE, verbose = FALSE)
      +
      + +
      +

      Arguments

      +
      as_tbl
      +

      logical; an indicator of whether to convert the parsed +JSON into a tbl_df.

      +
      verbose
      +

      logical; an indicator of whether to print additional +detail for each API call, which is useful for debugging. More specifically, when +set to TRUE the URL, header, and body will be printed for each request, +along with additional diagnostic information where available.

      +
      +
      +

      Value

      +

      list or tbl_df depending on the value of argument as_tbl

      +
      + + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_list_metadata.html b/docs/reference/sf_list_metadata.html index 4a1001c4..ab0c7896 100644 --- a/docs/reference/sf_list_metadata.html +++ b/docs/reference/sf_list_metadata.html @@ -161,7 +161,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_objects.html b/docs/reference/sf_list_objects.html index be4b47da..0507209c 100644 --- a/docs/reference/sf_list_objects.html +++ b/docs/reference/sf_list_objects.html @@ -135,7 +135,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_report_fields.html b/docs/reference/sf_list_report_fields.html index 6925f4df..3e77dd74 100644 --- a/docs/reference/sf_list_report_fields.html +++ b/docs/reference/sf_list_report_fields.html @@ -203,7 +203,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_report_filter_operators.html b/docs/reference/sf_list_report_filter_operators.html index 06a1899f..c14be0d9 100644 --- a/docs/reference/sf_list_report_filter_operators.html +++ b/docs/reference/sf_list_report_filter_operators.html @@ -178,7 +178,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_report_instances.html b/docs/reference/sf_list_report_instances.html index 974871ea..596b7470 100644 --- a/docs/reference/sf_list_report_instances.html +++ b/docs/reference/sf_list_report_instances.html @@ -177,7 +177,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_report_types.html b/docs/reference/sf_list_report_types.html index 4e6c9085..4c73cbf2 100644 --- a/docs/reference/sf_list_report_types.html +++ b/docs/reference/sf_list_report_types.html @@ -173,7 +173,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_reports.html b/docs/reference/sf_list_reports.html index bb0c1009..433d448b 100644 --- a/docs/reference/sf_list_reports.html +++ b/docs/reference/sf_list_reports.html @@ -197,7 +197,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_resources.html b/docs/reference/sf_list_resources.html index 251410c7..c4e763cb 100644 --- a/docs/reference/sf_list_resources.html +++ b/docs/reference/sf_list_resources.html @@ -137,7 +137,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_list_rest_api_versions.html b/docs/reference/sf_list_rest_api_versions.html index a1af3e95..78ef6c37 100644 --- a/docs/reference/sf_list_rest_api_versions.html +++ b/docs/reference/sf_list_rest_api_versions.html @@ -137,7 +137,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_merge.html b/docs/reference/sf_merge.html index 9bea4221..d6427881 100644 --- a/docs/reference/sf_merge.html +++ b/docs/reference/sf_merge.html @@ -201,7 +201,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query.html b/docs/reference/sf_query.html index f3aea7ff..b7aef3a5 100644 --- a/docs/reference/sf_query.html +++ b/docs/reference/sf_query.html @@ -223,7 +223,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query_bulk_v1.html b/docs/reference/sf_query_bulk_v1.html index 4590e497..3e641ddb 100644 --- a/docs/reference/sf_query_bulk_v1.html +++ b/docs/reference/sf_query_bulk_v1.html @@ -207,7 +207,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query_bulk_v2.html b/docs/reference/sf_query_bulk_v2.html index 9458aebe..203ae973 100644 --- a/docs/reference/sf_query_bulk_v2.html +++ b/docs/reference/sf_query_bulk_v2.html @@ -207,7 +207,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query_report.html b/docs/reference/sf_query_report.html index 6723f965..a5fb9aef 100644 --- a/docs/reference/sf_query_report.html +++ b/docs/reference/sf_query_report.html @@ -202,7 +202,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query_result_bulk.html b/docs/reference/sf_query_result_bulk.html index 2b6c5d27..28b09392 100644 --- a/docs/reference/sf_query_result_bulk.html +++ b/docs/reference/sf_query_result_bulk.html @@ -195,7 +195,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query_result_bulk_v1.html b/docs/reference/sf_query_result_bulk_v1.html index ac1d93ee..2107a3e3 100644 --- a/docs/reference/sf_query_result_bulk_v1.html +++ b/docs/reference/sf_query_result_bulk_v1.html @@ -191,7 +191,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_query_result_bulk_v2.html b/docs/reference/sf_query_result_bulk_v2.html index 2f0f6393..3121ebfb 100644 --- a/docs/reference/sf_query_result_bulk_v2.html +++ b/docs/reference/sf_query_result_bulk_v2.html @@ -194,7 +194,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_read_metadata.html b/docs/reference/sf_read_metadata.html index af354678..873df0a2 100644 --- a/docs/reference/sf_read_metadata.html +++ b/docs/reference/sf_read_metadata.html @@ -154,7 +154,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_refresh_dashboard.html b/docs/reference/sf_refresh_dashboard.html new file mode 100644 index 00000000..09643def --- /dev/null +++ b/docs/reference/sf_refresh_dashboard.html @@ -0,0 +1,162 @@ + +Refresh an existing dashboard — sf_refresh_dashboard • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Refresh an existing dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_refresh_dashboard(dashboard_id, dashboard_filters = c(character(0)))
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      dashboard_filters
      +

      character; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +sf_describe_dashboard.

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_rename_metadata.html b/docs/reference/sf_rename_metadata.html index cab3db4e..290e44cd 100644 --- a/docs/reference/sf_rename_metadata.html +++ b/docs/reference/sf_rename_metadata.html @@ -159,7 +159,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_reorder_cols.html b/docs/reference/sf_reorder_cols.html index 9a6a04cd..01ed855d 100644 --- a/docs/reference/sf_reorder_cols.html +++ b/docs/reference/sf_reorder_cols.html @@ -135,7 +135,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_children.html b/docs/reference/sf_report_folder_children.html index b1305f9b..6af9a976 100644 --- a/docs/reference/sf_report_folder_children.html +++ b/docs/reference/sf_report_folder_children.html @@ -133,7 +133,7 @@

      Arguments

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_create.html b/docs/reference/sf_report_folder_create.html index 68e7c89b..32b024ae 100644 --- a/docs/reference/sf_report_folder_create.html +++ b/docs/reference/sf_report_folder_create.html @@ -135,7 +135,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_delete.html b/docs/reference/sf_report_folder_delete.html index 9376d043..de00cb00 100644 --- a/docs/reference/sf_report_folder_delete.html +++ b/docs/reference/sf_report_folder_delete.html @@ -132,7 +132,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_describe.html b/docs/reference/sf_report_folder_describe.html index 58a4b85c..df0c0264 100644 --- a/docs/reference/sf_report_folder_describe.html +++ b/docs/reference/sf_report_folder_describe.html @@ -132,7 +132,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_share_delete.html b/docs/reference/sf_report_folder_share_delete.html index 8c2a2d8c..508659f9 100644 --- a/docs/reference/sf_report_folder_share_delete.html +++ b/docs/reference/sf_report_folder_share_delete.html @@ -135,7 +135,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_share_describe.html b/docs/reference/sf_report_folder_share_describe.html index 1ba5af06..0ac09aa5 100644 --- a/docs/reference/sf_report_folder_share_describe.html +++ b/docs/reference/sf_report_folder_share_describe.html @@ -135,7 +135,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_share_recipients.html b/docs/reference/sf_report_folder_share_recipients.html index b1989605..2e88042c 100644 --- a/docs/reference/sf_report_folder_share_recipients.html +++ b/docs/reference/sf_report_folder_share_recipients.html @@ -145,7 +145,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_share_update.html b/docs/reference/sf_report_folder_share_update.html index a6c153e2..a1084384 100644 --- a/docs/reference/sf_report_folder_share_update.html +++ b/docs/reference/sf_report_folder_share_update.html @@ -141,7 +141,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_shares_add.html b/docs/reference/sf_report_folder_shares_add.html index e656ec45..a19eaf3f 100644 --- a/docs/reference/sf_report_folder_shares_add.html +++ b/docs/reference/sf_report_folder_shares_add.html @@ -140,7 +140,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_shares_list.html b/docs/reference/sf_report_folder_shares_list.html index 5b9ec59a..06c20ec0 100644 --- a/docs/reference/sf_report_folder_shares_list.html +++ b/docs/reference/sf_report_folder_shares_list.html @@ -132,7 +132,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_shares_update.html b/docs/reference/sf_report_folder_shares_update.html index 3d3930eb..b5fe5ba8 100644 --- a/docs/reference/sf_report_folder_shares_update.html +++ b/docs/reference/sf_report_folder_shares_update.html @@ -140,7 +140,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folder_update.html b/docs/reference/sf_report_folder_update.html index ba5ccca2..e4588aaa 100644 --- a/docs/reference/sf_report_folder_update.html +++ b/docs/reference/sf_report_folder_update.html @@ -138,7 +138,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_report_folders_list.html b/docs/reference/sf_report_folders_list.html index c6e6eb95..05964980 100644 --- a/docs/reference/sf_report_folders_list.html +++ b/docs/reference/sf_report_folders_list.html @@ -126,7 +126,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_reset_password.html b/docs/reference/sf_reset_password.html index 709410f3..490aedac 100644 --- a/docs/reference/sf_reset_password.html +++ b/docs/reference/sf_reset_password.html @@ -155,7 +155,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_rest_list.html b/docs/reference/sf_rest_list.html index 18d2139c..90d925b9 100644 --- a/docs/reference/sf_rest_list.html +++ b/docs/reference/sf_rest_list.html @@ -148,7 +148,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_retrieve.html b/docs/reference/sf_retrieve.html index a1ccf800..b8540982 100644 --- a/docs/reference/sf_retrieve.html +++ b/docs/reference/sf_retrieve.html @@ -185,7 +185,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_retrieve_metadata.html b/docs/reference/sf_retrieve_metadata.html index 38ab9c5a..72783f9d 100644 --- a/docs/reference/sf_retrieve_metadata.html +++ b/docs/reference/sf_retrieve_metadata.html @@ -178,7 +178,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_retrieve_metadata_check_status.html b/docs/reference/sf_retrieve_metadata_check_status.html index 0e2ed269..12b14bca 100644 --- a/docs/reference/sf_retrieve_metadata_check_status.html +++ b/docs/reference/sf_retrieve_metadata_check_status.html @@ -171,7 +171,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_retrieve_rest.html b/docs/reference/sf_retrieve_rest.html index 68ec1f56..cc762b56 100644 --- a/docs/reference/sf_retrieve_rest.html +++ b/docs/reference/sf_retrieve_rest.html @@ -134,7 +134,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_retrieve_soap.html b/docs/reference/sf_retrieve_soap.html index 2ba6947d..9c255e3f 100644 --- a/docs/reference/sf_retrieve_soap.html +++ b/docs/reference/sf_retrieve_soap.html @@ -134,7 +134,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_run_bulk_operation.html b/docs/reference/sf_run_bulk_operation.html index 0ad3388c..c0477c06 100644 --- a/docs/reference/sf_run_bulk_operation.html +++ b/docs/reference/sf_run_bulk_operation.html @@ -241,7 +241,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_run_bulk_query.html b/docs/reference/sf_run_bulk_query.html index aab12602..2428b512 100644 --- a/docs/reference/sf_run_bulk_query.html +++ b/docs/reference/sf_run_bulk_query.html @@ -231,7 +231,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_run_report.html b/docs/reference/sf_run_report.html index e94a214a..19feb2b8 100644 --- a/docs/reference/sf_run_report.html +++ b/docs/reference/sf_run_report.html @@ -326,7 +326,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_search.html b/docs/reference/sf_search.html index 9c69f54b..4cc990a4 100644 --- a/docs/reference/sf_search.html +++ b/docs/reference/sf_search.html @@ -199,7 +199,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_server_timestamp.html b/docs/reference/sf_server_timestamp.html index a91218e5..a9589c45 100644 --- a/docs/reference/sf_server_timestamp.html +++ b/docs/reference/sf_server_timestamp.html @@ -135,7 +135,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_session_id.html b/docs/reference/sf_session_id.html index cec7b731..21669b1e 100644 --- a/docs/reference/sf_session_id.html +++ b/docs/reference/sf_session_id.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_set_dashboard_sticky_filter.html b/docs/reference/sf_set_dashboard_sticky_filter.html new file mode 100644 index 00000000..2793afef --- /dev/null +++ b/docs/reference/sf_set_dashboard_sticky_filter.html @@ -0,0 +1,183 @@ + +Set a sticky dashboard filter — sf_set_dashboard_sticky_filter • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Set a sticky dashboard filter

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +

      Set a default filter value which gets applied to a dashboard when you open +it. The default filter value you specify only applies to you (other people +won’t see it when they open the dashboard). If you change the filter value +while viewing the dashboard, then the filter value you set in the user +interface overwrites the value you set via the API. To set sticky filters for +a dashboard, canUseStickyFilter must equal true. +Saves any dashboard filters set in the request so that they’re also set the +next time you open the dashboard. NOTE: You can only set dashboard filters for +yourself, not for other users.

      +
      + +
      + 
      sf_set_dashboard_sticky_filter(
+  dashboard_id,
+  dashboard_filters = c(character(0))
+)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      dashboard_filters
      +

      character; Dashboard results are always +unfiltered, unless you have specified filter parameters in your request. Use +this argument to include up to three optional filter Ids. You can obtain the +list of defined filter Ids from the dashboard metadata using +sf_describe_dashboard.

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_set_password.html b/docs/reference/sf_set_password.html index b5726f00..cb2401dc 100644 --- a/docs/reference/sf_set_password.html +++ b/docs/reference/sf_set_password.html @@ -148,7 +148,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_submit_query_bulk.html b/docs/reference/sf_submit_query_bulk.html index efbde755..2c100b62 100644 --- a/docs/reference/sf_submit_query_bulk.html +++ b/docs/reference/sf_submit_query_bulk.html @@ -170,7 +170,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_undelete.html b/docs/reference/sf_undelete.html index d74ee2e4..ff37ccf6 100644 --- a/docs/reference/sf_undelete.html +++ b/docs/reference/sf_undelete.html @@ -182,7 +182,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update.html b/docs/reference/sf_update.html index 42abea21..c8a24c06 100644 --- a/docs/reference/sf_update.html +++ b/docs/reference/sf_update.html @@ -196,7 +196,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_attachment.html b/docs/reference/sf_update_attachment.html index 9c2dd15b..a252a479 100644 --- a/docs/reference/sf_update_attachment.html +++ b/docs/reference/sf_update_attachment.html @@ -218,7 +218,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_attachment_bulk_v1.html b/docs/reference/sf_update_attachment_bulk_v1.html index 65033fcf..8e0a6dc4 100644 --- a/docs/reference/sf_update_attachment_bulk_v1.html +++ b/docs/reference/sf_update_attachment_bulk_v1.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_attachment_rest.html b/docs/reference/sf_update_attachment_rest.html index de4af23f..93944285 100644 --- a/docs/reference/sf_update_attachment_rest.html +++ b/docs/reference/sf_update_attachment_rest.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_attachment_soap.html b/docs/reference/sf_update_attachment_soap.html index 766a6c1a..068082ad 100644 --- a/docs/reference/sf_update_attachment_soap.html +++ b/docs/reference/sf_update_attachment_soap.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_bulk_v1.html b/docs/reference/sf_update_bulk_v1.html index c5449a66..6fba51c7 100644 --- a/docs/reference/sf_update_bulk_v1.html +++ b/docs/reference/sf_update_bulk_v1.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_bulk_v2.html b/docs/reference/sf_update_bulk_v2.html index af150855..fcc1b7c0 100644 --- a/docs/reference/sf_update_bulk_v2.html +++ b/docs/reference/sf_update_bulk_v2.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_dashboard.html b/docs/reference/sf_update_dashboard.html new file mode 100644 index 00000000..e62e0199 --- /dev/null +++ b/docs/reference/sf_update_dashboard.html @@ -0,0 +1,162 @@ + +Update a dashboard — sf_update_dashboard • salesforcer + + +
      +
      + + + +
      +
      +
      +

      Update a dashboard

      + Source: R/analytics-dashboard.R + +
      + +
      +

      [Experimental]

      +
      + +
      + 
      sf_update_dashboard(dashboard_id, body)
      +
      + +
      +

      Arguments

      +
      dashboard_id
      +

      character; the Salesforce Id assigned to a created +dashboard. It will start with "01Z".

      +
      body
      +

      list; a list of data to be formatted as JSON before being +sent to an API endpoint. This is NOT validated and is only experimental in +allowing users to utilize the API functionality before wrapper functions +have been written in R to format and validate the request in a more +user-friendly format.

      +
      +
      +

      Value

      +

      list

      +
      + +
      + +
      + + +
      +

      Developed by Steven M. Mortimer.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + diff --git a/docs/reference/sf_update_metadata.html b/docs/reference/sf_update_metadata.html index 3b95e4c5..443215a3 100644 --- a/docs/reference/sf_update_metadata.html +++ b/docs/reference/sf_update_metadata.html @@ -196,7 +196,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_report.html b/docs/reference/sf_update_report.html index 58ccb4aa..5041e96c 100644 --- a/docs/reference/sf_update_report.html +++ b/docs/reference/sf_update_report.html @@ -209,7 +209,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_rest.html b/docs/reference/sf_update_rest.html index f1ebdfcf..7880288f 100644 --- a/docs/reference/sf_update_rest.html +++ b/docs/reference/sf_update_rest.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_update_soap.html b/docs/reference/sf_update_soap.html index fb5a1b4e..d6f72aa0 100644 --- a/docs/reference/sf_update_soap.html +++ b/docs/reference/sf_update_soap.html @@ -133,7 +133,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upload_complete_bulk.html b/docs/reference/sf_upload_complete_bulk.html index 225a3b92..71e4f9b2 100644 --- a/docs/reference/sf_upload_complete_bulk.html +++ b/docs/reference/sf_upload_complete_bulk.html @@ -158,7 +158,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upsert.html b/docs/reference/sf_upsert.html index d98eb284..16c395e4 100644 --- a/docs/reference/sf_upsert.html +++ b/docs/reference/sf_upsert.html @@ -202,7 +202,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upsert_bulk_v1.html b/docs/reference/sf_upsert_bulk_v1.html index 67ed5589..ceea7cdc 100644 --- a/docs/reference/sf_upsert_bulk_v1.html +++ b/docs/reference/sf_upsert_bulk_v1.html @@ -134,7 +134,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upsert_bulk_v2.html b/docs/reference/sf_upsert_bulk_v2.html index 55a36c7c..4ffe509b 100644 --- a/docs/reference/sf_upsert_bulk_v2.html +++ b/docs/reference/sf_upsert_bulk_v2.html @@ -134,7 +134,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upsert_metadata.html b/docs/reference/sf_upsert_metadata.html index ee9a1cd3..09556683 100644 --- a/docs/reference/sf_upsert_metadata.html +++ b/docs/reference/sf_upsert_metadata.html @@ -199,7 +199,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upsert_rest.html b/docs/reference/sf_upsert_rest.html index 5a0766b9..7780f70e 100644 --- a/docs/reference/sf_upsert_rest.html +++ b/docs/reference/sf_upsert_rest.html @@ -134,7 +134,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_upsert_soap.html b/docs/reference/sf_upsert_soap.html index 41039e4f..b2e2c37c 100644 --- a/docs/reference/sf_upsert_soap.html +++ b/docs/reference/sf_upsert_soap.html @@ -134,7 +134,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_user_info.html b/docs/reference/sf_user_info.html index b1b25bf3..ad9db2c8 100644 --- a/docs/reference/sf_user_info.html +++ b/docs/reference/sf_user_info.html @@ -147,7 +147,7 @@

      Examples

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/sf_write_csv.html b/docs/reference/sf_write_csv.html index 31b160be..8b4e7993 100644 --- a/docs/reference/sf_write_csv.html +++ b/docs/reference/sf_write_csv.html @@ -142,7 +142,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/simplify_report_metadata.html b/docs/reference/simplify_report_metadata.html index ba214f4d..60667a6f 100644 --- a/docs/reference/simplify_report_metadata.html +++ b/docs/reference/simplify_report_metadata.html @@ -150,7 +150,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/stop_w_errors_listed.html b/docs/reference/stop_w_errors_listed.html index 2f202c4a..3cf8038a 100644 --- a/docs/reference/stop_w_errors_listed.html +++ b/docs/reference/stop_w_errors_listed.html @@ -140,7 +140,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/token_available.html b/docs/reference/token_available.html index 6c5dc412..e7929669 100644 --- a/docs/reference/token_available.html +++ b/docs/reference/token_available.html @@ -132,7 +132,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/unbox_list_elements.html b/docs/reference/unbox_list_elements.html index 9571c628..e513b309 100644 --- a/docs/reference/unbox_list_elements.html +++ b/docs/reference/unbox_list_elements.html @@ -143,7 +143,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/unbox_list_elements_recursively.html b/docs/reference/unbox_list_elements_recursively.html index f136934c..c8810ec6 100644 --- a/docs/reference/unbox_list_elements_recursively.html +++ b/docs/reference/unbox_list_elements_recursively.html @@ -143,7 +143,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/unnest_col.html b/docs/reference/unnest_col.html index 78be1d4f..aab86800 100644 --- a/docs/reference/unnest_col.html +++ b/docs/reference/unnest_col.html @@ -140,7 +140,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/valid_metadata_list.html b/docs/reference/valid_metadata_list.html index d6af07f7..4188b76e 100644 --- a/docs/reference/valid_metadata_list.html +++ b/docs/reference/valid_metadata_list.html @@ -126,7 +126,7 @@

      Value

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/validate_get_all_jobs_params.html b/docs/reference/validate_get_all_jobs_params.html index d57b77f3..d01f02aa 100644 --- a/docs/reference/validate_get_all_jobs_params.html +++ b/docs/reference/validate_get_all_jobs_params.html @@ -144,7 +144,7 @@

      See also

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/warn_w_errors_listed.html b/docs/reference/warn_w_errors_listed.html index 89a2bd6f..acfb448b 100644 --- a/docs/reference/warn_w_errors_listed.html +++ b/docs/reference/warn_w_errors_listed.html @@ -140,7 +140,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/xmlToList2.html b/docs/reference/xmlToList2.html index 88f61ed0..ebdd64b8 100644 --- a/docs/reference/xmlToList2.html +++ b/docs/reference/xmlToList2.html @@ -139,7 +139,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/xml_drop_and_unlist.html b/docs/reference/xml_drop_and_unlist.html index 76a39d93..f201b22b 100644 --- a/docs/reference/xml_drop_and_unlist.html +++ b/docs/reference/xml_drop_and_unlist.html @@ -145,7 +145,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/xml_drop_and_unlist_recursively.html b/docs/reference/xml_drop_and_unlist_recursively.html index d162768e..93f3915c 100644 --- a/docs/reference/xml_drop_and_unlist_recursively.html +++ b/docs/reference/xml_drop_and_unlist_recursively.html @@ -140,7 +140,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/xml_extract_parent_and_child_result.html b/docs/reference/xml_extract_parent_and_child_result.html index e3aad4f7..c9694831 100644 --- a/docs/reference/xml_extract_parent_and_child_result.html +++ b/docs/reference/xml_extract_parent_and_child_result.html @@ -144,7 +144,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/reference/xml_nodeset_to_df.html b/docs/reference/xml_nodeset_to_df.html index 1a7f0bcb..2620712c 100644 --- a/docs/reference/xml_nodeset_to_df.html +++ b/docs/reference/xml_nodeset_to_df.html @@ -135,7 +135,7 @@

      Note

      -

      Site built with pkgdown 2.0.1.

      +

      Site built with pkgdown 2.0.2.

      diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 99810d85..fec01b03 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -471,6 +471,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_convert_lead.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_copy_dashboard.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_copy_report.html @@ -567,6 +570,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_delete_bulk_v2.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_delete_dashboard.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_delete_job_bulk.html @@ -585,6 +591,12 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_delete_soap.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_describe_dashboard.html + + + https://stevenmmortimer.github.io/salesforcer/reference/sf_describe_dashboard_components.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_describe_metadata.html @@ -612,6 +624,12 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_execute_report.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_filter_dashboard_operators_list.html + + + https://stevenmmortimer.github.io/salesforcer/reference/sf_filter_dashboard_options_analysis.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_find_duplicates.html @@ -642,6 +660,12 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_get_dashboard_data.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_get_dashboard_results.html + + + https://stevenmmortimer.github.io/salesforcer/reference/sf_get_dashboard_status.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_get_deleted.html @@ -669,6 +693,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_list_api_limits.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_list_dashboards.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_list_metadata.html @@ -723,6 +750,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_read_metadata.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_refresh_dashboard.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_rename_metadata.html @@ -807,6 +837,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_session_id.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_set_dashboard_sticky_filter.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_set_password.html @@ -837,6 +870,9 @@ https://stevenmmortimer.github.io/salesforcer/reference/sf_update_bulk_v2.html + + https://stevenmmortimer.github.io/salesforcer/reference/sf_update_dashboard.html + https://stevenmmortimer.github.io/salesforcer/reference/sf_update_metadata.html diff --git a/index.Rmd b/index.Rmd index 618969cc..fe8108c4 100644 --- a/index.Rmd +++ b/index.Rmd @@ -18,7 +18,7 @@ options(tibble.print_min = 5L, tibble.print_max = 5L) [![CRAN Status](https://www.r-pkg.org/badges/version/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Lifecycle: Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) [![Monthly Downloads](https://cranlogs.r-pkg.org/badges/last-month/salesforcer)](https://cran.r-project.org/package=salesforcer) -[![Coverage Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://codecov.io/gh/stevenmmortimer/salesforcer?branch=main) +[![Coverage Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stevenmmortimer/salesforcer?branch=main)
      @@ -70,7 +70,7 @@ Package features include: ## Installation ```{r, eval = FALSE} -# install the current CRAN version (1.0.0) +# install the current CRAN version (1.0.1) install.packages("salesforcer") # or get the development version on GitHub @@ -84,7 +84,7 @@ example on [GitHub](https://github.com/stevenmmortimer/salesforcer/issues). ## Vignettes The README below outlines the basic package functionality for more detailed notes -on how to utilize the features of this package consider reading the following vignettes: +on how to utilize the features of this package consider reading the following vignettes: * [Getting Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) * [Supported Queries](https://stevenmmortimer.github.io/salesforcer/articles/supported-queries.html) @@ -99,28 +99,32 @@ on how to utilize the features of this package consider reading the following vi ### Authenticate -First, load the {salesforcer} package and login. There are two ways to authenticate: +First, load the {salesforcer} package and log in. There are two ways to +authenticate: 1. OAuth 2.0 - 2. Basic Username-Password + 2. ~~Basic Username-Password~~ + +**NOTE**: Beginning February 1, 2022 authentication via a username and password +will not work in most orgs. On that date Salesforce will begin requiring customers +to enable multi-factor authentication (MFA). The function `sf_auth()` will +return the error message: + +```sh +INVALID_LOGIN: Invalid username, password, security token; or user locked out. +``` -It is recommended to use OAuth 2.0 so that passwords do not have to be shared or -embedded within scripts. User credentials will be stored in locally cached file -entitled ".httr-oauth-salesforcer" in the current working directory. Also, note that -if you use OAuth 2.0 authentication then the package will automatically refresh -it so you will not have to call `sf_auth()` during each session if you have a -cached ".httr-oauth-salesforcer" file in the working directory. The cache file is named -that way to not conflict with the ".httr-oauth" files created by other packages. +It has always been recommended to use OAuth 2.0 so that passwords do not have to +be shared or embedded within scripts. For more information on how OAuth 2.0 works +within the {salesforcer} package, please read the +[Getting Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) +vignette. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) library(salesforcer) -username <- Sys.getenv("SALESFORCER_USERNAME") -password <- Sys.getenv("SALESFORCER_PASSWORD") -security_token <- Sys.getenv("SALESFORCER_SECURITY_TOKEN") -sf_auth(username = username, - password = password, - security_token = security_token) +token_path <- Sys.getenv("SALESFORCER_TOKEN_PATH") +sf_auth(token = paste0(token_path, "salesforcer_token.rds")) ``` ```{r, eval=FALSE} @@ -129,11 +133,6 @@ library(salesforcer) # Using OAuth 2.0 authentication sf_auth() - -# Using Basic Username-Password authentication -sf_auth(username = "test@gmail.com", - password = "{PASSWORD_HERE}", - security_token = "{SECURITY_TOKEN_HERE}") ``` After logging in with `sf_auth()`, you can check your connectivity by looking at diff --git a/index.md b/index.md index 928ad984..6aeddfc8 100644 --- a/index.md +++ b/index.md @@ -10,7 +10,7 @@ Stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https:// [![Monthly Downloads](https://cranlogs.r-pkg.org/badges/last-month/salesforcer)](https://cran.r-project.org/package=salesforcer) [![Coverage -Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://codecov.io/gh/stevenmmortimer/salesforcer?branch=main) +Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badge.svg)](https://app.codecov.io/gh/stevenmmortimer/salesforcer?branch=main)
      @@ -22,55 +22,55 @@ SOAP, Bulk 1.0, Bulk 2.0, Reports and Dashboards, and Metadata APIs. Package features include: - - OAuth 2.0 (Single Sign On) and Basic (Username-Password) +- OAuth 2.0 (Single Sign On) and Basic (Username-Password) Authentication methods (`sf_auth()`) - - CRUD (Create, Retrieve, Update, Delete) methods for records using +- CRUD (Create, Retrieve, Update, Delete) methods for records using the SOAP, REST, and Bulk APIs - - Query records via the SOAP, REST, Bulk 1.0, and Bulk 2.0 APIs using +- Query records via the SOAP, REST, Bulk 1.0, and Bulk 2.0 APIs using `sf_query()` - - Manage and execute reports and dashboards with: - - `sf_list_reports()`, `sf_create_report()`, `sf_run_report()`, +- Manage and execute reports and dashboards with: + - `sf_list_reports()`, `sf_create_report()`, `sf_run_report()`, and more - - Retrieve and modify metadata (Custom Objects, Fields, etc.) using +- Retrieve and modify metadata (Custom Objects, Fields, etc.) using the Metadata API with: - - `sf_describe_objects()`, `sf_create_metadata()`, + - `sf_describe_objects()`, `sf_create_metadata()`, `sf_update_metadata()`, and more - - Utilize backwards compatible functions for the {RForcecom} package, +- Utilize backwards compatible functions for the {RForcecom} package, such as: - - `rforcecom.login()`, `rforcecom.getObjectDescription()`, + - `rforcecom.login()`, `rforcecom.getObjectDescription()`, `rforcecom.query()`, `rforcecom.create()` - - Basic utility calls (`sf_user_info()`, `sf_server_timestamp()`, +- Basic utility calls (`sf_user_info()`, `sf_server_timestamp()`, `sf_list_objects()`) - - Functions to assist with master data management (MDM) or data +- Functions to assist with master data management (MDM) or data integrity of records by finding duplicates (`sf_find_duplicates()`, `sf_find_duplicates_by_id()`), merging records (`sf_merge()`), and converting leads (`sf_convert_lead()`) - - Recover (`sf_undelete()`) or delete from the Recycle Bin +- Recover (`sf_undelete()`) or delete from the Recycle Bin (`sf_empty_recycle_bin()`) and list ids of records deleted (`sf_get_deleted()`) or updated (`sf_get_updated()`) within a specific timeframe - - Passing API call control parameters such as, “All or None”, - “Duplicate Rule”, “Assignment Rule” execution and many more\! +- Passing API call control parameters such as, “All or None”, + “Duplicate Rule”, “Assignment Rule” execution and many more! ## Table of Contents - - [Installation](#installation) - - [Vignettes](#vignettes) - - [Usage](#usage) - - [Authenticate](#authenticate) - - [Create](#create) - - [Query](#query) - - [Update](#update) - - [Bulk Operations](#bulk-operations) - - [Using the Metadata API](#using-the-metadata-api) - - [Future](#future) - - [Credits](#credits) - - [More Information](#more-information) +- [Installation](#installation) +- [Vignettes](#vignettes) +- [Usage](#usage) + - [Authenticate](#authenticate) + - [Create](#create) + - [Query](#query) + - [Update](#update) + - [Bulk Operations](#bulk-operations) + - [Using the Metadata API](#using-the-metadata-api) +- [Future](#future) +- [Credits](#credits) +- [More Information](#more-information) ## Installation ``` r -# install the current CRAN version (1.0.0) +# install the current CRAN version (1.0.1) install.packages("salesforcer") # or get the development version on GitHub @@ -88,42 +88,48 @@ The README below outlines the basic package functionality for more detailed notes on how to utilize the features of this package consider reading the following vignettes: - - [Getting +- [Getting Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) - - [Supported +- [Supported Queries](https://stevenmmortimer.github.io/salesforcer/articles/supported-queries.html) - - [Working with Bulk +- [Working with Bulk APIs](https://stevenmmortimer.github.io/salesforcer/articles/working-with-bulk-apis.html) - - [Working with +- [Working with Reports](https://stevenmmortimer.github.io/salesforcer/articles/working-with-reports.html) - - [Working with +- [Working with Attachments](https://stevenmmortimer.github.io/salesforcer/articles/working-with-attachments.html) - - [Working with +- [Working with Metadata](https://stevenmmortimer.github.io/salesforcer/articles/working-with-metadata.html) - - [Passing Control +- [Passing Control Args](https://stevenmmortimer.github.io/salesforcer/articles/passing-control-args.html) - - [Transitioning from +- [Transitioning from RForcecom](https://stevenmmortimer.github.io/salesforcer/articles/transitioning-from-RForcecom.html) ## Usage ### Authenticate -First, load the {salesforcer} package and login. There are two ways to +First, load the {salesforcer} package and log in. There are two ways to authenticate: 1. OAuth 2.0 -2. Basic Username-Password - -It is recommended to use OAuth 2.0 so that passwords do not have to be -shared or embedded within scripts. User credentials will be stored in -locally cached file entitled “.httr-oauth-salesforcer” in the current -working directory. Also, note that if you use OAuth 2.0 authentication -then the package will automatically refresh it so you will not have to -call `sf_auth()` during each session if you have a cached -“.httr-oauth-salesforcer” file in the working directory. The cache -file is named that way to not conflict with the “.httr-oauth” files -created by other packages. +2. ~~Basic Username-Password~~ + +**NOTE**: Beginning February 1, 2022 authentication via a username and +password will not work in most orgs. On that date Salesforce will begin +requiring customers to enable multi-factor authentication (MFA). The function +`sf_auth()` will return the error message: + +``` sh +INVALID_LOGIN: Invalid username, password, security token; or user locked out. +``` + +It has always been recommended to use OAuth 2.0 so that passwords do not +have to be shared or embedded within scripts. For more information on +how OAuth 2.0 works within the {salesforcer} package, please read the +[Getting +Started](https://stevenmmortimer.github.io/salesforcer/articles/getting-started.html) +vignette. ``` r library(dplyr, warn.conflicts = FALSE) @@ -131,16 +137,11 @@ library(salesforcer) # Using OAuth 2.0 authentication sf_auth() - -# Using Basic Username-Password authentication -sf_auth(username = "test@gmail.com", - password = "{PASSWORD_HERE}", - security_token = "{SECURITY_TOKEN_HERE}") ``` After logging in with `sf_auth()`, you can check your connectivity by looking at the information returned about the current user. It should be -information about you\! +information about you! ``` r # pull down information of person logged in @@ -165,11 +166,11 @@ new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n)) created_records <- sf_create(new_contacts, object_name = "Contact") created_records -#> # A tibble: 2 x 2 +#> # A tibble: 2 × 2 #> id success #> -#> 1 0033s000014AgfSAAS TRUE -#> 2 0033s000014AgfTAAS TRUE +#> 1 0033s00001BXHr4AAH TRUE +#> 2 0033s00001BXHr5AAH TRUE ``` ### Query @@ -177,7 +178,7 @@ created_records Salesforce has proprietary form of SQL called SOQL (Salesforce Object Query Language). SOQL is a powerful tool that allows you to return the attributes of records on almost any object in Salesforce including -Accounts, Contacts, Tasks, Opportunities, even Attachments\! Below is an +Accounts, Contacts, Tasks, Opportunities, even Attachments! Below is an example where we grab the data we just created including Account object information for which the Contact record is associated with. @@ -191,11 +192,11 @@ my_soql <- sprintf("SELECT Id, paste0(created_records$id , collapse = "','")) queried_records <- sf_query(my_soql) queried_records -#> # A tibble: 2 x 3 +#> # A tibble: 2 × 3 #> Id FirstName LastName #> -#> 1 0033s000014AgfSAAS Test Contact-Create-1 -#> 2 0033s000014AgfTAAS Test Contact-Create-2 +#> 1 0033s00001BXHr4AAH Test Contact-Create-1 +#> 2 0033s00001BXHr5AAH Test Contact-Create-2 ``` **NOTE**: In the example above, you’ll notice that the `"Account.Name"` @@ -203,7 +204,7 @@ column does not appear in the results. This is because the SOAP and REST APIs only return an empty Account object for the record if there is no relationship to an account (see \#78). +href="https://github.com/stevenmmortimer/salesforcer/issues/78">#78). There is no reliable way to extract and rebuild the empty columns based on the query string. If there were Account information, an additional column titled `"Account.Name"` would appear in the results. Note, that @@ -229,20 +230,20 @@ queried_records <- queried_records %>% updated_records <- sf_update(queried_records, object_name = "Contact") updated_records -#> # A tibble: 2 x 2 +#> # A tibble: 2 × 2 #> id success #> -#> 1 0033s000014AgfSAAS TRUE -#> 2 0033s000014AgfTAAS TRUE +#> 1 0033s00001BXHr4AAH TRUE +#> 2 0033s00001BXHr5AAH TRUE ``` ### Bulk Operations For really large operations (inserts, updates, upserts, deletes, and -queries) Salesforce provides the -[Bulk 1.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) -and -[Bulk 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/introduction_bulk_api_2.htm) +queries) Salesforce provides the [Bulk +1.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_intro.htm) +and [Bulk +2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/introduction_bulk_api_2.htm) APIs. In order to use the Bulk APIs in {salesforcer} you can just add `api_type = "Bulk 1.0"` or `api_type = "Bulk 2.0"` to your functions and the operation will be executed using the Bulk APIs. It’s that simple. @@ -267,11 +268,11 @@ new_contacts <- tibble(FirstName = rep("Test", n), LastName = paste0("Contact-Create-", 1:n)) created_records <- sf_create(new_contacts, "Contact", api_type = "Bulk 1.0") created_records -#> # A tibble: 2 x 4 +#> # A tibble: 2 × 4 #> Id Success Created Error #> -#> 1 0033s000014AgfXAAS TRUE TRUE NA -#> 2 0033s000014AgfYAAS TRUE TRUE NA +#> 1 0033s00001BXHr9AAH TRUE TRUE NA +#> 2 0033s00001BXHrAAAX TRUE TRUE NA # query large recordsets using the Bulk API my_soql <- sprintf("SELECT Id, @@ -283,20 +284,20 @@ my_soql <- sprintf("SELECT Id, queried_records <- sf_query(my_soql, "Contact", api_type = "Bulk 1.0") queried_records -#> # A tibble: 2 x 3 +#> # A tibble: 2 × 3 #> Id FirstName LastName #> -#> 1 0033s000014AgfXAAS Test Contact-Create-1 -#> 2 0033s000014AgfYAAS Test Contact-Create-2 +#> 1 0033s00001BXHr9AAH Test Contact-Create-1 +#> 2 0033s00001BXHrAAAX Test Contact-Create-2 # delete these records using the Bulk 2.0 API deleted_records <- sf_delete(queried_records$Id, "Contact", api_type = "Bulk 2.0") deleted_records -#> # A tibble: 2 x 4 +#> # A tibble: 2 × 4 #> Id sf__Id sf__Created sf__Error #> -#> 1 0033s000014AgfXAAS 0033s000014AgfXAAS FALSE NA -#> 2 0033s000014AgfYAAS 0033s000014AgfYAAS FALSE NA +#> 1 0033s00001BXHr9AAH 0033s00001BXHr9AAH FALSE NA +#> 2 0033s00001BXHrAAAX 0033s00001BXHrAAAX FALSE NA ``` ### Using the Metadata API @@ -311,8 +312,8 @@ an object (fields, permissions, etc.). You can use the `sf_read_metadata()` function to return a list of objects and their metadata. In the example below we retrieve the metadata for the Account and Contact objects. Note that the `metadata_type` argument is -“CustomObject”. Standard Objects are an implementation of -CustomObjects, so they are returned using that metadata type. +“CustomObject”. Standard Objects are an implementation of CustomObjects, +so they are returned using that metadata type. ``` r read_obj_result <- sf_read_metadata(metadata_type = 'CustomObject', @@ -365,14 +366,14 @@ each field on the Account object: ``` r acct_fields <- sf_describe_object_fields('Account') acct_fields %>% select(name, label, length, soapType, type) -#> # A tibble: 68 x 5 +#> # A tibble: 68 × 5 #> name label length soapType type #> #> 1 Id Account ID 18 tns:ID id #> 2 IsDeleted Deleted 0 xsd:boolean boolean #> 3 MasterRecordId Master Record ID 18 tns:ID reference #> 4 Name Account Name 255 xsd:string string -#> 5 Type Account Type 40 xsd:string picklist +#> 5 Type Account Type 255 xsd:string picklist #> # … with 63 more rows # show the picklist selection options for the Account Type field @@ -380,7 +381,7 @@ acct_fields %>% filter(label == "Account Type") %>% .$picklistValues #> [[1]] -#> # A tibble: 7 x 4 +#> # A tibble: 7 × 4 #> active defaultValue label value #> #> 1 true false Prospect Prospect @@ -395,23 +396,23 @@ acct_fields %>% Future APIs to support (roughly in priority order): - - [Connect (Chatter) REST +- [Connect (Chatter) REST API](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm) - - [Analytics External Data +- [Analytics External Data API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_overview.htm) - - [Analytics REST +- [Analytics REST API](https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_rest_overview.htm) - - [Tooling +- [Tooling API](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/intro_api_tooling.htm) - - [Actions +- [Actions API](https://developer.salesforce.com/docs/atlas.en-us.api_action.meta/api_action/actions_intro.htm) - - [Streaming +- [Streaming API](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/intro_stream.htm) - - [Place Order +- [Place Order API](https://developer.salesforce.com/docs/atlas.en-us.api_placeorder.meta/api_placeorder/sforce_placeorder_rest_api_intro.htm) - - [Industries +- [Industries API](https://developer.salesforce.com/docs/atlas.en-us.api_rest_industries.meta/api_rest_industries/intro.htm) - - [Data.com +- [Data.com API](https://developer.salesforce.com/docs/atlas.en-us.datadotcom_api_dev_guide.meta/datadotcom_api_dev_guide/datadotcom_api_dev_guide_intro.htm) ## Credits diff --git a/man/make_soap_xml_skeleton.Rd b/man/make_soap_xml_skeleton.Rd index 15985729..2d1cc2a7 100644 --- a/man/make_soap_xml_skeleton.Rd +++ b/man/make_soap_xml_skeleton.Rd @@ -43,6 +43,6 @@ Additionally, Bulk API can't access or query compound address or compound geoloc \references{ \url{https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/soap_headers.htm} -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } \keyword{internal} diff --git a/man/rforcecom.bulkAction.Rd b/man/rforcecom.bulkAction.Rd index 9c1c3ea2..61819a1b 100644 --- a/man/rforcecom.bulkAction.Rd +++ b/man/rforcecom.bulkAction.Rd @@ -68,5 +68,5 @@ updates <- rforcecom.bulkAction(session, } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_abort_job_bulk.Rd b/man/sf_abort_job_bulk.Rd index 750318fd..0945b332 100644 --- a/man/sf_abort_job_bulk.Rd +++ b/man/sf_abort_job_bulk.Rd @@ -36,5 +36,5 @@ sf_abort_job_bulk(job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_auth.Rd b/man/sf_auth.Rd index 4efd7285..11619e30 100644 --- a/man/sf_auth.Rd +++ b/man/sf_auth.Rd @@ -81,7 +81,7 @@ call. This value is \code{NULL} if \code{auth_method='OAuth'}. is on and where subsequent API calls will be directed to. For example, \code{https://na21.salesforce.com} refers to an org located on the 'NA21' server instance located in Chicago, USA / Washington DC, USA per this -Knowledge Article: \url{https://help.salesforce.com/articleView?id=000314281}. +Knowledge Article: \url{https://help.salesforce.com/s/articleView?language=en_US&id=000314281}. } } } diff --git a/man/sf_batch_details_bulk.Rd b/man/sf_batch_details_bulk.Rd index c5362f28..45eb3f77 100644 --- a/man/sf_batch_details_bulk.Rd +++ b/man/sf_batch_details_bulk.Rd @@ -50,5 +50,5 @@ sf_close_job_bulk(job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_batch_status_bulk.Rd b/man/sf_batch_status_bulk.Rd index bed17825..f6f48840 100644 --- a/man/sf_batch_status_bulk.Rd +++ b/man/sf_batch_status_bulk.Rd @@ -49,5 +49,5 @@ sf_get_job_bulk(job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_close_job_bulk.Rd b/man/sf_close_job_bulk.Rd index 1e54c9fc..62a95e4b 100644 --- a/man/sf_close_job_bulk.Rd +++ b/man/sf_close_job_bulk.Rd @@ -44,5 +44,5 @@ sf_close_job_bulk(job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_create_batches_bulk.Rd b/man/sf_create_batches_bulk.Rd index c845d037..94898ffc 100644 --- a/man/sf_create_batches_bulk.Rd +++ b/man/sf_create_batches_bulk.Rd @@ -61,5 +61,5 @@ sf_get_job_bulk(job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_create_job_bulk.Rd b/man/sf_create_job_bulk.Rd index 5388364c..ec272f4c 100644 --- a/man/sf_create_job_bulk.Rd +++ b/man/sf_create_job_bulk.Rd @@ -101,5 +101,5 @@ job_info <- sf_create_job_bulk(operation='query', object_name='Lead') } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_describe_metadata.Rd b/man/sf_describe_metadata.Rd index 5eede609..172847ff 100644 --- a/man/sf_describe_metadata.Rd +++ b/man/sf_describe_metadata.Rd @@ -27,5 +27,5 @@ metadata_info <- sf_describe_metadata() } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} } diff --git a/man/sf_get_job_bulk.Rd b/man/sf_get_job_bulk.Rd index caafad0e..5b0b43a9 100644 --- a/man/sf_get_job_bulk.Rd +++ b/man/sf_get_job_bulk.Rd @@ -42,5 +42,5 @@ sf_abort_job_bulk(refreshed_job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_get_job_records_bulk.Rd b/man/sf_get_job_records_bulk.Rd index cfcd4fca..da989eee 100644 --- a/man/sf_get_job_records_bulk.Rd +++ b/man/sf_get_job_records_bulk.Rd @@ -56,5 +56,5 @@ job_record_details <- sf_get_job_records_bulk(job_id=job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_job_batches_bulk.Rd b/man/sf_job_batches_bulk.Rd index d5fdf5dd..8463011e 100644 --- a/man/sf_job_batches_bulk.Rd +++ b/man/sf_job_batches_bulk.Rd @@ -40,5 +40,5 @@ sf_get_job_bulk(job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_list_metadata.Rd b/man/sf_list_metadata.Rd index 44507c5f..fb6f3952 100644 --- a/man/sf_list_metadata.Rd +++ b/man/sf_list_metadata.Rd @@ -38,5 +38,5 @@ metadata_info <- sf_list_metadata(queries=my_queries) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} } diff --git a/man/sf_query.Rd b/man/sf_query.Rd index d9f80ab7..ba8bb2f0 100644 --- a/man/sf_query.Rd +++ b/man/sf_query.Rd @@ -103,5 +103,5 @@ sf_query("SELECT Id, Account.Name, Email FROM Contact LIMIT 10") } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/man/sf_read_metadata.Rd b/man/sf_read_metadata.Rd index e552b0c7..f9df8fe1 100644 --- a/man/sf_read_metadata.Rd +++ b/man/sf_read_metadata.Rd @@ -32,5 +32,5 @@ metadata_info <- sf_read_metadata(metadata_type='CustomObject', } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} } diff --git a/man/sf_rename_metadata.Rd b/man/sf_rename_metadata.Rd index b28aeca1..b94aba37 100644 --- a/man/sf_rename_metadata.Rd +++ b/man/sf_rename_metadata.Rd @@ -37,5 +37,5 @@ renamed_custom_object <- sf_rename_metadata(metadata_type = 'CustomObject', } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta} } diff --git a/man/sf_upload_complete_bulk.Rd b/man/sf_upload_complete_bulk.Rd index 88ca2d58..83173cae 100644 --- a/man/sf_upload_complete_bulk.Rd +++ b/man/sf_upload_complete_bulk.Rd @@ -36,5 +36,5 @@ upload_info <- sf_upload_complete_bulk(job_id=job_info$id) } } \references{ -\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/} +\url{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch} } diff --git a/revdep/README.md b/revdep/README.md index adf12471..7c64b2fb 100644 --- a/revdep/README.md +++ b/revdep/README.md @@ -1,28 +1,24 @@ # Platform -|field |value | -|:--------|:----------------------------| -|version |R version 4.0.2 (2020-06-22) | -|os |macOS Catalina 10.15.6 | -|system |x86_64, darwin17.0 | -|ui |RStudio | -|language |(EN) | -|collate |en_US.UTF-8 | -|ctype |en_US.UTF-8 | -|tz |America/New_York | -|date |2020-09-07 | +|field |value | +|:--------|:----------------------------------------| +|version |R version 4.0.2 (2020-06-22) | +|os |OS X 12.2.1 | +|system |x86_64, darwin17.0 | +|ui |RStudio | +|language |(EN) | +|collate |en_US.UTF-8 | +|ctype |en_US.UTF-8 | +|tz |America/Chicago | +|date |2022-02-27 | +|rstudio |2021.09.1+372 Ghost Orchid (desktop) | +|pandoc |2.16.2 @ /usr/local/bin/ (via rmarkdown) | # Dependencies -|package |old |new |Δ | -|:-----------|:-----|:--------|:--| -|salesforcer |0.2.0 |0.2.2 |* | -|dplyr |NA |1.0.2 |* | -|glue |NA |1.4.2 |* | -|jsonlite |NA |1.7.1 |* | -|sys |NA |3.4 |* | -|XML |NA |3.99-0.5 |* | -|zip |NA |2.1.1 |* | +|package |old |new |Δ | +|:-----------|:-----|:-----|:--| +|salesforcer |1.0.0 |1.0.1 |* | # Revdeps diff --git a/vignettes/getting-started.Rmd b/vignettes/getting-started.Rmd index dc61d1c0..4023c213 100644 --- a/vignettes/getting-started.Rmd +++ b/vignettes/getting-started.Rmd @@ -42,8 +42,11 @@ INVALID_LOGIN: Invalid username, password, security token; or user locked out. ``` Also, it is a best practice to use OAuth 2.0 so that passwords do not have to be -shared/embedded within scripts. User credentials will be stored in locally -cached file entitled `.httr-oauth-salesforcer` in the current working directory. +embedded within scripts. OAuth 2.0 credentials are stored locally in a cached +file titled `.httr-oauth-salesforcer` in the current working directory. The +package will automatically refresh this cached token when it expires so you will +not have to call `sf_auth()` during every R session if the +`.httr-oauth-salesforcer` file is present in the working directory. ```{r auth, include = FALSE} suppressWarnings(suppressMessages(library(dplyr))) From 6a404d19deaa95d1a3572c0b5a2a6a9d0feadd28 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Mon, 28 Feb 2022 13:47:25 -0600 Subject: [PATCH 19/22] Fix workflow syntax error: a step cannot have both the `uses` and `run` keys --- .github/workflows/main-01-pkgdown.yml | 2 +- .github/workflows/main-02-test-coverage.yml | 6 +++--- .github/workflows/main-03-R-CMD-check-mac.yml | 6 +++--- .github/workflows/main-04-R-CMD-check-windows.yml | 6 +++--- .github/workflows/main-05-R-CMD-check-linux.yml | 6 +++--- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/workflows/main-01-pkgdown.yml b/.github/workflows/main-01-pkgdown.yml index a06f8826..094f1938 100644 --- a/.github/workflows/main-01-pkgdown.yml +++ b/.github/workflows/main-01-pkgdown.yml @@ -22,7 +22,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Decrypt OAuth Token + - name: Decrypt OAuth Token run: | ./.github/scripts/decrypt_secret.sh env: diff --git a/.github/workflows/main-02-test-coverage.yml b/.github/workflows/main-02-test-coverage.yml index d9c9bd7d..1436755f 100644 --- a/.github/workflows/main-02-test-coverage.yml +++ b/.github/workflows/main-02-test-coverage.yml @@ -25,13 +25,13 @@ jobs: steps: - uses: actions/checkout@v2 - name: Decrypt OAuth Token + with: + ref: ${{ github.event.client_payload.sha }} + - name: Decrypt OAuth Token run: | ./.github/scripts/decrypt_secret.sh env: SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} - with: - ref: ${{ github.event.client_payload.sha }} - name: Reveal env vars run: | diff --git a/.github/workflows/main-03-R-CMD-check-mac.yml b/.github/workflows/main-03-R-CMD-check-mac.yml index 71704634..a47110ab 100644 --- a/.github/workflows/main-03-R-CMD-check-mac.yml +++ b/.github/workflows/main-03-R-CMD-check-mac.yml @@ -33,13 +33,13 @@ jobs: steps: - uses: actions/checkout@v2 - name: Decrypt OAuth Token + with: + ref: ${{ github.event.client_payload.sha }} + - name: Decrypt OAuth Token run: | ./.github/scripts/decrypt_secret.sh env: SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} - with: - ref: ${{ github.event.client_payload.sha }} - uses: r-lib/actions/setup-r@v1 with: diff --git a/.github/workflows/main-04-R-CMD-check-windows.yml b/.github/workflows/main-04-R-CMD-check-windows.yml index 54866406..01426702 100644 --- a/.github/workflows/main-04-R-CMD-check-windows.yml +++ b/.github/workflows/main-04-R-CMD-check-windows.yml @@ -33,13 +33,13 @@ jobs: steps: - uses: actions/checkout@v2 - name: Decrypt OAuth Token + with: + ref: ${{ github.event.client_payload.sha }} + - name: Decrypt OAuth Token run: | ./.github/scripts/decrypt_secret.sh env: SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} - with: - ref: ${{ github.event.client_payload.sha }} - uses: r-lib/actions/setup-r@master with: diff --git a/.github/workflows/main-05-R-CMD-check-linux.yml b/.github/workflows/main-05-R-CMD-check-linux.yml index 4b594047..f9cd750c 100644 --- a/.github/workflows/main-05-R-CMD-check-linux.yml +++ b/.github/workflows/main-05-R-CMD-check-linux.yml @@ -33,13 +33,13 @@ jobs: steps: - uses: actions/checkout@v2 - name: Decrypt OAuth Token + with: + ref: ${{ github.event.client_payload.sha }} + - name: Decrypt OAuth Token run: | ./.github/scripts/decrypt_secret.sh env: SALESFORCER_TOKEN_PASSPHRASE: ${{ secrets.SALESFORCER_TOKEN_PASSPHRASE }} - with: - ref: ${{ github.event.client_payload.sha }} - uses: r-lib/actions/setup-r@v1 with: From 7eac91b917eb8ff8e128e4fda1be21e11238a968 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Mon, 28 Feb 2022 13:47:59 -0600 Subject: [PATCH 20/22] Auto-generated diff on DESCRIPTION --- DESCRIPTION | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 73b96fe8..81919244 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,12 +11,23 @@ Description: Functions connecting to the 'Salesforce' Platform APIs (REST, SOAP, API documentation and this package's website for more information, documentation, and examples. -Authors@R: c( - person(c("Steven", "M."), "Mortimer", , "mortimer.steven.m@gmail.com", role = c("aut", "cre")), - person("Takekatsu", "Hiramura", , "thira@plavox.info", role = "ctb"), - person("Jennifer", "Bryan", , "jenny@rstudio.com", role = c("ctb", "cph")), - person("Joanna", "Zhao", , "joanna.zhao@alumni.ubc.ca", role = c("ctb", "cph")) - ) +Authors@R: + c(person(given = c("Steven", "M."), + family = "Mortimer", + role = c("aut", "cre"), + email = "mortimer.steven.m@gmail.com"), + person(given = "Takekatsu", + family = "Hiramura", + role = "ctb", + email = "thira@plavox.info"), + person(given = "Jennifer", + family = "Bryan", + role = c("ctb", "cph"), + email = "jenny@rstudio.com"), + person(given = "Joanna", + family = "Zhao", + role = c("ctb", "cph"), + email = "joanna.zhao@alumni.ubc.ca")) License: MIT + file LICENSE URL: https://github.com/StevenMMortimer/salesforcer BugReports: https://github.com/StevenMMortimer/salesforcer/issues From 4509519ba2337c95752fa826e65b766e04b7e440 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Mon, 28 Feb 2022 17:19:49 -0600 Subject: [PATCH 21/22] Fix Links Identified by Win-Builder --- R/bulk-operation.R | 2 +- R/create-metadata.R | 2 +- R/delete-metadata.R | 2 +- R/update-metadata.R | 2 +- R/upsert-metadata.R | 2 +- man/sf_create_metadata.Rd | 2 +- man/sf_delete_metadata.Rd | 2 +- man/sf_run_bulk_operation.Rd | 2 +- man/sf_update_metadata.Rd | 2 +- man/sf_upsert_metadata.Rd | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/R/bulk-operation.R b/R/bulk-operation.R index 7b00fe39..d9779a0c 100644 --- a/R/bulk-operation.R +++ b/R/bulk-operation.R @@ -1335,7 +1335,7 @@ sf_get_job_records_bulk_v2 <- function(job_id, #' @return A \code{tbl_df} of the results of the bulk job #' @note With Bulk 2.0 the order of records in the response is not guaranteed to #' match the ordering of records in the original job data. -#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/}{Salesforce Documentation} +#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch}{Salesforce Documentation} #' @examples #' \dontrun{ #' n <- 20 diff --git a/R/create-metadata.R b/R/create-metadata.R index 614e1528..b912aed6 100644 --- a/R/create-metadata.R +++ b/R/create-metadata.R @@ -19,7 +19,7 @@ #' @template all_or_none #' @template verbose #' @return A \code{tbl_df} containing the creation result for each submitted metadata component -#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} #' @examples #' \dontrun{ #' # read the metadata of the existing Account object diff --git a/R/delete-metadata.R b/R/delete-metadata.R index 99614779..d7773e35 100644 --- a/R/delete-metadata.R +++ b/R/delete-metadata.R @@ -14,7 +14,7 @@ #' @template all_or_none #' @template verbose #' @return A \code{data.frame} containing the creation result for each submitted metadata component -#' @seealso \code{\link{sf_list_metadata}}, \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +#' @seealso \code{\link{sf_list_metadata}}, \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} #' @examples #' \dontrun{ #' metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', diff --git a/R/update-metadata.R b/R/update-metadata.R index 68c73959..a9ed8094 100644 --- a/R/update-metadata.R +++ b/R/update-metadata.R @@ -21,7 +21,7 @@ #' @return A \code{tbl_df} containing the creation result for each submitted metadata component #' @note The update key is based on the fullName parameter of the metadata, so updates are triggered #' when an existing Salesforce element matches the metadata type and fullName. -#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} #' @examples #' \dontrun{ #' # create an object that we can update diff --git a/R/upsert-metadata.R b/R/upsert-metadata.R index c971672a..75b6c1c6 100644 --- a/R/upsert-metadata.R +++ b/R/upsert-metadata.R @@ -21,7 +21,7 @@ #' @return A \code{tbl_df} containing the creation result for each submitted metadata component #' @note The upsert key is based on the fullName parameter of the metadata, so updates are triggered #' when an existing Salesforce element matches the metadata type and fullName. -#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +#' @seealso \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} #' @examples #' \dontrun{ #' # create an object that we can confirm the update portion of the upsert diff --git a/man/sf_create_metadata.Rd b/man/sf_create_metadata.Rd index 48566488..94a97692 100644 --- a/man/sf_create_metadata.Rd +++ b/man/sf_create_metadata.Rd @@ -97,5 +97,5 @@ new_custom_fields <- sf_create_metadata(metadata_type = 'CustomField', } } \seealso{ -\href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +\href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} } diff --git a/man/sf_delete_metadata.Rd b/man/sf_delete_metadata.Rd index 5bc61fb1..1ad5e5fe 100644 --- a/man/sf_delete_metadata.Rd +++ b/man/sf_delete_metadata.Rd @@ -47,5 +47,5 @@ metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject', } } \seealso{ -\code{\link{sf_list_metadata}}, \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +\code{\link{sf_list_metadata}}, \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} } diff --git a/man/sf_run_bulk_operation.Rd b/man/sf_run_bulk_operation.Rd index 543ca304..39194dcd 100644 --- a/man/sf_run_bulk_operation.Rd +++ b/man/sf_run_bulk_operation.Rd @@ -120,5 +120,5 @@ inserts <- sf_bulk_operation(input_data = new_contacts, } } \seealso{ -\href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/}{Salesforce Documentation} +\href{https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch}{Salesforce Documentation} } diff --git a/man/sf_update_metadata.Rd b/man/sf_update_metadata.Rd index 3328140a..f35415ab 100644 --- a/man/sf_update_metadata.Rd +++ b/man/sf_update_metadata.Rd @@ -73,5 +73,5 @@ updated_custom_object_result <- sf_update_metadata(metadata_type = 'CustomObject } } \seealso{ -\href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +\href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} } diff --git a/man/sf_upsert_metadata.Rd b/man/sf_upsert_metadata.Rd index eb216675..90560fe6 100644 --- a/man/sf_upsert_metadata.Rd +++ b/man/sf_upsert_metadata.Rd @@ -76,5 +76,5 @@ upserted_custom_object_result <- sf_upsert_metadata(metadata_type = 'CustomObjec } } \seealso{ -\href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/}{Salesforce Documentation} +\href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation} } From 411b3e82578bc87e21622f23a6ffc787d33b02f4 Mon Sep 17 00:00:00 2001 From: "Steven M. Mortimer" Date: Mon, 28 Feb 2022 19:24:40 -0600 Subject: [PATCH 22/22] Fix R CMD Check Notes --- README.Rmd | 8 ++++---- README.md | 6 +++--- cran-comments.md | 53 +++++++++++++++++++++++------------------------- index.Rmd | 8 ++++---- index.md | 6 +++--- 5 files changed, 39 insertions(+), 42 deletions(-) diff --git a/README.Rmd b/README.Rmd index 6bc619b8..965a45fe 100644 --- a/README.Rmd +++ b/README.Rmd @@ -104,10 +104,10 @@ authenticate: 1. OAuth 2.0 2. ~~Basic Username-Password~~ -**NOTE**: Beginning February 1, 2022 authentication via a username and password -will not work in most orgs. On that date Salesforce will begin requiring customers -to enable multi-factor authentication (MFA). The function `sf_auth()` will return -the error message: +**NOTE**: Beginning February 1, 2022 authentication via a username and +password will not work in most Salesforce organizations. On that date Salesforce +will begin requiring customers to enable multi-factor authentication (MFA). The +function `sf_auth()` will return the error message: ```sh INVALID_LOGIN: Invalid username, password, security token; or user locked out. diff --git a/README.md b/README.md index c59acdc7..3601aefc 100644 --- a/README.md +++ b/README.md @@ -116,9 +116,9 @@ authenticate: 2. ~~Basic Username-Password~~ **NOTE**: Beginning February 1, 2022 authentication via a username and -password will not work in most orgs. On that date Salesforce will begin -requiring customers to enable multi-factor authentication (MFA). The function -`sf_auth()` will return the error message: +password will not work in most Salesforce organizations. On that date Salesforce +will begin requiring customers to enable multi-factor authentication (MFA). The +function `sf_auth()` will return the error message: ``` sh INVALID_LOGIN: Invalid username, password, security token; or user locked out. diff --git a/cran-comments.md b/cran-comments.md index fcbb7cfa..de1bfb3b 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,22 +1,5 @@ # Release summary -## Note for CRAN Maintainers upon Submission of salesforcer 1.0.0 - -Per the request of Julia Haider, I have added \value{} specs to the .Rd files -for all exported methods and explained those values in detail. - -In addition, she requested that I explain how the issues which caused this -package to be archived have now been resolved. On June 8, 2021, CRAN archived the -{RForcecom} package. Tests and vignettes in this package referenced {RForcecom} -and it was listed in this package's DESCRIPTION file under 'Suggests'. On June 9, -2021, CRAN sent an email that this package had failing check results. The -failures were due to RForcecom having been archived on CRAN. To resolve, I -removed all executing references to the RForcecom library in the code, because -I cannot anticipate whether the author of the package will restore it to CRAN. I -was not able to complete this work by the stated deadline (June 23) because I was -traveling without connection to the tools required to make the necessary changes. -As such, CRAN archived this package. - ## Test environments * Local Mac OS install, R-release 4.0.2 @@ -27,23 +10,37 @@ As such, CRAN archived this package. ## R CMD check results -* checking CRAN incoming feasibility ... NOTE +* checking CRAN incoming feasibility ... Note_to_CRAN_maintainers Maintainer: 'Steven M. Mortimer ' -New submission - -Package was archived on CRAN - Possibly mis-spelled words in DESCRIPTION: APIs (2:42, 5:64, 9:16) JSON (9:59) -CRAN repository db overrides: - X-CRAN-Comment: Archived on 2021-06-23 as check problems were not - corrected in time. - -0 errors v | 0 warnings v | 1 note x +0 errors ✓ | 0 warnings ✓ | 0 notes ✓ ## revdepcheck results -Not done for this version because the prior version was removed from CRAN. +### Platform + +|field |value | +|:--------|:----------------------------------------| +|version |R version 4.0.2 (2020-06-22) | +|os |OS X 12.2.1 | +|system |x86_64, darwin17.0 | +|ui |RStudio | +|language |(EN) | +|collate |en_US.UTF-8 | +|ctype |en_US.UTF-8 | +|tz |America/Chicago | +|date |2022-02-27 | +|rstudio |2021.09.1+372 Ghost Orchid (desktop) | +|pandoc |2.16.2 @ /usr/local/bin/ (via rmarkdown) | + +### Dependencies + +|package |old |new |Δ | +|:-----------|:-----|:-----|:--| +|salesforcer |1.0.0 |1.0.1 |* | + +### Revdeps diff --git a/index.Rmd b/index.Rmd index fe8108c4..be089a9d 100644 --- a/index.Rmd +++ b/index.Rmd @@ -105,10 +105,10 @@ authenticate: 1. OAuth 2.0 2. ~~Basic Username-Password~~ -**NOTE**: Beginning February 1, 2022 authentication via a username and password -will not work in most orgs. On that date Salesforce will begin requiring customers -to enable multi-factor authentication (MFA). The function `sf_auth()` will -return the error message: +**NOTE**: Beginning February 1, 2022 authentication via a username and +password will not work in most Salesforce organizations. On that date Salesforce +will begin requiring customers to enable multi-factor authentication (MFA). The +function `sf_auth()` will return the error message: ```sh INVALID_LOGIN: Invalid username, password, security token; or user locked out. diff --git a/index.md b/index.md index 6aeddfc8..da65c7fd 100644 --- a/index.md +++ b/index.md @@ -116,9 +116,9 @@ authenticate: 2. ~~Basic Username-Password~~ **NOTE**: Beginning February 1, 2022 authentication via a username and -password will not work in most orgs. On that date Salesforce will begin -requiring customers to enable multi-factor authentication (MFA). The function -`sf_auth()` will return the error message: +password will not work in most Salesforce organizations. On that date Salesforce +will begin requiring customers to enable multi-factor authentication (MFA). The +function `sf_auth()` will return the error message: ``` sh INVALID_LOGIN: Invalid username, password, security token; or user locked out.