@deliverart/sdk-js-customer 0.0.1

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@deliverart/sdk-js-customer",
+  "description": "Deliverart JavaScript SDK for Customer and CustomerAddress Management",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@deliverart/sdk-js-core": "0.1.3",
+    "@deliverart/sdk-js-global-types": "0.0.13",
+    "@deliverart/sdk-js-point-of-sale": "0.0.4",
+    "@deliverart/sdk-js-user": "0.2.5",
+    "axios": "1.9.0",
+    "zod": "3.25.67"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.4",
+    "@eslint/js": "9.28.0",
+    "@types/node": "22.15.30",
+    "@typescript-eslint/eslint-plugin": "8.33.1",
+    "@typescript-eslint/parser": "8.33.1",
+    "eslint": "9.28.0",
+    "eslint-config-prettier": "10.1.5",
+    "eslint-plugin-simple-import-sort": "12.1.1",
+    "prettier": "3.5.3",
+    "tsup": "8.5.0",
+    "typescript": "5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --dts --format esm,cjs",
+    "dev": "tsup src/index.ts --dts --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "version": "@changesets/cli version",
+    "release": "@changesets/cli publish"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './models'
+export * from './requests'
+export * from './types'

package/src/models.ts

@@ -0,0 +1,102 @@
+import {
+  addressSchema,
+  billingDataSchema,
+  datetimeSchema,
+  locationSchema,
+} from '@deliverart/sdk-js-global-types'
+import { pointOfSaleNullablePathSchema } from '@deliverart/sdk-js-point-of-sale'
+import { userNullablePathSchema } from '@deliverart/sdk-js-user'
+import { z } from 'zod'
+
+import {
+  customerAddressPathSchema,
+  customerBusinessProfilePathSchema,
+  customerPathSchema,
+} from './types'
+
+export const customerSchema = z.object({
+  id: z.string(),
+  firstName: z.string().nullable(),
+  lastName: z.string().nullable(),
+  email: z.string().email().nullable(),
+  phoneNumber: z.string().nullable(),
+  hasBusinessProfiles: z.boolean(),
+  hasAddresses: z.boolean(),
+  ordersPlaced: z.number(),
+  totalSpent: z.number(),
+  createdAt: datetimeSchema,
+  updatedAt: datetimeSchema,
+})
+export type Customer = z.infer<typeof customerSchema>
+
+export const customerDetailsSchema = customerSchema.extend({
+  pointOfSale: pointOfSaleNullablePathSchema,
+  owner: userNullablePathSchema,
+  addresses: z.array(customerAddressPathSchema),
+  businessProfiles: z.array(customerBusinessProfilePathSchema),
+})
+export type CustomerDetails = z.infer<typeof customerDetailsSchema>
+
+export const writableCreateCustomerSchema = customerDetailsSchema.pick({
+  pointOfSale: true,
+  firstName: true,
+  lastName: true,
+  email: true,
+  phoneNumber: true,
+})
+export const writableCustomerSchema = writableCreateCustomerSchema.omit({
+  pointOfSale: true,
+})
+
+export const customerAddressSchema = z.object({
+  id: z.string(),
+  address: addressSchema,
+  location: locationSchema,
+  createdAt: datetimeSchema,
+  updatedAt: datetimeSchema,
+})
+export type CustomerAddress = z.infer<typeof customerAddressSchema>
+
+export const customerAddressDetailsSchema = customerAddressSchema.extend({
+  customer: customerPathSchema,
+})
+export type CustomerAddressDetails = z.infer<typeof customerAddressDetailsSchema>
+
+export const writableCreateCustomerAddressSchema = customerAddressDetailsSchema.pick({
+  customer: true,
+  address: true,
+})
+export const writableCustomerAddressSchema = writableCreateCustomerAddressSchema.omit({
+  customer: true,
+})
+
+export const customerBusinessProfileSchema = z.object({
+  id: z.string(),
+  businessName: z.string(),
+  vat: z.string(),
+  taxCode: z.string(),
+  billingAddress: addressSchema,
+  billingData: billingDataSchema,
+  createdAt: datetimeSchema,
+  updatedAt: datetimeSchema,
+})
+export type CustomerBusinessProfile = z.infer<typeof customerBusinessProfileSchema>
+
+export const customerBusinessProfileDetailsSchema = customerBusinessProfileSchema.extend({
+  customer: customerPathSchema,
+})
+export type CustomerBusinessProfileDetails = z.infer<typeof customerBusinessProfileDetailsSchema>
+
+export const writableCreateCustomerBusinessProfileSchema =
+  customerBusinessProfileDetailsSchema.pick({
+    customer: true,
+    businessName: true,
+    vat: true,
+    taxCode: true,
+    billingAddress: true,
+    billingData: true,
+  })
+export const writableCustomerBusinessProfileSchema =
+  writableCreateCustomerBusinessProfileSchema.omit({
+    customer: true,
+  })

package/src/requests/customer-addresses/CreateCustomerAddress.ts

@@ -0,0 +1,36 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import {
+  CustomerAddressDetails,
+  customerAddressDetailsSchema,
+  writableCreateCustomerAddressSchema,
+} from '../../models'
+
+export const createCustomerAddressInputSchema = writableCreateCustomerAddressSchema.required()
+export type CreateCustomerAddressInput = z.infer<typeof createCustomerAddressInputSchema>
+
+export const createCustomerAddressResponseSchema = customerAddressDetailsSchema
+export type CreateCustomerAddressResponse = CustomerAddressDetails
+
+export class CreateCustomerAddress extends AbstractApiRequest<
+  CreateCustomerAddressInput,
+  CreateCustomerAddressResponse
+> {
+  readonly method = 'POST'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = createCustomerAddressInputSchema
+  readonly outputSchema = createCustomerAddressResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  constructor(input: CreateCustomerAddressInput) {
+    super(input)
+  }
+
+  getPath(): string {
+    return '/customers/addresses'
+  }
+}

package/src/requests/customer-addresses/DeleteCustomerAddress.ts

@@ -0,0 +1,27 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+export const deleteCustomerAddressInputSchema = z.undefined()
+export const deleteCustomerAddressResponseSchema = z.undefined()
+
+export class DeleteCustomerAddress extends AbstractApiRequest<void, void> {
+  readonly method = 'DELETE'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = deleteCustomerAddressInputSchema
+  readonly outputSchema = deleteCustomerAddressResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly customerAddressId: string
+
+  constructor(customerAddressId: string) {
+    super()
+    this.customerAddressId = customerAddressId
+  }
+
+  getPath(): string {
+    return `/customers/addresses/${this.customerAddressId}`
+  }
+}

package/src/requests/customer-addresses/GetCustomerAddressDetails.ts

@@ -0,0 +1,33 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import { CustomerAddressDetails, customerAddressDetailsSchema } from '../../models'
+
+export const getCustomerAddressDetailsInputSchema = z.undefined()
+
+export const getCustomerAddressDetailsResponseSchema = customerAddressDetailsSchema
+export type GetCustomerAddressDetailsResponse = CustomerAddressDetails
+
+export class GetCustomerAddressDetails extends AbstractApiRequest<
+  void,
+  GetCustomerAddressDetailsResponse
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+  readonly inputSchema = getCustomerAddressDetailsInputSchema
+  readonly outputSchema = getCustomerAddressDetailsResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly customerAddressId: string
+
+  constructor(customerAddressId: string) {
+    super()
+    this.customerAddressId = customerAddressId
+  }
+
+  getPath(): string {
+    return `/customers/addresses/${this.customerAddressId}`
+  }
+}

package/src/requests/customer-addresses/GetCustomerAddresses.ts

@@ -0,0 +1,57 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import {
+  createPaginatedSchema,
+  Paginated,
+  responseToPagination,
+  sortDirSchema,
+  timestampsFilterSchema,
+} from '@deliverart/sdk-js-global-types'
+import { AxiosResponse } from 'axios'
+import { z } from 'zod'
+
+import { CustomerAddress, customerAddressSchema } from '../../models'
+
+export const getCustomerAddressesQuerySchema = z
+  .object({
+    'order[createdAt]': sortDirSchema.optional(),
+    'order[updatedAt]': sortDirSchema.optional(),
+    page: z.coerce.number().optional(),
+  })
+  .merge(timestampsFilterSchema)
+export type GetCustomerAddressesQueryParams = z.infer<typeof getCustomerAddressesQuerySchema>
+
+export const getCustomerAddressesResponseSchema = createPaginatedSchema(customerAddressSchema)
+export type GetCustomerAddressesResponse = z.infer<typeof getCustomerAddressesResponseSchema>
+
+export const getCustomerAddressesInputSchema = z.undefined()
+
+export class GetCustomerAddresses extends AbstractApiRequest<
+  void,
+  GetCustomerAddressesResponse,
+  GetCustomerAddressesQueryParams
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = getCustomerAddressesInputSchema
+  readonly outputSchema = getCustomerAddressesResponseSchema
+  readonly querySchema = getCustomerAddressesQuerySchema
+  readonly headersSchema = undefined
+
+  constructor(options?: { query?: GetCustomerAddressesQueryParams }) {
+    super(undefined, options)
+  }
+
+  getPath(): string {
+    return '/customers/addresses'
+  }
+
+  parseResponse(data: unknown, rawResponse: AxiosResponse): Paginated<CustomerAddress> {
+    const customerAddresses = z.array(customerAddressSchema).parse(data)
+    return this.validateOutput({
+      data: customerAddresses,
+      pagination: responseToPagination(rawResponse),
+    })
+  }
+}

package/src/requests/customer-addresses/GetCustomerAddressesForCustomer.ts

@@ -0,0 +1,55 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { sortDirSchema, timestampsFilterSchema } from '@deliverart/sdk-js-global-types'
+import { z } from 'zod'
+
+import { CustomerAddress, customerAddressSchema } from '../../models'
+
+export const getCustomerAddressesForCustomerQuerySchema = z
+  .object({
+    'order[createdAt]': sortDirSchema.optional(),
+    'order[updatedAt]': sortDirSchema.optional(),
+  })
+  .merge(timestampsFilterSchema)
+export type GetCustomerAddressesForCustomerQueryParams = z.infer<
+  typeof getCustomerAddressesForCustomerQuerySchema
+>
+
+export const getCustomerAddressesForCustomerResponseSchema = z.array(customerAddressSchema)
+export type GetCustomerAddressesForCustomerResponse = z.infer<
+  typeof getCustomerAddressesForCustomerResponseSchema
+>
+
+export const getCustomerAddressesForCustomerInputSchema = z.undefined()
+
+export class GetCustomerAddressesForCustomer extends AbstractApiRequest<
+  void,
+  GetCustomerAddressesForCustomerResponse,
+  GetCustomerAddressesForCustomerQueryParams
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = getCustomerAddressesForCustomerInputSchema
+  readonly outputSchema = getCustomerAddressesForCustomerResponseSchema
+  readonly querySchema = getCustomerAddressesForCustomerQuerySchema
+  readonly headersSchema = undefined
+
+  private readonly customerId: string
+
+  constructor(
+    customerId: string,
+    options?: { query?: GetCustomerAddressesForCustomerQueryParams },
+  ) {
+    super(undefined, options)
+    this.customerId = customerId
+  }
+
+  getPath(): string {
+    return `/customers/${this.customerId}/addresses`
+  }
+
+  parseResponse(data: unknown): CustomerAddress[] {
+    return z.array(customerAddressSchema).parse(data)
+  }
+}

package/src/requests/customer-addresses/UpdateCustomerAddress.ts

@@ -0,0 +1,39 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import {
+  CustomerAddressDetails,
+  customerAddressDetailsSchema,
+  writableCustomerAddressSchema,
+} from '../../models'
+
+export const updateCustomerAddressInputSchema = writableCustomerAddressSchema.partial()
+export type UpdateCustomerAddressInput = z.infer<typeof updateCustomerAddressInputSchema>
+
+export const updateCustomerAddressResponseSchema = customerAddressDetailsSchema
+export type UpdateCustomerAddressResponse = CustomerAddressDetails
+
+export class UpdateCustomerAddress extends AbstractApiRequest<
+  UpdateCustomerAddressInput,
+  UpdateCustomerAddressResponse
+> {
+  readonly method = 'PATCH'
+  readonly contentType = 'application/merge-patch+json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = updateCustomerAddressInputSchema
+  readonly outputSchema = updateCustomerAddressResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly customerId: string
+
+  constructor(customerId: string, input: UpdateCustomerAddressInput) {
+    super(input)
+    this.customerId = customerId
+  }
+
+  getPath(): string {
+    return `/customers/addresses/${this.customerId}`
+  }
+}

package/src/requests/customer-addresses/index.ts

@@ -0,0 +1,6 @@
+export * from './CreateCustomerAddress'
+export * from './DeleteCustomerAddress'
+export * from './GetCustomerAddressDetails'
+export * from './GetCustomerAddresses'
+export * from './GetCustomerAddressesForCustomer'
+export * from './UpdateCustomerAddress'

package/src/requests/customer-business-profiles/CreateCustomerBusinessProfile.ts

@@ -0,0 +1,39 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import {
+  CustomerBusinessProfileDetails,
+  customerBusinessProfileDetailsSchema,
+  writableCreateCustomerBusinessProfileSchema,
+} from '../../models'
+
+export const createCustomerBusinessProfileInputSchema =
+  writableCreateCustomerBusinessProfileSchema.required()
+export type CreateCustomerBusinessProfileInput = z.infer<
+  typeof createCustomerBusinessProfileInputSchema
+>
+
+export const createCustomerBusinessProfileResponseSchema = customerBusinessProfileDetailsSchema
+export type CreateCustomerBusinessProfileResponse = CustomerBusinessProfileDetails
+
+export class CreateCustomerBusinessProfile extends AbstractApiRequest<
+  CreateCustomerBusinessProfileInput,
+  CreateCustomerBusinessProfileResponse
+> {
+  readonly method = 'POST'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = createCustomerBusinessProfileInputSchema
+  readonly outputSchema = createCustomerBusinessProfileResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  constructor(input: CreateCustomerBusinessProfileInput) {
+    super(input)
+  }
+
+  getPath(): string {
+    return '/customers/business_profiles'
+  }
+}

package/src/requests/customer-business-profiles/DeleteCustomerBusinessProfile.ts

@@ -0,0 +1,27 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+export const deleteCustomerBusinessProfileInputSchema = z.undefined()
+export const deleteCustomerBusinessProfileResponseSchema = z.undefined()
+
+export class DeleteCustomerBusinessProfile extends AbstractApiRequest<void, void> {
+  readonly method = 'DELETE'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = deleteCustomerBusinessProfileInputSchema
+  readonly outputSchema = deleteCustomerBusinessProfileResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly customerBusinessProfileId: string
+
+  constructor(customerBusinessProfileId: string) {
+    super()
+    this.customerBusinessProfileId = customerBusinessProfileId
+  }
+
+  getPath(): string {
+    return `/customers/business_profiles/${this.customerBusinessProfileId}`
+  }
+}

package/src/requests/customer-business-profiles/GetCustomerBusinessProfileDetails.ts

@@ -0,0 +1,33 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { z } from 'zod'
+
+import { CustomerBusinessProfileDetails, customerBusinessProfileDetailsSchema } from '../../models'
+
+export const getCustomerBusinessProfileDetailsInputSchema = z.undefined()
+
+export const getCustomerBusinessProfileDetailsResponseSchema = customerBusinessProfileDetailsSchema
+export type GetCustomerBusinessProfileDetailsResponse = CustomerBusinessProfileDetails
+
+export class GetCustomerBusinessProfileDetails extends AbstractApiRequest<
+  void,
+  GetCustomerBusinessProfileDetailsResponse
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+  readonly inputSchema = getCustomerBusinessProfileDetailsInputSchema
+  readonly outputSchema = getCustomerBusinessProfileDetailsResponseSchema
+  readonly querySchema = undefined
+  readonly headersSchema = undefined
+
+  private readonly customerBusinessProfileId: string
+
+  constructor(customerBusinessProfileId: string) {
+    super()
+    this.customerBusinessProfileId = customerBusinessProfileId
+  }
+
+  getPath(): string {
+    return `/customers/business_profiles/${this.customerBusinessProfileId}`
+  }
+}

package/src/requests/customer-business-profiles/GetCustomerBusinessProfiles.ts

@@ -0,0 +1,67 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import {
+  createPaginatedSchema,
+  Paginated,
+  responseToPagination,
+  sortDirSchema,
+  timestampsFilterSchema,
+} from '@deliverart/sdk-js-global-types'
+import { AxiosResponse } from 'axios'
+import { z } from 'zod'
+
+import { CustomerBusinessProfile, customerBusinessProfileSchema } from '../../models'
+
+export const getCustomerBusinessProfilesQuerySchema = z
+  .object({
+    'order[businessName]': sortDirSchema.optional(),
+    'order[createdAt]': sortDirSchema.optional(),
+    'order[updatedAt]': sortDirSchema.optional(),
+    businessName: z.string().optional(),
+    vat: z.string().optional(),
+    taxCode: z.string().optional(),
+    page: z.coerce.number().optional(),
+  })
+  .merge(timestampsFilterSchema)
+export type GetCustomerBusinessProfilesQueryParams = z.infer<
+  typeof getCustomerBusinessProfilesQuerySchema
+>
+
+export const getCustomerBusinessProfilesResponseSchema = createPaginatedSchema(
+  customerBusinessProfileSchema,
+)
+export type GetCustomerBusinessProfilesResponse = z.infer<
+  typeof getCustomerBusinessProfilesResponseSchema
+>
+
+export const getCustomerBusinessProfilesInputSchema = z.undefined()
+
+export class GetCustomerBusinessProfiles extends AbstractApiRequest<
+  void,
+  GetCustomerBusinessProfilesResponse,
+  GetCustomerBusinessProfilesQueryParams
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = getCustomerBusinessProfilesInputSchema
+  readonly outputSchema = getCustomerBusinessProfilesResponseSchema
+  readonly querySchema = getCustomerBusinessProfilesQuerySchema
+  readonly headersSchema = undefined
+
+  constructor(options?: { query?: GetCustomerBusinessProfilesQueryParams }) {
+    super(undefined, options)
+  }
+
+  getPath(): string {
+    return '/customers/business_profiles'
+  }
+
+  parseResponse(data: unknown, rawResponse: AxiosResponse): Paginated<CustomerBusinessProfile> {
+    const customerBusinessProfiles = z.array(customerBusinessProfileSchema).parse(data)
+    return this.validateOutput({
+      data: customerBusinessProfiles,
+      pagination: responseToPagination(rawResponse),
+    })
+  }
+}

package/src/requests/customer-business-profiles/GetCustomerBusinessProfilesForCustomer.ts

@@ -0,0 +1,61 @@
+import { AbstractApiRequest } from '@deliverart/sdk-js-core'
+import { sortDirSchema, timestampsFilterSchema } from '@deliverart/sdk-js-global-types'
+import { z } from 'zod'
+
+import { CustomerBusinessProfile, customerBusinessProfileSchema } from '../../models'
+
+export const getCustomerBusinessProfilesForCustomerQuerySchema = z
+  .object({
+    'order[businessName]': sortDirSchema.optional(),
+    'order[createdAt]': sortDirSchema.optional(),
+    'order[updatedAt]': sortDirSchema.optional(),
+    businessName: z.string().optional(),
+    vat: z.string().optional(),
+    taxCode: z.string().optional(),
+  })
+  .merge(timestampsFilterSchema)
+export type GetCustomerBusinessProfilesForCustomerQueryParams = z.infer<
+  typeof getCustomerBusinessProfilesForCustomerQuerySchema
+>
+
+export const getCustomerBusinessProfilesForCustomerResponseSchema = z.array(
+  customerBusinessProfileSchema,
+)
+export type GetCustomerBusinessProfilesForCustomerResponse = z.infer<
+  typeof getCustomerBusinessProfilesForCustomerResponseSchema
+>
+
+export const getCustomerBusinessProfilesForCustomerInputSchema = z.undefined()
+
+export class GetCustomerBusinessProfilesForCustomer extends AbstractApiRequest<
+  void,
+  GetCustomerBusinessProfilesForCustomerResponse,
+  GetCustomerBusinessProfilesForCustomerQueryParams
+> {
+  readonly method = 'GET'
+  readonly contentType = 'application/json'
+  readonly accept = 'application/json'
+
+  readonly inputSchema = getCustomerBusinessProfilesForCustomerInputSchema
+  readonly outputSchema = getCustomerBusinessProfilesForCustomerResponseSchema
+  readonly querySchema = getCustomerBusinessProfilesForCustomerQuerySchema
+  readonly headersSchema = undefined
+
+  private readonly customerId: string
+
+  constructor(
+    customerId: string,
+    options?: { query?: GetCustomerBusinessProfilesForCustomerQueryParams },
+  ) {
+    super(undefined, options)
+    this.customerId = customerId
+  }
+
+  getPath(): string {
+    return `/customers/${this.customerId}/business_profiles`
+  }
+
+  parseResponse(data: unknown): CustomerBusinessProfile[] {
+    return z.array(customerBusinessProfileSchema).parse(data)
+  }
+}