@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2/Items.ts

@@ -0,0 +1,556 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { ContentType, HttpClient, RequestParams } from "./../http-client";
+import {
+  APIV2EntitiesApiError,
+  APIV2EntitiesBundleItem,
+  APIV2EntitiesCount,
+  APIV2EntitiesItem,
+  APIV2EntitiesItemWarehouseQuantity,
+  APIV2EntitiesMetaFields,
+  APIV2EntitiesOriginator,
+  APIV2EntitiesScancodeAlias,
+  APIV2EntitiesShipnoticeItem,
+  APIV2EntitiesTransaction,
+  GetApiV2ItemsCountParams,
+  GetApiV2ItemsIdMetaFieldsPayload,
+  GetApiV2ItemsIdOriginatorsParams,
+  GetApiV2ItemsIdScancodeAliasesParams,
+  GetApiV2ItemsIdShipnoticeItemsCountParams,
+  GetApiV2ItemsIdShipnoticeItemsParams,
+  GetApiV2ItemsIdTransactionsCountParams,
+  GetApiV2ItemsIdTransactionsParams,
+  GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  GetApiV2ItemsParams,
+  PostApiV2ItemsIdBundleItemsPayload,
+  PostApiV2ItemsPayload,
+  PutApiV2ItemsIdPayload,
+  PutApiV2ItemsOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags items
+ * @name PostApiV2Items
+ * @summary Create an item
+ * @request POST:/api/v2/items
+ */
+export const postApiV2Items = (client: HttpClient, data: PostApiV2ItemsPayload, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2Items
+ * @summary List all items
+ * @request GET:/api/v2/items
+ */
+export const getApiV2Items = (client: HttpClient, query: GetApiV2ItemsParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags items
+ * @name GetApiV2ItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2/items/actions
+ */
+export const getApiV2ItemsActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * @description An item may have many alternate scancodes
+ *
+ * @tags originators
+ * @name GetApiV2ItemsOriginatorOriginatorIdScancodeAliases
+ * @summary List all scancodes associated with this item
+ * @request GET:/api/v2/items/originator/{originator_id}/scancode_aliases
+ */
+export const getApiV2ItemsOriginatorOriginatorIdScancodeAliases = (
+  client: HttpClient,
+  { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesScancodeAlias[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}/scancode_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
+ *
+ * @tags originators
+ * @name GetApiV2ItemsOriginatorOriginatorIdWarehouseQuantities
+ * @summary Item stock by warehouse
+ * @request GET:/api/v2/items/originator/{originator_id}/warehouse_quantities
+ */
+export const getApiV2ItemsOriginatorOriginatorIdWarehouseQuantities = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}/warehouse_quantities`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2ItemsOriginatorOriginatorIdBundleItems
+ * @summary List all bundle items containing this item
+ * @request GET:/api/v2/items/originator/{originator_id}/bundle_items
+ */
+export const getApiV2ItemsOriginatorOriginatorIdBundleItems = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesBundleItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}/bundle_items`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2ItemsOriginatorOriginatorIdInBundles
+ * @summary List all instances of this item in bundles
+ * @request GET:/api/v2/items/originator/{originator_id}/in_bundles
+ */
+export const getApiV2ItemsOriginatorOriginatorIdInBundles = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}/in_bundles`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
+ *
+ * @tags originators
+ * @name DeleteApiV2ItemsOriginatorOriginatorId
+ * @summary Archive an item
+ * @request DELETE:/api/v2/items/originator/{originator_id}
+ */
+export const deleteApiV2ItemsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV2ItemsOriginatorOriginatorId
+ * @summary Update an item
+ * @request PUT:/api/v2/items/originator/{originator_id}
+ */
+export const putApiV2ItemsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV2ItemsOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2ItemsOriginatorOriginatorId
+ * @summary Retrieve an item
+ * @request GET:/api/v2/items/originator/{originator_id}
+ */
+export const getApiV2ItemsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesItem, APIV2EntitiesApiError>({
+    path: `/api/v2/items/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags items
+ * @name PutApiV2ItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2/items/{id}/meta_fields
+ */
+export const putApiV2ItemsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2/items/{id}/meta_fields
+ */
+export const getApiV2ItemsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV2ItemsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesMetaFields, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description An item may have many alternate scancodes
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdScancodeAliases
+ * @summary List all scancodes associated with this item
+ * @request GET:/api/v2/items/{id}/scancode_aliases
+ */
+export const getApiV2ItemsIdScancodeAliases = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ItemsIdScancodeAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesScancodeAlias[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/scancode_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdWarehouseQuantities
+ * @summary Item stock by warehouse
+ * @request GET:/api/v2/items/{id}/warehouse_quantities
+ */
+export const getApiV2ItemsIdWarehouseQuantities = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/warehouse_quantities`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdBundleItems
+ * @summary List all bundle items containing this item
+ * @request GET:/api/v2/items/{id}/bundle_items
+ */
+export const getApiV2ItemsIdBundleItems = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesBundleItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/bundle_items`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description A Bundle is an Item representing a set of Items to be grouped and shipped together. Creating Product Bundles is useful when you sell a set of items, but you also sell the items individually. Creating a bundle allows us to keep the inventory flexible so we can ship the constituent items as they are sold individually, or as a set. In most cases, it's simplest to use Whiplash bundles as a replacement for your e-commerce platform's bundle feature / plugin.
+ *
+ * @tags items
+ * @name PostApiV2ItemsIdBundleItems
+ * @summary Add an item to an bundle
+ * @request POST:/api/v2/items/{id}/bundle_items
+ */
+export const postApiV2ItemsIdBundleItems = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV2ItemsIdBundleItemsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/bundle_items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdInBundles
+ * @summary List all instances of this item in bundles
+ * @request GET:/api/v2/items/{id}/in_bundles
+ */
+export const getApiV2ItemsIdInBundles = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/in_bundles`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
+ *
+ * @tags items
+ * @name DeleteApiV2ItemsId
+ * @summary Archive an item
+ * @request DELETE:/api/v2/items/{id}
+ */
+export const deleteApiV2ItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name PutApiV2ItemsId
+ * @summary Update an item
+ * @request PUT:/api/v2/items/{id}
+ */
+export const putApiV2ItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2ItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2ItemsId
+ * @summary Retrieve an item
+ * @request GET:/api/v2/items/{id}
+ */
+export const getApiV2ItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesItem, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdOriginators
+ * @summary List associated originators
+ * @request GET:/api/v2/items/{id}/originators
+ */
+export const getApiV2ItemsIdOriginators = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ItemsIdOriginatorsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOriginator, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/originators`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2ItemsCount
+ * @summary Count items
+ * @request GET:/api/v2/items/count
+ */
+export const getApiV2ItemsCount = (client: HttpClient, query: GetApiV2ItemsCountParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Actions can be performed UPON an item. They don't necessarily update the item itself. You can see which actions are available to you at /items/actions
+ *
+ * @tags items
+ * @name PutApiV2ItemsIdCallAction
+ * @summary Perform an action on an item
+ * @request PUT:/api/v2/items/{id}/call/{action}
+ */
+export const putApiV2ItemsIdCallAction = (
+  client: HttpClient,
+  id: number,
+  action: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/call/${action}`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdShipnoticeItemsCount
+ * @summary Count associated ship notice items
+ * @request GET:/api/v2/items/{id}/shipnotice_items/count
+ */
+export const getApiV2ItemsIdShipnoticeItemsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ItemsIdShipnoticeItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/shipnotice_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdShipnoticeItems
+ * @summary List associated ship notice items
+ * @request GET:/api/v2/items/{id}/shipnotice_items
+ */
+export const getApiV2ItemsIdShipnoticeItems = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ItemsIdShipnoticeItemsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnoticeItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/shipnotice_items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Returns count of item transactions
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdTransactionsCount
+ * @summary Count the transactions in an item's history
+ * @request GET:/api/v2/items/{id}/transactions/count
+ */
+export const getApiV2ItemsIdTransactionsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ItemsIdTransactionsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/transactions/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get all transactions for an item
+ *
+ * @tags items
+ * @name GetApiV2ItemsIdTransactions
+ * @summary List an item's history
+ * @request GET:/api/v2/items/{id}/transactions
+ */
+export const getApiV2ItemsIdTransactions = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ItemsIdTransactionsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesTransaction[], APIV2EntitiesApiError>({
+    path: `/api/v2/items/${id}/transactions`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/MetaKeys.ts

@@ -0,0 +1,130 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { ContentType, HttpClient, RequestParams } from "./../http-client";
+import {
+  APIV2EntitiesApiError,
+  APIV2EntitiesCount,
+  APIV2EntitiesMetaKey,
+  GetApiV2MetaKeysCountParams,
+  GetApiV2MetaKeysParams,
+  PostApiV2MetaKeysPayload,
+  PutApiV2MetaKeysIdPayload,
+} from "./data-contracts";
+
+/**
+ * @description Create a meta_key
+ *
+ * @tags meta_keys
+ * @name PostApiV2MetaKeys
+ * @summary Create a meta_key
+ * @request POST:/api/v2/meta_keys
+ */
+export const postApiV2MetaKeys = (client: HttpClient, data: PostApiV2MetaKeysPayload, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/meta_keys`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * @description Get a list of meta_keys
+ *
+ * @tags meta_keys
+ * @name GetApiV2MetaKeys
+ * @summary List all meta keys
+ * @request GET:/api/v2/meta_keys
+ */
+export const getApiV2MetaKeys = (client: HttpClient, query: GetApiV2MetaKeysParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesMetaKey[], APIV2EntitiesApiError>({
+    path: `/api/v2/meta_keys`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Returns count of meta_keys
+ *
+ * @tags meta_keys
+ * @name GetApiV2MetaKeysCount
+ * @summary Count meta keys
+ * @request GET:/api/v2/meta_keys/count
+ */
+export const getApiV2MetaKeysCount = (
+  client: HttpClient,
+  query: GetApiV2MetaKeysCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/meta_keys/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Destroy a meta_key
+ *
+ * @tags meta_keys
+ * @name DeleteApiV2MetaKeysId
+ * @summary Delete a meta_key
+ * @request DELETE:/api/v2/meta_keys/{id}
+ */
+export const deleteApiV2MetaKeysId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/meta_keys/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * @description Update a meta_key
+ *
+ * @tags meta_keys
+ * @name PutApiV2MetaKeysId
+ * @summary Update a meta_key
+ * @request PUT:/api/v2/meta_keys/{id}
+ */
+export const putApiV2MetaKeysId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2MetaKeysIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/meta_keys/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * @description Get a meta_key
+ *
+ * @tags meta_keys
+ * @name GetApiV2MetaKeysId
+ * @summary Retrieve a meta key
+ * @request GET:/api/v2/meta_keys/{id}
+ */
+export const getApiV2MetaKeysId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesMetaKey, APIV2EntitiesApiError>({
+    path: `/api/v2/meta_keys/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};