1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[937],{19474:(i,e,s)=>{(window.__NEXT_P=window.__NEXT_P||[]).push(["/Classes/BigCommerce/Api/Base_Client",function(){return s(90093)}])},90093:(i,e,s)=>{"use strict";s.r(e),s.d(e,{default:()=>d,useTOC:()=>r});var n=s(74848),h=s(27849),t=s(40272),l=s(71355);function r(i){return[{value:"Properties",id:"properties",depth:2},{value:"config",id:"config",depth:3},{value:"Methods",id:"methods",depth:2},{value:"__construct",id:"__construct",depth:3},{value:"getConfig",id:"getconfig",depth:3}]}let d=(0,h.e)(function(i){let{toc:e=r(i)}=i,s={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",span:"span",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,l.R)(),...i.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h1,{children:"Base_Client"}),"\n",(0,n.jsx)(s.p,{children:"Base API client class that extends the ApiClient and manages the configuration\nof the API client. This class is designed to handle the configuration for\nAPI communication and can be extended for specific API clients."}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["Full name: ",(0,n.jsx)(s.code,{children:"\\BigCommerce\\Api\\Base_Client"})]}),"\n",(0,n.jsxs)(s.li,{children:["Parent class: ",(0,n.jsx)(s.a,{href:"./classes/BigCommerce/Api/v3/ApiClient",children:(0,n.jsx)(s.code,{children:"ApiClient"})})]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:e[0].id,children:e[0].value}),"\n",(0,n.jsx)(s.h3,{id:e[1].id,children:e[1].value}),"\n",(0,n.jsx)(s.p,{children:"Configuration for the API client"}),"\n",(0,n.jsx)(s.pre,{tabIndex:"0","data-language":"php","data-word-wrap":"",children:(0,n.jsx)(s.code,{children:(0,n.jsxs)(s.span,{children:[(0,n.jsx)(s.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"protected"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" \\BigCommerce\\Api\\Configuration"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" $config"})]})})}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h2,{id:e[2].id,children:e[2].value}),"\n",(0,n.jsx)(s.h3,{id:e[3].id,children:e[3].value}),"\n",(0,n.jsx)(s.p,{children:"Constructor for the Base_Client class"}),"\n",(0,n.jsx)(s.pre,{tabIndex:"0","data-language":"php","data-word-wrap":"",children:(0,n.jsx)(s.code,{children:(0,n.jsxs)(s.span,{children:[(0,n.jsx)(s.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"public"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" __construct"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"(\\"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"BigCommerce"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"\\"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"Api"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"\\"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"Configuration"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"|"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"null"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" $config "}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"="}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" null"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"): "}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"mixed"})]})})}),"\n",(0,n.jsx)(s.p,{children:"Initializes the API client with the provided configuration. If no configuration\nis provided, it will use the default configuration."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Parameters:"})}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Type"}),(0,n.jsx)(s.th,{children:"Description"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:(0,n.jsx)(s.code,{children:"$config"})}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.strong,{children:"\\BigCommerce\\Api\\Configuration|null"})}),(0,n.jsx)(s.td,{children:"The configuration for this ApiClient."})]})})]}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.h3,{id:e[4].id,children:e[4].value}),"\n",(0,n.jsx)(s.p,{children:"Gets the configuration of the API client"}),"\n",(0,n.jsx)(s.pre,{tabIndex:"0","data-language":"php","data-word-wrap":"",children:(0,n.jsx)(s.code,{children:(0,n.jsxs)(s.span,{children:[(0,n.jsx)(s.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"public"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" getConfig"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"}
1,children:"(): \\"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"BigCommerce"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"\\"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"Api"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"\\"}),(0,n.jsx)(s.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:"Configuration"})]})})}),"\n",(0,n.jsx)(s.p,{children:"Returns the configuration object used by the API client."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Return Value:"})}),"\n",(0,n.jsx)(s.p,{children:"Returns the Configuration object used by this API client."}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsxs)(s.blockquote,{children:["\n",(0,n.jsx)(s.p,{children:"Automatically generated on 2025-01-21"}),"\n"]})]})},"/Classes/BigCommerce/Api/Base_Client",{filePath:"pages/Classes/BigCommerce/Api/Base_Client.md",timestamp:1737496368e3,pageMap:t.O,frontMatter:{},title:"Base_Client"},"undefined"==typeof RemoteContent?r:RemoteContent.useTOC)}},i=>{var e=e=>i(i.s=e);i.O(0,[27849,40272,90636,46593,38792],()=>e(19474)),_N_E=i.O()}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.