@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2/ShipnoticeItems.ts

@@ -0,0 +1,152 @@
+/* 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,
+  APIV2EntitiesMetaFields,
+  APIV2EntitiesShipnoticeItem,
+  GetApiV2ShipnoticeItemsCountParams,
+  GetApiV2ShipnoticeItemsIdMetaFieldsPayload,
+  PutApiV2ShipnoticeItemsIdPayload,
+} from "./data-contracts";
+
+/**
+ * @description Get resource actions
+ *
+ * @tags shipnotice_items
+ * @name GetApiV2ShipnoticeItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2/shipnotice_items/actions
+ */
+export const getApiV2ShipnoticeItemsActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name DeleteApiV2ShipnoticeItemsId
+ * @summary Destroy a shipnotice item
+ * @request DELETE:/api/v2/shipnotice_items/{id}
+ */
+export const deleteApiV2ShipnoticeItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesShipnoticeItem, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name PutApiV2ShipnoticeItemsId
+ * @summary Update a ship notice item
+ * @request PUT:/api/v2/shipnotice_items/{id}
+ */
+export const putApiV2ShipnoticeItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2ShipnoticeItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnoticeItem, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name GetApiV2ShipnoticeItemsId
+ * @summary Retrieve a ship notice item
+ * @request GET:/api/v2/shipnotice_items/{id}
+ */
+export const getApiV2ShipnoticeItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesShipnoticeItem, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags shipnotice_items
+ * @name PutApiV2ShipnoticeItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2/shipnotice_items/{id}/meta_fields
+ */
+export const putApiV2ShipnoticeItemsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shipnotice_items
+ * @name GetApiV2ShipnoticeItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2/shipnotice_items/{id}/meta_fields
+ */
+export const getApiV2ShipnoticeItemsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV2ShipnoticeItemsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesMetaFields, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name GetApiV2ShipnoticeItemsCount
+ * @summary Count ship notice items
+ * @request GET:/api/v2/shipnotice_items/count
+ */
+export const getApiV2ShipnoticeItemsCount = (
+  client: HttpClient,
+  query: GetApiV2ShipnoticeItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotice_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Shipnotices.ts

@@ -0,0 +1,367 @@
+/* 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,
+  APIV2EntitiesMetaFields,
+  APIV2EntitiesResult,
+  APIV2EntitiesShipnotice,
+  APIV2EntitiesShipnoticeItem,
+  GetApiV2ShipnoticesCountParams,
+  GetApiV2ShipnoticesIdMetaFieldsPayload,
+  GetApiV2ShipnoticesIdShipnoticeItemsCountParams,
+  GetApiV2ShipnoticesIdShipnoticeItemsParams,
+  GetApiV2ShipnoticesParams,
+  PostApiV2ShipnoticesBulkPayload,
+  PostApiV2ShipnoticesIdShipnoticeItemsPayload,
+  PostApiV2ShipnoticesPayload,
+  PutApiV2ShipnoticesIdPayload,
+  PutApiV2ShipnoticesOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name PostApiV2Shipnotices
+ * @summary Create a ship notice
+ * @request POST:/api/v2/shipnotices
+ */
+export const postApiV2Shipnotices = (
+  client: HttpClient,
+  data: PostApiV2ShipnoticesPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV2Shipnotices
+ * @summary List all ship notices
+ * @request GET:/api/v2/shipnotices
+ */
+export const getApiV2Shipnotices = (
+  client: HttpClient,
+  query: GetApiV2ShipnoticesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnotice[], APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
+ *
+ * @tags shipnotices
+ * @name PostApiV2ShipnoticesBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2/shipnotices/bulk
+ */
+export const postApiV2ShipnoticesBulk = (
+  client: HttpClient,
+  data: PostApiV2ShipnoticesBulkPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesResult, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/bulk`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2/shipnotices/actions
+ */
+export const getApiV2ShipnoticesActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name DeleteApiV2ShipnoticesOriginatorOriginatorId
+ * @summary Destroy a ship notice
+ * @request DELETE:/api/v2/shipnotices/originator/{originator_id}
+ */
+export const deleteApiV2ShipnoticesOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnotice, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/originator/${originatorId}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
+ *
+ * @tags originators
+ * @name PutApiV2ShipnoticesOriginatorOriginatorId
+ * @summary Update a ship notice
+ * @request PUT:/api/v2/shipnotices/originator/{originator_id}
+ */
+export const putApiV2ShipnoticesOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV2ShipnoticesOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2ShipnoticesOriginatorOriginatorId
+ * @summary Retrieve a ship notice
+ * @request GET:/api/v2/shipnotices/originator/{originator_id}
+ */
+export const getApiV2ShipnoticesOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnotice, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesIdOrdersWaiting
+ * @summary Count orders waiting for stock in a ship notice
+ * @request GET:/api/v2/shipnotices/{id}/orders_waiting
+ */
+export const getApiV2ShipnoticesIdOrdersWaiting = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}/orders_waiting`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name DeleteApiV2ShipnoticesId
+ * @summary Destroy a ship notice
+ * @request DELETE:/api/v2/shipnotices/{id}
+ */
+export const deleteApiV2ShipnoticesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesShipnotice, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
+ *
+ * @tags shipnotices
+ * @name PutApiV2ShipnoticesId
+ * @summary Update a ship notice
+ * @request PUT:/api/v2/shipnotices/{id}
+ */
+export const putApiV2ShipnoticesId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2ShipnoticesIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesId
+ * @summary Retrieve a ship notice
+ * @request GET:/api/v2/shipnotices/{id}
+ */
+export const getApiV2ShipnoticesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesShipnotice, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name PostApiV2ShipnoticesIdShipnoticeItems
+ * @summary Create a ship notice item
+ * @request POST:/api/v2/shipnotices/{id}/shipnotice_items
+ */
+export const postApiV2ShipnoticesIdShipnoticeItems = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV2ShipnoticesIdShipnoticeItemsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnoticeItem, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}/shipnotice_items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesIdShipnoticeItems
+ * @summary List associated ship notice items
+ * @request GET:/api/v2/shipnotices/{id}/shipnotice_items
+ */
+export const getApiV2ShipnoticesIdShipnoticeItems = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ShipnoticesIdShipnoticeItemsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnoticeItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}/shipnotice_items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags shipnotices
+ * @name PutApiV2ShipnoticesIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2/shipnotices/{id}/meta_fields
+ */
+export const putApiV2ShipnoticesIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2/shipnotices/{id}/meta_fields
+ */
+export const getApiV2ShipnoticesIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV2ShipnoticesIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesMetaFields, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesIdShipnoticeItemsCount
+ * @summary Count associated ship notice items
+ * @request GET:/api/v2/shipnotices/{id}/shipnotice_items/count
+ */
+export const getApiV2ShipnoticesIdShipnoticeItemsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2ShipnoticesIdShipnoticeItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/${id}/shipnotice_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV2ShipnoticesCount
+ * @summary Count ship notices
+ * @request GET:/api/v2/shipnotices/count
+ */
+export const getApiV2ShipnoticesCount = (
+  client: HttpClient,
+  query: GetApiV2ShipnoticesCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/shipnotices/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Simulate.ts

@@ -0,0 +1,160 @@
+/* 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,
+  APIV2EntitiesConsumerReturn,
+  APIV2EntitiesOrder,
+  APIV2EntitiesShipnotice,
+  PostApiV2SimulateConsumerReturnsCreatePayload,
+  PostApiV2SimulateOrdersCreatePayload,
+  PostApiV2SimulateShipnoticesCreatePayload,
+  PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingPayload,
+  PutApiV2SimulateOrdersOrderIdProcessingPayload,
+  PutApiV2SimulateShipnoticesShipnoticeIdProcessingPayload,
+} from "./data-contracts";
+
+/**
+ * @description Customer users don't have access to staff actions, so this simulates a consumer return's workflow, allowing you to process a consumer return and, optionally, finalize it.
+ *
+ * @tags simulate
+ * @name PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing
+ * @summary Simulate processing for an consumer return
+ * @request PUT:/api/v2/simulate/consumer_returns/{consumer_return_id}/processing
+ */
+export const putApiV2SimulateConsumerReturnsConsumerReturnIdProcessing = (
+  client: HttpClient,
+  consumerReturnId: number,
+  data: PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesConsumerReturn, APIV2EntitiesApiError>({
+    path: `/api/v2/simulate/consumer_returns/${consumerReturnId}/processing`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV2SimulateConsumerReturnsCreate
+ * @summary Create a consumer return with simulated data
+ * @request POST:/api/v2/simulate/consumer_returns/create
+ */
+export const postApiV2SimulateConsumerReturnsCreate = (
+  client: HttpClient,
+  data: PostApiV2SimulateConsumerReturnsCreatePayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesConsumerReturn, APIV2EntitiesApiError>({
+    path: `/api/v2/simulate/consumer_returns/create`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Customer users don't have access to staff actions, so this simulates a ship notice's workflow, allowing you to process a ship notice and, optionally, finalize it.
+ *
+ * @tags simulate
+ * @name PutApiV2SimulateShipnoticesShipnoticeIdProcessing
+ * @summary Simulate processing for an ship notice
+ * @request PUT:/api/v2/simulate/shipnotices/{shipnotice_id}/processing
+ */
+export const putApiV2SimulateShipnoticesShipnoticeIdProcessing = (
+  client: HttpClient,
+  shipnoticeId: number,
+  data: PutApiV2SimulateShipnoticesShipnoticeIdProcessingPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnotice, APIV2EntitiesApiError>({
+    path: `/api/v2/simulate/shipnotices/${shipnoticeId}/processing`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV2SimulateShipnoticesCreate
+ * @summary Create a shipnotice with simulated data
+ * @request POST:/api/v2/simulate/shipnotices/create
+ */
+export const postApiV2SimulateShipnoticesCreate = (
+  client: HttpClient,
+  data: PostApiV2SimulateShipnoticesCreatePayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesShipnotice, APIV2EntitiesApiError>({
+    path: `/api/v2/simulate/shipnotices/create`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
+ *
+ * @tags simulate
+ * @name PutApiV2SimulateOrdersOrderIdProcessing
+ * @summary Simulate processing for an order
+ * @request PUT:/api/v2/simulate/orders/{order_id}/processing
+ */
+export const putApiV2SimulateOrdersOrderIdProcessing = (
+  client: HttpClient,
+  orderId: number,
+  data: PutApiV2SimulateOrdersOrderIdProcessingPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrder, APIV2EntitiesApiError>({
+    path: `/api/v2/simulate/orders/${orderId}/processing`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV2SimulateOrdersCreate
+ * @summary Create an order with simulated data
+ * @request POST:/api/v2/simulate/orders/create
+ */
+export const postApiV2SimulateOrdersCreate = (
+  client: HttpClient,
+  data: PostApiV2SimulateOrdersCreatePayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrder, APIV2EntitiesApiError>({
+    path: `/api/v2/simulate/orders/create`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};