@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2.1/Shipnotices.ts

@@ -0,0 +1,369 @@
+/* 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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesCount,
+  APIV21EntitiesMetaFields,
+  APIV21EntitiesPostResponse,
+  APIV21EntitiesResult,
+  APIV21EntitiesShipnotice,
+  APIV21EntitiesShipnoticeItem,
+  GetApiV21ShipnoticesCountParams,
+  GetApiV21ShipnoticesIdMetaFieldsPayload,
+  GetApiV21ShipnoticesIdShipnoticeItemsCountParams,
+  GetApiV21ShipnoticesIdShipnoticeItemsParams,
+  GetApiV21ShipnoticesParams,
+  PostApiV21ShipnoticesBulkPayload,
+  PostApiV21ShipnoticesIdShipnoticeItemsPayload,
+  PostApiV21ShipnoticesPayload,
+  PutApiV21ShipnoticesIdPayload,
+  PutApiV21ShipnoticesOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name PostApiV21Shipnotices
+ * @summary Create a ship notice
+ * @request POST:/api/v2.1/shipnotices
+ */
+export const postApiV21Shipnotices = (
+  client: HttpClient,
+  data: PostApiV21ShipnoticesPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21Shipnotices
+ * @summary List all ship notices
+ * @request GET:/api/v2.1/shipnotices
+ */
+export const getApiV21Shipnotices = (
+  client: HttpClient,
+  query: GetApiV21ShipnoticesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnotice[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/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 PostApiV21ShipnoticesBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2.1/shipnotices/bulk
+ */
+export const postApiV21ShipnoticesBulk = (
+  client: HttpClient,
+  data: PostApiV21ShipnoticesBulkPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesResult, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/bulk`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/shipnotices/actions
+ */
+export const getApiV21ShipnoticesActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name DeleteApiV21ShipnoticesOriginatorOriginatorId
+ * @summary Destroy a ship notice
+ * @request DELETE:/api/v2.1/shipnotices/originator/{originator_id}
+ */
+export const deleteApiV21ShipnoticesOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnotice, APIV21EntitiesApiError>({
+    path: `/api/v2.1/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 PutApiV21ShipnoticesOriginatorOriginatorId
+ * @summary Update a ship notice
+ * @request PUT:/api/v2.1/shipnotices/originator/{originator_id}
+ */
+export const putApiV21ShipnoticesOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV21ShipnoticesOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21ShipnoticesOriginatorOriginatorId
+ * @summary Retrieve a ship notice
+ * @request GET:/api/v2.1/shipnotices/originator/{originator_id}
+ */
+export const getApiV21ShipnoticesOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnotice, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdOrdersWaiting
+ * @summary Count orders waiting for stock in a ship notice
+ * @request GET:/api/v2.1/shipnotices/{id}/orders_waiting
+ */
+export const getApiV21ShipnoticesIdOrdersWaiting = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}/orders_waiting`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name DeleteApiV21ShipnoticesId
+ * @summary Destroy a ship notice
+ * @request DELETE:/api/v2.1/shipnotices/{id}
+ */
+export const deleteApiV21ShipnoticesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesShipnotice, APIV21EntitiesApiError>({
+    path: `/api/v2.1/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 PutApiV21ShipnoticesId
+ * @summary Update a ship notice
+ * @request PUT:/api/v2.1/shipnotices/{id}
+ */
+export const putApiV21ShipnoticesId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21ShipnoticesIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesId
+ * @summary Retrieve a ship notice
+ * @request GET:/api/v2.1/shipnotices/{id}
+ */
+export const getApiV21ShipnoticesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesShipnotice, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name PostApiV21ShipnoticesIdShipnoticeItems
+ * @summary Create a ship notice item
+ * @request POST:/api/v2.1/shipnotices/{id}/shipnotice_items
+ */
+export const postApiV21ShipnoticesIdShipnoticeItems = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV21ShipnoticesIdShipnoticeItemsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnoticeItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}/shipnotice_items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdShipnoticeItems
+ * @summary List associated ship notice items
+ * @request GET:/api/v2.1/shipnotices/{id}/shipnotice_items
+ */
+export const getApiV21ShipnoticesIdShipnoticeItems = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnoticeItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}/shipnotice_items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags shipnotices
+ * @name PutApiV21ShipnoticesIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/shipnotices/{id}/meta_fields
+ */
+export const putApiV21ShipnoticesIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/shipnotices/{id}/meta_fields
+ */
+export const getApiV21ShipnoticesIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV21ShipnoticesIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesMetaFields, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesIdShipnoticeItemsCount
+ * @summary Count associated ship notice items
+ * @request GET:/api/v2.1/shipnotices/{id}/shipnotice_items/count
+ */
+export const getApiV21ShipnoticesIdShipnoticeItemsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/${id}/shipnotice_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotices
+ * @name GetApiV21ShipnoticesCount
+ * @summary Count ship notices
+ * @request GET:/api/v2.1/shipnotices/count
+ */
+export const getApiV21ShipnoticesCount = (
+  client: HttpClient,
+  query: GetApiV21ShipnoticesCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotices/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesConsumerReturn,
+  APIV21EntitiesOrder,
+  APIV21EntitiesShipnotice,
+  PostApiV21SimulateConsumerReturnsCreatePayload,
+  PostApiV21SimulateOrdersCreatePayload,
+  PostApiV21SimulateShipnoticesCreatePayload,
+  PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessingPayload,
+  PutApiV21SimulateOrdersOrderIdProcessingPayload,
+  PutApiV21SimulateShipnoticesShipnoticeIdProcessingPayload,
+} 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 PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing
+ * @summary Simulate processing for an consumer return
+ * @request PUT:/api/v2.1/simulate/consumer_returns/{consumer_return_id}/processing
+ */
+export const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing = (
+  client: HttpClient,
+  consumerReturnId: number,
+  data: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessingPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesConsumerReturn, APIV21EntitiesApiError>({
+    path: `/api/v2.1/simulate/consumer_returns/${consumerReturnId}/processing`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV21SimulateConsumerReturnsCreate
+ * @summary Create a consumer return with simulated data
+ * @request POST:/api/v2.1/simulate/consumer_returns/create
+ */
+export const postApiV21SimulateConsumerReturnsCreate = (
+  client: HttpClient,
+  data: PostApiV21SimulateConsumerReturnsCreatePayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesConsumerReturn, APIV21EntitiesApiError>({
+    path: `/api/v2.1/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 PutApiV21SimulateShipnoticesShipnoticeIdProcessing
+ * @summary Simulate processing for an ship notice
+ * @request PUT:/api/v2.1/simulate/shipnotices/{shipnotice_id}/processing
+ */
+export const putApiV21SimulateShipnoticesShipnoticeIdProcessing = (
+  client: HttpClient,
+  shipnoticeId: number,
+  data: PutApiV21SimulateShipnoticesShipnoticeIdProcessingPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnotice, APIV21EntitiesApiError>({
+    path: `/api/v2.1/simulate/shipnotices/${shipnoticeId}/processing`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV21SimulateShipnoticesCreate
+ * @summary Create a shipnotice with simulated data
+ * @request POST:/api/v2.1/simulate/shipnotices/create
+ */
+export const postApiV21SimulateShipnoticesCreate = (
+  client: HttpClient,
+  data: PostApiV21SimulateShipnoticesCreatePayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnotice, APIV21EntitiesApiError>({
+    path: `/api/v2.1/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 PutApiV21SimulateOrdersOrderIdProcessing
+ * @summary Simulate processing for an order
+ * @request PUT:/api/v2.1/simulate/orders/{order_id}/processing
+ */
+export const putApiV21SimulateOrdersOrderIdProcessing = (
+  client: HttpClient,
+  orderId: number,
+  data: PutApiV21SimulateOrdersOrderIdProcessingPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrder, APIV21EntitiesApiError>({
+    path: `/api/v2.1/simulate/orders/${orderId}/processing`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags simulate
+ * @name PostApiV21SimulateOrdersCreate
+ * @summary Create an order with simulated data
+ * @request POST:/api/v2.1/simulate/orders/create
+ */
+export const postApiV21SimulateOrdersCreate = (
+  client: HttpClient,
+  data: PostApiV21SimulateOrdersCreatePayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrder, APIV21EntitiesApiError>({
+    path: `/api/v2.1/simulate/orders/create`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/Templates.ts

@@ -0,0 +1,114 @@
+/* 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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesTemplate,
+  GetApiV21TemplatesParams,
+  PostApiV21TemplatesPayload,
+  PutApiV21TemplatesIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PostApiV21Templates
+ * @summary Create a template
+ * @request POST:/api/v2.1/templates
+ */
+export const postApiV21Templates = (
+  client: HttpClient,
+  data: PostApiV21TemplatesPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesTemplate, APIV21EntitiesApiError>({
+    path: `/api/v2.1/templates`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV21Templates
+ * @summary List all templates
+ * @request GET:/api/v2.1/templates
+ */
+export const getApiV21Templates = (client: HttpClient, query: GetApiV21TemplatesParams, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesTemplate[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/templates`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags templates
+ * @name DeleteApiV21TemplatesId
+ * @summary Destroy a template
+ * @request DELETE:/api/v2.1/templates/{id}
+ */
+export const deleteApiV21TemplatesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesTemplate, APIV21EntitiesApiError>({
+    path: `/api/v2.1/templates/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PutApiV21TemplatesId
+ * @summary Update a template
+ * @request PUT:/api/v2.1/templates/{id}
+ */
+export const putApiV21TemplatesId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21TemplatesIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesTemplate, APIV21EntitiesApiError>({
+    path: `/api/v2.1/templates/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV21TemplatesId
+ * @summary Retrieve a template
+ * @request GET:/api/v2.1/templates/{id}
+ */
+export const getApiV21TemplatesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesTemplate, APIV21EntitiesApiError>({
+    path: `/api/v2.1/templates/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};