Files
simstudioai--sim/apps/sim/tools/shopify/create_customer.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

212 lines
5.1 KiB
TypeScript

import type { ShopifyCreateCustomerParams, ShopifyCustomerResponse } from '@/tools/shopify/types'
import { CUSTOMER_OUTPUT_PROPERTIES } from '@/tools/shopify/types'
import type { ToolConfig } from '@/tools/types'
export const shopifyCreateCustomerTool: ToolConfig<
ShopifyCreateCustomerParams,
ShopifyCustomerResponse
> = {
id: 'shopify_create_customer',
name: 'Shopify Create Customer',
description: 'Create a new customer in your Shopify store',
version: '1.0.0',
oauth: {
required: true,
provider: 'shopify',
},
params: {
shopDomain: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Your Shopify store domain (e.g., mystore.myshopify.com)',
},
email: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Customer email address',
},
firstName: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Customer first name',
},
lastName: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Customer last name',
},
phone: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Customer phone number',
},
note: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Note about the customer',
},
tags: {
type: 'array',
required: false,
visibility: 'user-or-llm',
description: 'Customer tags',
},
addresses: {
type: 'array',
required: false,
visibility: 'user-or-llm',
description: 'Customer addresses',
},
},
request: {
url: (params) =>
`https://${params.shopDomain || params.idToken}/admin/api/2024-10/graphql.json`,
method: 'POST',
headers: (params) => {
if (!params.accessToken) {
throw new Error('Missing access token for Shopify API request')
}
return {
'Content-Type': 'application/json',
'X-Shopify-Access-Token': params.accessToken,
}
},
body: (params) => {
// Shopify requires at least one of: email, phone, firstName, or lastName
const hasEmail = params.email?.trim()
const hasPhone = params.phone?.trim()
const hasFirstName = params.firstName?.trim()
const hasLastName = params.lastName?.trim()
if (!hasEmail && !hasPhone && !hasFirstName && !hasLastName) {
throw new Error('Customer must have at least one of: email, phone, firstName, or lastName')
}
const input: Record<string, unknown> = {}
if (hasEmail) {
input.email = params.email
}
if (hasFirstName) {
input.firstName = params.firstName
}
if (hasLastName) {
input.lastName = params.lastName
}
if (hasPhone) {
input.phone = params.phone
}
if (params.note) {
input.note = params.note
}
if (params.tags && Array.isArray(params.tags)) {
input.tags = params.tags
}
if (params.addresses && Array.isArray(params.addresses)) {
input.addresses = params.addresses
}
return {
query: `
mutation customerCreate($input: CustomerInput!) {
customerCreate(input: $input) {
customer {
id
email
firstName
lastName
phone
createdAt
updatedAt
note
tags
amountSpent {
amount
currencyCode
}
addresses {
address1
address2
city
province
country
zip
phone
}
defaultAddress {
address1
city
province
country
zip
}
}
userErrors {
field
message
}
}
}
`,
variables: {
input,
},
}
},
},
transformResponse: async (response) => {
const data = await response.json()
if (data.errors) {
return {
success: false,
error: data.errors[0]?.message || 'Failed to create customer',
output: {},
}
}
const result = data.data?.customerCreate
if (result?.userErrors?.length > 0) {
return {
success: false,
error: result.userErrors.map((e: { message: string }) => e.message).join(', '),
output: {},
}
}
const customer = result?.customer
if (!customer) {
return {
success: false,
error: 'Customer creation was not successful',
output: {},
}
}
return {
success: true,
output: {
customer,
},
}
},
outputs: {
customer: {
type: 'object',
description: 'The created customer',
properties: CUSTOMER_OUTPUT_PROPERTIES,
},
},
}