@whiplashmerch/whiplash-api-client 0.4.77 → 0.4.78

package/dist/constants/index.d.ts

@@ -0,0 +1 @@
+export * from './search';

package/dist/constants/search.d.ts

@@ -0,0 +1,9 @@
+export declare enum searchTypes {
+    orders = "orders",
+    items = "items",
+    shipNotices = "shipnotices",
+    returns = "consumer_returns",
+    customers = "customers",
+    all = "all"
+}
+export declare const labeledSearchTypes: Map<searchTypes, string>;

package/dist/generated/AccountTransactions.d.ts

@@ -0,0 +1,56 @@
+import { APIV21EntitiesAccountTransaction, APIV2EntitiesAccountTransaction, APIV2EntitiesCount, GetApiV21AccountTransactionsCountParams, GetApiV21AccountTransactionsParams, GetApiV2AccountTransactionsCountParams, GetApiV2AccountTransactionsParams } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags account_transactions
+ * @name GetApiV2AccountTransactions
+ * @summary List all account transactions
+ * @request GET:/api/v2/account_transactions
+ */
+export declare const getApiV2AccountTransactions: (client: HttpClient, query: GetApiV2AccountTransactionsParams, params?: RequestParams) => Promise<APIV2EntitiesAccountTransaction[]>;
+/**
+ * No description
+ *
+ * @tags account_transactions
+ * @name GetApiV2AccountTransactionsCount
+ * @summary Count account transactions
+ * @request GET:/api/v2/account_transactions/count
+ */
+export declare const getApiV2AccountTransactionsCount: (client: HttpClient, query: GetApiV2AccountTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * @description Get an account transaction
+ *
+ * @tags account_transactions
+ * @name GetApiV2AccountTransactionsId
+ * @summary Retrieve an account transaction
+ * @request GET:/api/v2/account_transactions/{id}
+ */
+export declare const getApiV2AccountTransactionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAccountTransaction>;
+/**
+ * No description
+ *
+ * @tags account_transactions
+ * @name GetApiV21AccountTransactions
+ * @summary List all account transactions
+ * @request GET:/api/v2.1/account_transactions
+ */
+export declare const getApiV21AccountTransactions: (client: HttpClient, query: GetApiV21AccountTransactionsParams, params?: RequestParams) => Promise<APIV21EntitiesAccountTransaction[]>;
+/**
+ * No description
+ *
+ * @tags account_transactions
+ * @name GetApiV21AccountTransactionsCount
+ * @summary Count account transactions
+ * @request GET:/api/v2.1/account_transactions/count
+ */
+export declare const getApiV21AccountTransactionsCount: (client: HttpClient, query: GetApiV21AccountTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * @description Get an account transaction
+ *
+ * @tags account_transactions
+ * @name GetApiV21AccountTransactionsId
+ * @summary Retrieve an account transaction
+ * @request GET:/api/v2.1/account_transactions/{id}
+ */
+export declare const getApiV21AccountTransactionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesAccountTransaction>;

package/dist/generated/Accounts.d.ts

@@ -0,0 +1,171 @@
+import { APIV21EntitiesAccount, APIV21EntitiesAccountTransaction, APIV21EntitiesPostResponse, APIV2EntitiesAccount, APIV2EntitiesAccountTransaction, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesFloatNum, GetApiV21AccountsCountParams, GetApiV21AccountsIdAccountTransactionsParams, GetApiV21AccountsParams, GetApiV2AccountsCountParams, GetApiV2AccountsIdAccountTransactionsParams, GetApiV2AccountsParams, PostApiV21Accounts, PostApiV21AccountsIdAccountTransactions, PostApiV2Accounts, PostApiV2AccountsIdAccountTransactions, PutApiV21AccountsId, PutApiV2AccountsId } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags accounts
+ * @name GetApiV2AccountsIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2/accounts/{id}/audits
+ */
+export declare const getApiV2AccountsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
+/**
+ * @description Get an account
+ *
+ * @tags accounts
+ * @name GetApiV2AccountsId
+ * @summary Retrieve an account
+ * @request GET:/api/v2/accounts/{id}
+ */
+export declare const getApiV2AccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAccount>;
+/**
+ * @description Update an account
+ *
+ * @tags accounts
+ * @name PutApiV2AccountsId
+ * @summary Update an account
+ * @request PUT:/api/v2/accounts/{id}
+ */
+export declare const putApiV2AccountsId: (client: HttpClient, id: number, putApiV2AccountsId: PutApiV2AccountsId, params?: RequestParams) => Promise<APIV2EntitiesAccount>;
+/**
+ * @description Destroy an account
+ *
+ * @tags accounts
+ * @name DeleteApiV2AccountsId
+ * @summary Destroy an account
+ * @request DELETE:/api/v2/accounts/{id}
+ */
+export declare const deleteApiV2AccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the suggested_refill for an order
+ *
+ * @tags accounts
+ * @name GetApiV2AccountsIdSuggestedRefill
+ * @summary Retrieve the suggested refill for an order
+ * @request GET:/api/v2/accounts/{id}/suggested_refill
+ */
+export declare const getApiV2AccountsIdSuggestedRefill: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesFloatNum>;
+/**
+ * @description Get all accounts
+ *
+ * @tags accounts
+ * @name GetApiV2Accounts
+ * @request GET:/api/v2/accounts
+ */
+export declare const getApiV2Accounts: (client: HttpClient, query: GetApiV2AccountsParams, params?: RequestParams) => Promise<APIV2EntitiesAccount[]>;
+/**
+ * @description Create an account
+ *
+ * @tags accounts
+ * @name PostApiV2Accounts
+ * @summary Create an accout
+ * @request POST:/api/v2/accounts
+ */
+export declare const postApiV2Accounts: (client: HttpClient, postApiV2Accounts: PostApiV2Accounts, params?: RequestParams) => Promise<APIV2EntitiesAccount>;
+/**
+ * @description Returns count of accounts
+ *
+ * @tags accounts
+ * @name GetApiV2AccountsCount
+ * @summary Count accounts
+ * @request GET:/api/v2/accounts/count
+ */
+export declare const getApiV2AccountsCount: (client: HttpClient, query: GetApiV2AccountsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags accounts
+ * @name GetApiV2AccountsIdAccountTransactions
+ * @summary List all account transactions for an account
+ * @request GET:/api/v2/accounts/{id}/account_transactions
+ */
+export declare const getApiV2AccountsIdAccountTransactions: (client: HttpClient, { id, ...query }: GetApiV2AccountsIdAccountTransactionsParams, params?: RequestParams) => Promise<APIV2EntitiesAccountTransaction[]>;
+/**
+ * No description
+ *
+ * @tags accounts
+ * @name PostApiV2AccountsIdAccountTransactions
+ * @summary Create an account transaction
+ * @request POST:/api/v2/accounts/{id}/account_transactions
+ */
+export declare const postApiV2AccountsIdAccountTransactions: (client: HttpClient, id: number, postApiV2AccountsIdAccountTransactions: PostApiV2AccountsIdAccountTransactions, params?: RequestParams) => Promise<APIV2EntitiesAccountTransaction>;
+/**
+ * @description Get all accounts
+ *
+ * @tags accounts
+ * @name GetApiV21Accounts
+ * @request GET:/api/v2.1/accounts
+ */
+export declare const getApiV21Accounts: (client: HttpClient, query: GetApiV21AccountsParams, params?: RequestParams) => Promise<APIV21EntitiesAccount[]>;
+/**
+ * @description Create an account
+ *
+ * @tags accounts
+ * @name PostApiV21Accounts
+ * @summary Create an accout
+ * @request POST:/api/v2.1/accounts
+ */
+export declare const postApiV21Accounts: (client: HttpClient, postApiV21Accounts: PostApiV21Accounts, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * @description Returns count of accounts
+ *
+ * @tags accounts
+ * @name GetApiV21AccountsCount
+ * @summary Count accounts
+ * @request GET:/api/v2.1/accounts/count
+ */
+export declare const getApiV21AccountsCount: (client: HttpClient, query: GetApiV21AccountsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * @description Get an account
+ *
+ * @tags accounts
+ * @name GetApiV21AccountsId
+ * @summary Retrieve an account
+ * @request GET:/api/v2.1/accounts/{id}
+ */
+export declare const getApiV21AccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesAccount>;
+/**
+ * @description Update an account
+ *
+ * @tags accounts
+ * @name PutApiV21AccountsId
+ * @summary Update an account
+ * @request PUT:/api/v2.1/accounts/{id}
+ */
+export declare const putApiV21AccountsId: (client: HttpClient, id: number, putApiV21AccountsId: PutApiV21AccountsId, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy an account
+ *
+ * @tags accounts
+ * @name DeleteApiV21AccountsId
+ * @summary Destroy an account
+ * @request DELETE:/api/v2.1/accounts/{id}
+ */
+export declare const deleteApiV21AccountsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the suggested_refill for an order
+ *
+ * @tags accounts
+ * @name GetApiV21AccountsIdSuggestedRefill
+ * @summary Retrieve the suggested refill for an order
+ * @request GET:/api/v2.1/accounts/{id}/suggested_refill
+ */
+export declare const getApiV21AccountsIdSuggestedRefill: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesFloatNum>;
+/**
+ * No description
+ *
+ * @tags accounts
+ * @name GetApiV21AccountsIdAccountTransactions
+ * @summary List all account transactions for an account
+ * @request GET:/api/v2.1/accounts/{id}/account_transactions
+ */
+export declare const getApiV21AccountsIdAccountTransactions: (client: HttpClient, { id, ...query }: GetApiV21AccountsIdAccountTransactionsParams, params?: RequestParams) => Promise<APIV21EntitiesAccountTransaction[]>;
+/**
+ * No description
+ *
+ * @tags accounts
+ * @name PostApiV21AccountsIdAccountTransactions
+ * @summary Create an account transaction
+ * @request POST:/api/v2.1/accounts/{id}/account_transactions
+ */
+export declare const postApiV21AccountsIdAccountTransactions: (client: HttpClient, id: number, postApiV21AccountsIdAccountTransactions: PostApiV21AccountsIdAccountTransactions, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;

package/dist/generated/Allocations.d.ts

@@ -0,0 +1,38 @@
+import { APIV21EntitiesAllocation, APIV2EntitiesAllocation, GetApiV21AllocationsParams, GetApiV2AllocationsParams } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get all allocations
+ *
+ * @tags allocations
+ * @name GetApiV2Allocations
+ * @summary List allocations
+ * @request GET:/api/v2/allocations
+ */
+export declare const getApiV2Allocations: (client: HttpClient, query: GetApiV2AllocationsParams, params?: RequestParams) => Promise<APIV2EntitiesAllocation[]>;
+/**
+ * @description Destroy an allocation
+ *
+ * @tags allocations
+ * @name DeleteApiV2AllocationsId
+ * @summary Destroy an alloation
+ * @request DELETE:/api/v2/allocations/{id}
+ */
+export declare const deleteApiV2AllocationsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get all allocations
+ *
+ * @tags allocations
+ * @name GetApiV21Allocations
+ * @summary List allocations
+ * @request GET:/api/v2.1/allocations
+ */
+export declare const getApiV21Allocations: (client: HttpClient, query: GetApiV21AllocationsParams, params?: RequestParams) => Promise<APIV21EntitiesAllocation[]>;
+/**
+ * @description Destroy an allocation
+ *
+ * @tags allocations
+ * @name DeleteApiV21AllocationsId
+ * @summary Destroy an alloation
+ * @request DELETE:/api/v2.1/allocations/{id}
+ */
+export declare const deleteApiV21AllocationsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/Broadcasts.d.ts

@@ -0,0 +1,164 @@
+import { APIV21EntitiesBroadcast, APIV21EntitiesPostResponse, APIV2EntitiesBroadcast, APIV2EntitiesCount, GetApiV21BroadcastsCountParams, GetApiV21BroadcastsParams, GetApiV2BroadcastsCountParams, GetApiV2BroadcastsParams, PostApiV21Broadcasts, PostApiV2Broadcasts, PutApiV21BroadcastsId, PutApiV2BroadcastsId } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get all broadcasts
+ *
+ * @tags broadcasts
+ * @name GetApiV2Broadcasts
+ * @summary List broadcasts
+ * @request GET:/api/v2/broadcasts
+ */
+export declare const getApiV2Broadcasts: (client: HttpClient, query: GetApiV2BroadcastsParams, params?: RequestParams) => Promise<APIV2EntitiesBroadcast[]>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PostApiV2Broadcasts
+ * @summary Create broadcasts
+ * @request POST:/api/v2/broadcasts
+ */
+export declare const postApiV2Broadcasts: (client: HttpClient, postApiV2Broadcasts: PostApiV2Broadcasts, params?: RequestParams) => Promise<APIV2EntitiesBroadcast>;
+/**
+ * @description Returns count of broadcasts
+ *
+ * @tags broadcasts
+ * @name GetApiV2BroadcastsCount
+ * @summary Count broadcasts
+ * @request GET:/api/v2/broadcasts/count
+ */
+export declare const getApiV2BroadcastsCount: (client: HttpClient, query: GetApiV2BroadcastsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name GetApiV2BroadcastsLevels
+ * @summary Retrieve broadcast levels
+ * @request GET:/api/v2/broadcasts/levels
+ */
+export declare const getApiV2BroadcastsLevels: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name GetApiV2BroadcastsId
+ * @summary Retrieve a broadcast
+ * @request GET:/api/v2/broadcasts/{id}
+ */
+export declare const getApiV2BroadcastsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesBroadcast[]>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PutApiV2BroadcastsId
+ * @summary Update a broadcast
+ * @request PUT:/api/v2/broadcasts/{id}
+ */
+export declare const putApiV2BroadcastsId: (client: HttpClient, id: number, putApiV2BroadcastsId: PutApiV2BroadcastsId, params?: RequestParams) => Promise<APIV2EntitiesBroadcast>;
+/**
+ * @description Destroy a broadcast
+ *
+ * @tags broadcasts
+ * @name DeleteApiV2BroadcastsId
+ * @summary Destroy a broadcast
+ * @request DELETE:/api/v2/broadcasts/{id}
+ */
+export declare const deleteApiV2BroadcastsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PutApiV2BroadcastsIdExpire
+ * @summary Expire a broadcast
+ * @request PUT:/api/v2/broadcasts/{id}/expire
+ */
+export declare const putApiV2BroadcastsIdExpire: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesBroadcast>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PutApiV2BroadcastsIdConsume
+ * @summary Consume a broadcast
+ * @request PUT:/api/v2/broadcasts/{id}/consume
+ */
+export declare const putApiV2BroadcastsIdConsume: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesBroadcast>;
+/**
+ * @description Get all broadcasts
+ *
+ * @tags broadcasts
+ * @name GetApiV21Broadcasts
+ * @summary List broadcasts
+ * @request GET:/api/v2.1/broadcasts
+ */
+export declare const getApiV21Broadcasts: (client: HttpClient, query: GetApiV21BroadcastsParams, params?: RequestParams) => Promise<APIV21EntitiesBroadcast[]>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PostApiV21Broadcasts
+ * @summary Create broadcasts
+ * @request POST:/api/v2.1/broadcasts
+ */
+export declare const postApiV21Broadcasts: (client: HttpClient, postApiV21Broadcasts: PostApiV21Broadcasts, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * @description Returns count of broadcasts
+ *
+ * @tags broadcasts
+ * @name GetApiV21BroadcastsCount
+ * @summary Count broadcasts
+ * @request GET:/api/v2.1/broadcasts/count
+ */
+export declare const getApiV21BroadcastsCount: (client: HttpClient, query: GetApiV21BroadcastsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name GetApiV21BroadcastsLevels
+ * @summary Retrieve broadcast levels
+ * @request GET:/api/v2.1/broadcasts/levels
+ */
+export declare const getApiV21BroadcastsLevels: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name GetApiV21BroadcastsId
+ * @summary Retrieve a broadcast
+ * @request GET:/api/v2.1/broadcasts/{id}
+ */
+export declare const getApiV21BroadcastsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesBroadcast[]>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PutApiV21BroadcastsId
+ * @summary Update a broadcast
+ * @request PUT:/api/v2.1/broadcasts/{id}
+ */
+export declare const putApiV21BroadcastsId: (client: HttpClient, id: number, putApiV21BroadcastsId: PutApiV21BroadcastsId, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a broadcast
+ *
+ * @tags broadcasts
+ * @name DeleteApiV21BroadcastsId
+ * @summary Destroy a broadcast
+ * @request DELETE:/api/v2.1/broadcasts/{id}
+ */
+export declare const deleteApiV21BroadcastsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PutApiV21BroadcastsIdExpire
+ * @summary Expire a broadcast
+ * @request PUT:/api/v2.1/broadcasts/{id}/expire
+ */
+export declare const putApiV21BroadcastsIdExpire: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags broadcasts
+ * @name PutApiV21BroadcastsIdConsume
+ * @summary Consume a broadcast
+ * @request PUT:/api/v2.1/broadcasts/{id}/consume
+ */
+export declare const putApiV21BroadcastsIdConsume: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/Cache.d.ts

@@ -0,0 +1,56 @@
+import { PostApiV21Cache, PostApiV2Cache } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description adds a key to the shared cache
+ *
+ * @tags cache
+ * @name PostApiV2Cache
+ * @summary Add a key to the shared cache
+ * @request POST:/api/v2/cache
+ */
+export declare const postApiV2Cache: (client: HttpClient, postApiV2Cache: PostApiV2Cache, params?: RequestParams) => Promise<void>;
+/**
+ * @description gets a key from the shared cache
+ *
+ * @tags cache
+ * @name GetApiV2CacheKey
+ * @summary Retrieve a key from the shared cache
+ * @request GET:/api/v2/cache/{key}
+ */
+export declare const getApiV2CacheKey: (client: HttpClient, key: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description deletes a key from the shared cache
+ *
+ * @tags cache
+ * @name DeleteApiV2CacheKey
+ * @summary Delete a key from the shared cache
+ * @request DELETE:/api/v2/cache/{key}
+ */
+export declare const deleteApiV2CacheKey: (client: HttpClient, key: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description adds a key to the shared cache
+ *
+ * @tags cache
+ * @name PostApiV21Cache
+ * @summary Add a key to the shared cache
+ * @request POST:/api/v2.1/cache
+ */
+export declare const postApiV21Cache: (client: HttpClient, postApiV21Cache: PostApiV21Cache, params?: RequestParams) => Promise<void>;
+/**
+ * @description gets a key from the shared cache
+ *
+ * @tags cache
+ * @name GetApiV21CacheKey
+ * @summary Retrieve a key from the shared cache
+ * @request GET:/api/v2.1/cache/{key}
+ */
+export declare const getApiV21CacheKey: (client: HttpClient, key: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description deletes a key from the shared cache
+ *
+ * @tags cache
+ * @name DeleteApiV21CacheKey
+ * @summary Delete a key from the shared cache
+ * @request DELETE:/api/v2.1/cache/{key}
+ */
+export declare const deleteApiV21CacheKey: (client: HttpClient, key: number, params?: RequestParams) => Promise<void>;