Squarespace Api

gem 'squarespace_api'

require 'squarespace_api'

client = SquarespaceApi::Client.new(
  SquarespaceApi::Config.new(
    access_token: 'your access token'
  )
)

# get one page of order
client.orders.all
=> [<SquarespaceOrderHash>, ...]


# get every page of orders with filter
orders = []
orders = client.orders.all(fulfillmentStatus: 'PENDING') do |orders_per_page|
  orders += orders_per_page
  # or do something
end

# get website
client.website

# get one page
client.orders.all(fulfillmentStatus: 'PENDING')

# get all pages
orders = []
orders = client.orders.all(fulfillmentStatus: 'PENDING') do |orders_per_page|
  orders += orders_per_page
  # or do something
end

# find an order
client.orders.find(id)

# create an order
client.orders.create(params)

# fulfill an order
client.orders.fulfil(id, params)

client.products.all
client.products.create(params)
client.products.where(id: id)
client.products.find(id)
client.products.find_by_ids([id_1, id_2])
client.products.update(id, params)
client.products.delete(id)

# Noted that Path parameters should be passed in params.
client.product_images.upload(file_path, { product_id: product_id })
client.product_images.status(id, { product_id: product_id })
client.product_images.order(id, { product_id: product_id, afterImageId: 'otherImageId' })
client.product_images.update(id, { product_id: product_id, altText: 'my_picture' })

# Noted that Path parameters should be passed in params.
client.product_variants.create({ product_id: product_id })
client.product_variants.update(id, { sku: 'P1234', product_id: product_id })

# Noted that Path parameters should be passed in body params.
client.product_variant_images.create({ imageId: image_id, product_id: product_id, variant_id: variant_id })

client.inventory.all
client.inventory.find(id)
client.inventory_adjustments.create(params)

client.profiles.all
client.profiles.find(id)
client.profiles.create(params)

client.store_pages.all

client.transactions.all
client.transactions.find(id)
client.transactions.find_by_ids([id_1, id_2])

client.webhook_subscriptions.all
client.webhook_subscriptions.find(id)
client.webhook_subscriptions.create(id)
client.webhook_subscriptions.update(id, params)
client.webhook_subscriptions.delete(id)
client.webhook_subscriptions.send_test_notification(id, params)
client.webhook_subscriptions.rotate_secret(id)

client.website

# Auto load ENV
SQUARESPACE_CLIENT_ID = 'your client id'
SQUARESPACE_CLIENT_SECRET = 'your client secret'

SquarespaceApi.configure do |c|
  c.client_id = 'your client id'
  c.client_secret = 'your client secret'
end

client = SquarespaceApi::Client.new(
  SquarespaceApi::Config.new(
    client_id: 'your client id',
    client_secret: 'your client secret'
  )
)

SquarespaceApi::Client.new.build_oauth_authorize_url(
  redirect_url: 'https://api.test.com/squarespace',
  scope: 'website.orders,website.orders.read',
  state: '1234',
  access_type: "offline"
)

=> 'https://login.squarespace.com/api/1/login/oauth/provider/authorize?client_id=&redirect_url=https://api.test.com/squarespace&scope=website.orders,website.orders.read&state=1234&access_type=offline'

# request access token
client.tokens.create(
  code: 'code sent from Squaerspace',
  redirect_uri: "your redirect uri"
)

client.tokens.create(
  refresh_token: 'some_refresh_token',
  grant_type: "refresh_token"
)