Class SapoClient

constructor

• new SapoClient(config): SapoClient

• Parameters

  • config: AuthConfig

  Returns SapoClient

Readonly blogs

Readonly collections

Readonly customers

Readonly fulfillments

Readonly inventory

Readonly metafields

Readonly orders

Readonly pages

Readonly priceRules

Readonly products

Readonly webhooks

completeOAuth

• completeOAuth(store, callbackUrl): Promise<string>

• Complete OAuth flow and get access token

  Parameters

  • store: string
  • callbackUrl: string

  Returns Promise<string>

delete

• delete<T>(path, params?): Promise<T>

• Make a DELETE request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optional params: Record<string, any>

  Returns Promise<T>

get

• get<T>(path, params?): Promise<T>

• Make a GET request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optional params: Record<string, any>

  Returns Promise<T>

getAuthorizationUrl

• getAuthorizationUrl(store, scopes): string

• Get OAuth authorization URL

  Parameters

  • store: string
  • scopes: Scope[]

  Returns string

getRateLimits

• getRateLimits(): RateLimit

• Get current rate limit information

  Returns RateLimit

post

• post<T>(path, data?): Promise<T>

• Make a POST request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optional data: any

  Returns Promise<T>

put

• put<T>(path, data?): Promise<T>

• Make a PUT request

  Type Parameters

  • T

  Parameters

  • path: string
  • Optional data: any

  Returns Promise<T>

setAccessToken

• setAccessToken(token): void

• Set access token for authenticated requests

  Parameters

  • token: string

  Returns void

setStore

• setStore(store): void

• Set store URL for API requests

  Parameters

  • store: string

  Returns void

verifyWebhookHmac

• verifyWebhookHmac(query, hmac): boolean

• Verify webhook HMAC signature

  Parameters

  • query: Record<string, string>
  • hmac: string

  Returns boolean