arky-sdk 0.4.44 → 0.4.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- import { RequestOptions, MagicLinkVerifyParams, MagicLinkRequestParams, UpdateAccountProfileParams, DeleteAccountParams, AddPhoneNumberParams, PhoneNumberConfirmParams, GetMeParams, SearchAccountsParams, AccountSubscribeParams, CreateBusinessParams, UpdateBusinessParams, DeleteBusinessParams, GetBusinessParams, GetBusinessesParams, GetBusinessParentsParams, TriggerBuildsParams, GetSubscriptionPlansParams, GetSubscriptionParams, SubscribeParams, CreatePortalSessionParams, InviteUserParams, HandleInvitationParams, TestWebhookParams, GetBusinessMediaParams2, ProcessRefundParams, GetBusinessEventsParams, UpdateBusinessEventParams, ConnectStripeParams, DisconnectStripeParams, UploadBusinessMediaParams, DeleteBusinessMediaParams, GetBusinessMediaParams, UpdateMediaParams, TrackEmailOpenParams, GetDeliveryStatsParams, CreatePromoCodeParams, UpdatePromoCodeParams, DeletePromoCodeParams, GetPromoCodeParams, GetPromoCodesParams, CreateNodeParams, UpdateNodeParams, DeleteNodeParams, GetNodeParams, GetNodesParams, GetNodeChildrenParams, GenerateBlocksParams, GetVariableMetadataParams, CreateProductParams, UpdateProductParams, DeleteProductParams, GetProductParams, GetProductsParams, CreateOrderParams, UpdateOrderParams, GetOrderParams, GetOrdersParams, GetQuoteParams, OrderCheckoutParams, Slot, CreateReservationParams, UpdateReservationParams, ReservationCheckoutParams, GetReservationParams, SearchReservationsParams, GetReservationQuoteParams, CreateServiceParams, UpdateServiceParams, DeleteServiceParams, BulkScheduleParams, GetServiceParams, GetServicesParams, CreateProviderParams, UpdateProviderParams, DeleteProviderParams, GetProviderParams, GetProvidersParams, GetBusinessServiceWorkingTimeParams, CreateWorkflowParams, UpdateWorkflowParams, DeleteWorkflowParams, GetWorkflowParams, GetWorkflowsParams, TriggerWorkflowParams, CreateAudienceParams, UpdateAudienceParams, GetAudienceParams, GetAudiencesParams, SubscribeAudienceParams, GetAudienceSubscribersParams, RevokeAudienceSubscriptionParams, GetShippingRatesParams, ShippingRate, PurchaseLabelParams, PurchaseLabelResult } from './types.cjs';
2
- export { Access, Address, AnalyticsConfig, ApiResponse, Audience, AudienceAccessResponse, AudienceSubscribeResponse, AudienceSubscriber, Block, Business, BusinessConfig, BusinessEvent, BusinessEventAction, BusinessShippingProvider, DayAvailability, EshopCartItem, EshopStoreState, GeoLocation, GeoLocationBlock, GetAvailabilityParams, GetSlotsForDateParams, Language, Location, Market, Media, MediaResolution, Node, OrderShipping, PaginatedResponse, Parcel, Payment, PaymentMethod, PaymentMethodType, PaymentProviderConfig, PaymentRefund, Price, PromoCodeValidation, ProviderWithTimeline, Quote, ReservationCartItem, ReservationStoreState, ShippingAddress, ShippingMethod, ShippingProviderShippo, ShippingProviderStatus, ShippingStatus, ShippingWeightTier, SystemTemplateKey, Workflow, WorkflowEdge, WorkflowHttpMethod, WorkflowHttpNode, WorkflowIfNode, WorkflowLoopNode, WorkflowNode, WorkflowTriggerNode, WorkflowWaitNode, Zone, ZoneLocation } from './types.cjs';
1
+ import { RequestOptions, MagicLinkVerifyParams, MagicLinkRequestParams, UpdateAccountProfileParams, DeleteAccountParams, AddPhoneNumberParams, PhoneNumberConfirmParams, GetMeParams, SearchAccountsParams, AccountSubscribeParams, CreateBusinessParams, UpdateBusinessParams, DeleteBusinessParams, GetBusinessParams, GetBusinessesParams, GetBusinessParentsParams, TriggerBuildsParams, GetSubscriptionPlansParams, GetSubscriptionParams, SubscribeParams, CreatePortalSessionParams, InviteUserParams, HandleInvitationParams, TestWebhookParams, GetBusinessMediaParams2, ProcessRefundParams, GetBusinessEventsParams, UpdateBusinessEventParams, ConnectStripeParams, DisconnectStripeParams, UploadBusinessMediaParams, DeleteBusinessMediaParams, GetBusinessMediaParams, UpdateMediaParams, TrackEmailOpenParams, GetDeliveryStatsParams, CreatePromoCodeParams, UpdatePromoCodeParams, DeletePromoCodeParams, GetPromoCodeParams, GetPromoCodesParams, CreateNodeParams, UpdateNodeParams, DeleteNodeParams, GetNodeParams, GetNodesParams, GetNodeChildrenParams, GenerateBlocksParams, GetVariableMetadataParams, CreateProductParams, UpdateProductParams, DeleteProductParams, GetProductParams, GetProductsParams, CreateOrderParams, UpdateOrderParams, GetOrderParams, GetOrdersParams, GetQuoteParams, OrderCheckoutParams, Slot, CreateReservationParams, UpdateReservationParams, ReservationCheckoutParams, GetReservationParams, SearchReservationsParams, GetReservationQuoteParams, CreateServiceParams, UpdateServiceParams, DeleteServiceParams, BulkScheduleParams, GetServiceParams, GetServicesParams, CreateProviderParams, UpdateProviderParams, DeleteProviderParams, GetProviderParams, GetProvidersParams, GetBusinessServiceWorkingTimeParams, CreateWorkflowParams, UpdateWorkflowParams, DeleteWorkflowParams, GetWorkflowParams, GetWorkflowsParams, TriggerWorkflowParams, CreateAudienceParams, UpdateAudienceParams, GetAudienceParams, GetAudiencesParams, SubscribeAudienceParams, GetAudienceSubscribersParams, RevokeAudienceSubscriptionParams, GetShippingRatesParams, ShippingRate, ShipParams, ShipResult } from './types.cjs';
2
+ export { Access, Address, AnalyticsConfig, ApiResponse, Audience, AudienceAccessResponse, AudienceSubscribeResponse, AudienceSubscriber, Block, Business, BusinessConfig, BusinessEvent, BusinessEventAction, BusinessShippingProvider, CustomsDeclaration, CustomsItem, DayAvailability, EshopCartItem, EshopStoreState, GeoLocation, GeoLocationBlock, GetAvailabilityParams, GetSlotsForDateParams, Language, Location, Market, Media, MediaResolution, Node, OrderShipping, PaginatedResponse, Parcel, Payment, PaymentMethod, PaymentMethodType, PaymentProviderConfig, PaymentRefund, Price, PromoCodeValidation, ProviderWithTimeline, PurchaseLabelResult, Quote, ReservationCartItem, ReservationStoreState, Shipment, ShipmentLine, ShippingAddress, ShippingMethod, ShippingProviderShippo, ShippingProviderStatus, ShippingStatus, ShippingWeightTier, SystemTemplateKey, Workflow, WorkflowEdge, WorkflowHttpMethod, WorkflowHttpNode, WorkflowIfNode, WorkflowLoopNode, WorkflowNode, WorkflowTriggerNode, WorkflowWaitNode, Zone, ZoneLocation } from './types.cjs';
3
3
  import { f as formatPayment, a as formatMinor, g as getCurrencySymbol, b as getCurrencyName, i as isValidKey, v as validateKey, t as toKey, n as nameToKey, c as getAvailableStock, d as getReservedStock, h as hasStock, e as getInventoryAt, j as getFirstAvailableFCId } from './index-C28uWlRE.cjs';
4
4
 
5
5
  interface AuthTokens {
@@ -291,7 +291,7 @@ declare function createArkySDK(config: HttpClientConfig & {
291
291
  getRates(params: GetShippingRatesParams, options?: RequestOptions): Promise<{
292
292
  rates: ShippingRate[];
293
293
  }>;
294
- purchaseLabel(params: PurchaseLabelParams, options?: RequestOptions): Promise<PurchaseLabelResult>;
294
+ ship(params: ShipParams, options?: RequestOptions): Promise<ShipResult>;
295
295
  };
296
296
  analytics: {
297
297
  track: typeof track;
@@ -355,4 +355,4 @@ declare function createArkySDK(config: HttpClientConfig & {
355
355
  getStripeConnectClientId: () => string;
356
356
  }>;
357
357
 
358
- export { type ApiConfig, type GetCountriesResponse, GetShippingRatesParams, type HttpClientConfig, type LocationCountry, type LocationState, PurchaseLabelParams, PurchaseLabelResult, SDK_VERSION, SUPPORTED_FRAMEWORKS, ShippingRate, Slot, createArkySDK };
358
+ export { type ApiConfig, type GetCountriesResponse, GetShippingRatesParams, type HttpClientConfig, type LocationCountry, type LocationState, SDK_VERSION, SUPPORTED_FRAMEWORKS, ShipParams, ShipResult, ShippingRate, Slot, createArkySDK };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { RequestOptions, MagicLinkVerifyParams, MagicLinkRequestParams, UpdateAccountProfileParams, DeleteAccountParams, AddPhoneNumberParams, PhoneNumberConfirmParams, GetMeParams, SearchAccountsParams, AccountSubscribeParams, CreateBusinessParams, UpdateBusinessParams, DeleteBusinessParams, GetBusinessParams, GetBusinessesParams, GetBusinessParentsParams, TriggerBuildsParams, GetSubscriptionPlansParams, GetSubscriptionParams, SubscribeParams, CreatePortalSessionParams, InviteUserParams, HandleInvitationParams, TestWebhookParams, GetBusinessMediaParams2, ProcessRefundParams, GetBusinessEventsParams, UpdateBusinessEventParams, ConnectStripeParams, DisconnectStripeParams, UploadBusinessMediaParams, DeleteBusinessMediaParams, GetBusinessMediaParams, UpdateMediaParams, TrackEmailOpenParams, GetDeliveryStatsParams, CreatePromoCodeParams, UpdatePromoCodeParams, DeletePromoCodeParams, GetPromoCodeParams, GetPromoCodesParams, CreateNodeParams, UpdateNodeParams, DeleteNodeParams, GetNodeParams, GetNodesParams, GetNodeChildrenParams, GenerateBlocksParams, GetVariableMetadataParams, CreateProductParams, UpdateProductParams, DeleteProductParams, GetProductParams, GetProductsParams, CreateOrderParams, UpdateOrderParams, GetOrderParams, GetOrdersParams, GetQuoteParams, OrderCheckoutParams, Slot, CreateReservationParams, UpdateReservationParams, ReservationCheckoutParams, GetReservationParams, SearchReservationsParams, GetReservationQuoteParams, CreateServiceParams, UpdateServiceParams, DeleteServiceParams, BulkScheduleParams, GetServiceParams, GetServicesParams, CreateProviderParams, UpdateProviderParams, DeleteProviderParams, GetProviderParams, GetProvidersParams, GetBusinessServiceWorkingTimeParams, CreateWorkflowParams, UpdateWorkflowParams, DeleteWorkflowParams, GetWorkflowParams, GetWorkflowsParams, TriggerWorkflowParams, CreateAudienceParams, UpdateAudienceParams, GetAudienceParams, GetAudiencesParams, SubscribeAudienceParams, GetAudienceSubscribersParams, RevokeAudienceSubscriptionParams, GetShippingRatesParams, ShippingRate, PurchaseLabelParams, PurchaseLabelResult } from './types.js';
2
- export { Access, Address, AnalyticsConfig, ApiResponse, Audience, AudienceAccessResponse, AudienceSubscribeResponse, AudienceSubscriber, Block, Business, BusinessConfig, BusinessEvent, BusinessEventAction, BusinessShippingProvider, DayAvailability, EshopCartItem, EshopStoreState, GeoLocation, GeoLocationBlock, GetAvailabilityParams, GetSlotsForDateParams, Language, Location, Market, Media, MediaResolution, Node, OrderShipping, PaginatedResponse, Parcel, Payment, PaymentMethod, PaymentMethodType, PaymentProviderConfig, PaymentRefund, Price, PromoCodeValidation, ProviderWithTimeline, Quote, ReservationCartItem, ReservationStoreState, ShippingAddress, ShippingMethod, ShippingProviderShippo, ShippingProviderStatus, ShippingStatus, ShippingWeightTier, SystemTemplateKey, Workflow, WorkflowEdge, WorkflowHttpMethod, WorkflowHttpNode, WorkflowIfNode, WorkflowLoopNode, WorkflowNode, WorkflowTriggerNode, WorkflowWaitNode, Zone, ZoneLocation } from './types.js';
1
+ import { RequestOptions, MagicLinkVerifyParams, MagicLinkRequestParams, UpdateAccountProfileParams, DeleteAccountParams, AddPhoneNumberParams, PhoneNumberConfirmParams, GetMeParams, SearchAccountsParams, AccountSubscribeParams, CreateBusinessParams, UpdateBusinessParams, DeleteBusinessParams, GetBusinessParams, GetBusinessesParams, GetBusinessParentsParams, TriggerBuildsParams, GetSubscriptionPlansParams, GetSubscriptionParams, SubscribeParams, CreatePortalSessionParams, InviteUserParams, HandleInvitationParams, TestWebhookParams, GetBusinessMediaParams2, ProcessRefundParams, GetBusinessEventsParams, UpdateBusinessEventParams, ConnectStripeParams, DisconnectStripeParams, UploadBusinessMediaParams, DeleteBusinessMediaParams, GetBusinessMediaParams, UpdateMediaParams, TrackEmailOpenParams, GetDeliveryStatsParams, CreatePromoCodeParams, UpdatePromoCodeParams, DeletePromoCodeParams, GetPromoCodeParams, GetPromoCodesParams, CreateNodeParams, UpdateNodeParams, DeleteNodeParams, GetNodeParams, GetNodesParams, GetNodeChildrenParams, GenerateBlocksParams, GetVariableMetadataParams, CreateProductParams, UpdateProductParams, DeleteProductParams, GetProductParams, GetProductsParams, CreateOrderParams, UpdateOrderParams, GetOrderParams, GetOrdersParams, GetQuoteParams, OrderCheckoutParams, Slot, CreateReservationParams, UpdateReservationParams, ReservationCheckoutParams, GetReservationParams, SearchReservationsParams, GetReservationQuoteParams, CreateServiceParams, UpdateServiceParams, DeleteServiceParams, BulkScheduleParams, GetServiceParams, GetServicesParams, CreateProviderParams, UpdateProviderParams, DeleteProviderParams, GetProviderParams, GetProvidersParams, GetBusinessServiceWorkingTimeParams, CreateWorkflowParams, UpdateWorkflowParams, DeleteWorkflowParams, GetWorkflowParams, GetWorkflowsParams, TriggerWorkflowParams, CreateAudienceParams, UpdateAudienceParams, GetAudienceParams, GetAudiencesParams, SubscribeAudienceParams, GetAudienceSubscribersParams, RevokeAudienceSubscriptionParams, GetShippingRatesParams, ShippingRate, ShipParams, ShipResult } from './types.js';
2
+ export { Access, Address, AnalyticsConfig, ApiResponse, Audience, AudienceAccessResponse, AudienceSubscribeResponse, AudienceSubscriber, Block, Business, BusinessConfig, BusinessEvent, BusinessEventAction, BusinessShippingProvider, CustomsDeclaration, CustomsItem, DayAvailability, EshopCartItem, EshopStoreState, GeoLocation, GeoLocationBlock, GetAvailabilityParams, GetSlotsForDateParams, Language, Location, Market, Media, MediaResolution, Node, OrderShipping, PaginatedResponse, Parcel, Payment, PaymentMethod, PaymentMethodType, PaymentProviderConfig, PaymentRefund, Price, PromoCodeValidation, ProviderWithTimeline, PurchaseLabelResult, Quote, ReservationCartItem, ReservationStoreState, Shipment, ShipmentLine, ShippingAddress, ShippingMethod, ShippingProviderShippo, ShippingProviderStatus, ShippingStatus, ShippingWeightTier, SystemTemplateKey, Workflow, WorkflowEdge, WorkflowHttpMethod, WorkflowHttpNode, WorkflowIfNode, WorkflowLoopNode, WorkflowNode, WorkflowTriggerNode, WorkflowWaitNode, Zone, ZoneLocation } from './types.js';
3
3
  import { f as formatPayment, a as formatMinor, g as getCurrencySymbol, b as getCurrencyName, i as isValidKey, v as validateKey, t as toKey, n as nameToKey, c as getAvailableStock, d as getReservedStock, h as hasStock, e as getInventoryAt, j as getFirstAvailableFCId } from './index-GZfY5CmP.js';
4
4
 
5
5
  interface AuthTokens {
@@ -291,7 +291,7 @@ declare function createArkySDK(config: HttpClientConfig & {
291
291
  getRates(params: GetShippingRatesParams, options?: RequestOptions): Promise<{
292
292
  rates: ShippingRate[];
293
293
  }>;
294
- purchaseLabel(params: PurchaseLabelParams, options?: RequestOptions): Promise<PurchaseLabelResult>;
294
+ ship(params: ShipParams, options?: RequestOptions): Promise<ShipResult>;
295
295
  };
296
296
  analytics: {
297
297
  track: typeof track;
@@ -355,4 +355,4 @@ declare function createArkySDK(config: HttpClientConfig & {
355
355
  getStripeConnectClientId: () => string;
356
356
  }>;
357
357
 
358
- export { type ApiConfig, type GetCountriesResponse, GetShippingRatesParams, type HttpClientConfig, type LocationCountry, type LocationState, PurchaseLabelParams, PurchaseLabelResult, SDK_VERSION, SUPPORTED_FRAMEWORKS, ShippingRate, Slot, createArkySDK };
358
+ export { type ApiConfig, type GetCountriesResponse, GetShippingRatesParams, type HttpClientConfig, type LocationCountry, type LocationState, SDK_VERSION, SUPPORTED_FRAMEWORKS, ShipParams, ShipResult, ShippingRate, Slot, createArkySDK };
package/dist/index.js CHANGED
@@ -497,11 +497,11 @@ var createMediaApi = (apiConfig) => {
497
497
  return await response.json();
498
498
  },
499
499
  async updateMedia(params, options) {
500
- const { mediaId, businessId, ...updateData } = params;
500
+ const { mediaId, businessId, ...payload } = params;
501
501
  const targetBusinessId = businessId || apiConfig.businessId;
502
502
  return apiConfig.httpClient.put(
503
503
  `/v1/businesses/${targetBusinessId}/media/${mediaId}`,
504
- updateData,
504
+ payload,
505
505
  options
506
506
  );
507
507
  }
@@ -907,15 +907,11 @@ var createReservationApi = (apiConfig) => {
907
907
  cart = [];
908
908
  },
909
909
  async createReservation(params, options) {
910
- const { businessId, ...rest } = params;
910
+ const { businessId, ...payload } = params;
911
911
  const targetBusinessId = businessId || apiConfig.businessId;
912
- const payload = {
913
- market: apiConfig.market,
914
- ...rest
915
- };
916
912
  return apiConfig.httpClient.post(
917
913
  `/v1/businesses/${targetBusinessId}/reservations`,
918
- payload,
914
+ { market: apiConfig.market, ...payload },
919
915
  options
920
916
  );
921
917
  },
@@ -928,22 +924,17 @@ var createReservationApi = (apiConfig) => {
928
924
  );
929
925
  },
930
926
  async checkout(params, options) {
931
- const { businessId, ...rest } = params || {};
927
+ const { businessId, items: paramItems, ...payload } = params || {};
932
928
  const targetBusinessId = businessId || apiConfig.businessId;
933
- const items = rest?.items || cart.map((s) => ({
929
+ const items = paramItems || cart.map((s) => ({
934
930
  serviceId: s.serviceId,
935
931
  providerId: s.providerId,
936
932
  from: s.from,
937
933
  to: s.to
938
934
  }));
939
- const payload = {
940
- market: apiConfig.market,
941
- ...rest,
942
- items
943
- };
944
935
  return apiConfig.httpClient.post(
945
936
  `/v1/businesses/${targetBusinessId}/reservations/checkout`,
946
- payload,
937
+ { market: apiConfig.market, ...payload, items },
947
938
  options
948
939
  );
949
940
  },
@@ -966,15 +957,11 @@ var createReservationApi = (apiConfig) => {
966
957
  );
967
958
  },
968
959
  async getQuote(params, options) {
969
- const { businessId, ...rest } = params;
960
+ const { businessId, ...payload } = params;
970
961
  const targetBusinessId = businessId || apiConfig.businessId;
971
- const payload = {
972
- market: apiConfig.market,
973
- ...rest
974
- };
975
962
  return apiConfig.httpClient.post(
976
963
  `/v1/businesses/${targetBusinessId}/reservations/quote`,
977
- payload,
964
+ { market: apiConfig.market, ...payload },
978
965
  options
979
966
  );
980
967
  },
@@ -1276,8 +1263,8 @@ var createWorkflowApi = (apiConfig) => {
1276
1263
  });
1277
1264
  },
1278
1265
  async triggerWorkflow(params, options) {
1279
- const { secret, ...input } = params;
1280
- return apiConfig.httpClient.post(`/v1/workflows/trigger/${secret}`, input, options);
1266
+ const { secret, ...payload } = params;
1267
+ return apiConfig.httpClient.post(`/v1/workflows/trigger/${secret}`, payload, options);
1281
1268
  }
1282
1269
  };
1283
1270
  };
@@ -1381,29 +1368,21 @@ var createShippingApi = (apiConfig) => {
1381
1368
  * Get available shipping rates for a shipment
1382
1369
  */
1383
1370
  async getRates(params, options) {
1371
+ const { orderId, ...payload } = params;
1384
1372
  return apiConfig.httpClient.post(
1385
- `/v1/businesses/${apiConfig.businessId}/orders/${params.orderId}/shipping/rates`,
1386
- {
1387
- shippingProviderId: params.shippingProviderId,
1388
- fromAddress: params.fromAddress,
1389
- toAddress: params.toAddress,
1390
- parcel: params.parcel
1391
- },
1373
+ `/v1/businesses/${apiConfig.businessId}/orders/${orderId}/shipping/rates`,
1374
+ payload,
1392
1375
  options
1393
1376
  );
1394
1377
  },
1395
1378
  /**
1396
- * Purchase a shipping label for a shipment
1379
+ * Ship items: creates shipment + purchases label atomically
1397
1380
  */
1398
- async purchaseLabel(params, options) {
1381
+ async ship(params, options) {
1382
+ const { orderId, ...payload } = params;
1399
1383
  return apiConfig.httpClient.post(
1400
- `/v1/businesses/${apiConfig.businessId}/orders/${params.orderId}/shipping/purchase`,
1401
- {
1402
- shipmentId: params.shipmentId,
1403
- rateId: params.rateId,
1404
- carrier: params.carrier,
1405
- service: params.service
1406
- },
1384
+ `/v1/businesses/${apiConfig.businessId}/orders/${orderId}/ship`,
1385
+ payload,
1407
1386
  options
1408
1387
  );
1409
1388
  }