@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2.1/Orders.ts

@@ -0,0 +1,439 @@
+/* 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,
+  APIV21EntitiesOrder,
+  APIV21EntitiesOrderDocument,
+  APIV21EntitiesOrderEvent,
+  APIV21EntitiesOrderItem,
+  APIV21EntitiesPostResponse,
+  APIV21EntitiesResult,
+  APIV21EntitiesSerialNumber,
+  GetApiV21OrdersCountParams,
+  GetApiV21OrdersIdEventsCountParams,
+  GetApiV21OrdersIdEventsParams,
+  GetApiV21OrdersIdMetaFieldsPayload,
+  GetApiV21OrdersIdOrderDocumentsParams,
+  GetApiV21OrdersIdOrderItemsCountParams,
+  GetApiV21OrdersIdOrderItemsParams,
+  GetApiV21OrdersParams,
+  PostApiV21OrdersBulkPayload,
+  PostApiV21OrdersIdOrderDocumentsPayload,
+  PostApiV21OrdersIdOrderItemsPayload,
+  PostApiV21OrdersPayload,
+  PutApiV21OrdersIdPayload,
+  PutApiV21OrdersOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags orders
+ * @name PostApiV21Orders
+ * @summary Create an order
+ * @request POST:/api/v2.1/orders
+ */
+export const postApiV21Orders = (client: HttpClient, data: PostApiV21OrdersPayload, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21Orders
+ * @summary List all orders
+ * @request GET:/api/v2.1/orders
+ */
+export const getApiV21Orders = (client: HttpClient, query: GetApiV21OrdersParams, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesOrder[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersCount
+ * @summary Count orders
+ * @request GET:/api/v2.1/orders/count
+ */
+export const getApiV21OrdersCount = (
+  client: HttpClient,
+  query: GetApiV21OrdersCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/count`,
+    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 orders
+ * @name PostApiV21OrdersBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2.1/orders/bulk
+ */
+export const postApiV21OrdersBulk = (
+  client: HttpClient,
+  data: PostApiV21OrdersBulkPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesResult, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/bulk`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags orders
+ * @name GetApiV21OrdersActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/orders/actions
+ */
+export const getApiV21OrdersActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV21OrdersOriginatorOriginatorId
+ * @summary Update an order
+ * @request PUT:/api/v2.1/orders/originator/{originator_id}
+ */
+export const putApiV21OrdersOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV21OrdersOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21OrdersOriginatorOriginatorId
+ * @summary Retrieve an order
+ * @request GET:/api/v2.1/orders/originator/{originator_id}
+ */
+export const getApiV21OrdersOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrder, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdEventsCount
+ * @summary Count order's events
+ * @request GET:/api/v2.1/orders/{id}/events/count
+ */
+export const getApiV21OrdersIdEventsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrdersIdEventsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/events/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdEvents
+ * @summary Retrieve the history for an order
+ * @request GET:/api/v2.1/orders/{id}/events
+ */
+export const getApiV21OrdersIdEvents = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrdersIdEventsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrderEvent[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/events`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name PutApiV21OrdersId
+ * @summary Update an order
+ * @request PUT:/api/v2.1/orders/{id}
+ */
+export const putApiV21OrdersId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21OrdersIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersId
+ * @summary Retrieve an order
+ * @request GET:/api/v2.1/orders/{id}
+ */
+export const getApiV21OrdersId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesOrder, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags orders
+ * @name PutApiV21OrdersIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/orders/{id}/meta_fields
+ */
+export const putApiV21OrdersIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/orders/{id}/meta_fields
+ */
+export const getApiV21OrdersIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV21OrdersIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesMetaFields, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description OrderDocuments are files attached to and order, like a pre-printed shipping label, BOL, etc.
+ *
+ * @tags orders
+ * @name PostApiV21OrdersIdOrderDocuments
+ * @summary Create an order document for an order
+ * @request POST:/api/v2.1/orders/{id}/order_documents
+ */
+export const postApiV21OrdersIdOrderDocuments = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV21OrdersIdOrderDocumentsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrderDocument, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/order_documents`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve all order documents for an order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderDocuments
+ * @summary List all order documents for an order
+ * @request GET:/api/v2.1/orders/{id}/order_documents
+ */
+export const getApiV21OrdersIdOrderDocuments = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrdersIdOrderDocumentsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrderDocument[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/order_documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Create an order item
+ *
+ * @tags orders
+ * @name PostApiV21OrdersIdOrderItems
+ * @summary Create an order item
+ * @request POST:/api/v2.1/orders/{id}/order_items
+ */
+export const postApiV21OrdersIdOrderItems = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV21OrdersIdOrderItemsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/order_items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve all order items for an order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderItems
+ * @summary List all order items for an order
+ * @request GET:/api/v2.1/orders/{id}/order_items
+ */
+export const getApiV21OrdersIdOrderItems = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrdersIdOrderItemsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrderItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/order_items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderItemsCount
+ * @summary Count order items
+ * @request GET:/api/v2.1/orders/{id}/order_items/count
+ */
+export const getApiV21OrdersIdOrderItemsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrdersIdOrderItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/order_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Actions can be performed UPON an order. They don't necessarily update the order itself. You can see which actions are available to you at /orders/actions
+ *
+ * @tags orders
+ * @name PutApiV21OrdersIdCallAction
+ * @summary Perform an action on an order
+ * @request PUT:/api/v2.1/orders/{id}/call/{action}
+ */
+export const putApiV21OrdersIdCallAction = (
+  client: HttpClient,
+  id: number,
+  action: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/call/${action}`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Serial numbers are scanned and saved during the packing process.
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdSerialNumbers
+ * @summary List all serial numbers associated with an order item
+ * @request GET:/api/v2.1/orders/{id}/serial_numbers
+ */
+export const getApiV21OrdersIdSerialNumbers = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesSerialNumber[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/serial_numbers`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/Originators.ts

@@ -0,0 +1,35 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesApiError, APIV21EntitiesOriginator, GetApiV21OriginatorsParams } from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21Originators
+ * @summary List originators
+ * @request GET:/api/v2.1/originators
+ */
+export const getApiV21Originators = (
+  client: HttpClient,
+  query: GetApiV21OriginatorsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOriginator, APIV21EntitiesApiError>({
+    path: `/api/v2.1/originators`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/Public.ts

@@ -0,0 +1,41 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+
+/**
+ * No description
+ *
+ * @tags public
+ * @name GetApiV21PublicStatus
+ * @request GET:/api/v2.1/public/status
+ */
+export const getApiV21PublicStatus = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, any>({
+    path: `/api/v2.1/public/status`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags public
+ * @name GetApiV21PublicCarrierStatus
+ * @request GET:/api/v2.1/public/carrier_status
+ */
+export const getApiV21PublicCarrierStatus = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, any>({
+    path: `/api/v2.1/public/carrier_status`,
+    method: "GET",
+    ...params,
+  });
+};

package/generated/v2.1/ScancodeAliases.ts

@@ -0,0 +1,34 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV21EntitiesApiError, APIV21EntitiesScancode, GetApiV21ScancodeAliasesParams } from "./data-contracts";
+
+/**
+ * @description Get all scancode_aliases
+ *
+ * @tags scancode_aliases
+ * @name GetApiV21ScancodeAliases
+ * @request GET:/api/v2.1/scancode_aliases
+ */
+export const getApiV21ScancodeAliases = (
+  client: HttpClient,
+  query: GetApiV21ScancodeAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesScancode[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/scancode_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesCount,
+  APIV21EntitiesMetaFields,
+  APIV21EntitiesShipnoticeItem,
+  GetApiV21ShipnoticeItemsCountParams,
+  GetApiV21ShipnoticeItemsIdMetaFieldsPayload,
+  PutApiV21ShipnoticeItemsIdPayload,
+} from "./data-contracts";
+
+/**
+ * @description Get resource actions
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/shipnotice_items/actions
+ */
+export const getApiV21ShipnoticeItemsActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name DeleteApiV21ShipnoticeItemsId
+ * @summary Destroy a shipnotice item
+ * @request DELETE:/api/v2.1/shipnotice_items/{id}
+ */
+export const deleteApiV21ShipnoticeItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesShipnoticeItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name PutApiV21ShipnoticeItemsId
+ * @summary Update a ship notice item
+ * @request PUT:/api/v2.1/shipnotice_items/{id}
+ */
+export const putApiV21ShipnoticeItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21ShipnoticeItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnoticeItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsId
+ * @summary Retrieve a ship notice item
+ * @request GET:/api/v2.1/shipnotice_items/{id}
+ */
+export const getApiV21ShipnoticeItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesShipnoticeItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags shipnotice_items
+ * @name PutApiV21ShipnoticeItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/shipnotice_items/{id}/meta_fields
+ */
+export const putApiV21ShipnoticeItemsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/shipnotice_items/{id}/meta_fields
+ */
+export const getApiV21ShipnoticeItemsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV21ShipnoticeItemsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesMetaFields, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags shipnotice_items
+ * @name GetApiV21ShipnoticeItemsCount
+ * @summary Count ship notice items
+ * @request GET:/api/v2.1/shipnotice_items/count
+ */
+export const getApiV21ShipnoticeItemsCount = (
+  client: HttpClient,
+  query: GetApiV21ShipnoticeItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/shipnotice_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};