@whiplashmerch/whiplash-api-client 0.4.76 → 0.4.78

package/dist/generated/Shops.d.ts

@@ -0,0 +1,47 @@
+import { APIV2EntitiesAudits, APIV2EntitiesMetaFields, GetApiV21ShopsIdMetaFieldsParams, GetApiV2ShopsIdMetaFieldsParams, PutApiV21ShopsIdMetaFields, PutApiV2ShopsIdMetaFields } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags shops
+ * @name GetApiV2ShopsIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2/shops/{id}/audits
+ */
+export declare const getApiV2ShopsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shops
+ * @name GetApiV2ShopsIdMetaFields
+ * @summary List all Meta Fields
+ * @request GET:/api/v2/shops/{id}/meta_fields
+ */
+export declare const getApiV2ShopsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ShopsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
+/**
+ * @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
+ *
+ * @tags shops
+ * @name PutApiV2ShopsIdMetaFields
+ * @summary Set Meta Fields
+ * @request PUT:/api/v2/shops/{id}/meta_fields
+ */
+export declare const putApiV2ShopsIdMetaFields: (client: HttpClient, id: number, putApiV2ShopsIdMetaFields: PutApiV2ShopsIdMetaFields, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags shops
+ * @name GetApiV21ShopsIdMetaFields
+ * @summary List all Meta Fields
+ * @request GET:/api/v2.1/shops/{id}/meta_fields
+ */
+export declare const getApiV21ShopsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ShopsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
+/**
+ * @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
+ *
+ * @tags shops
+ * @name PutApiV21ShopsIdMetaFields
+ * @summary Set Meta Fields
+ * @request PUT:/api/v2.1/shops/{id}/meta_fields
+ */
+export declare const putApiV21ShopsIdMetaFields: (client: HttpClient, id: number, putApiV21ShopsIdMetaFields: PutApiV21ShopsIdMetaFields, params?: RequestParams) => Promise<void>;

package/dist/generated/Stats.d.ts

@@ -0,0 +1,54 @@
+import { APIV2EntitiesSidekiqBatchStatus } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get sidekiq info
+ *
+ * @tags stats
+ * @name GetApiV2StatsSidekiq
+ * @summary Retrieve sidekiq info
+ * @request GET:/api/v2/stats/sidekiq
+ */
+export declare const getApiV2StatsSidekiq: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get queue info by queue name
+ *
+ * @tags stats
+ * @name GetApiV2StatsSidekiqName
+ * @summary Retrieve queue info by queue name
+ * @request GET:/api/v2/stats/sidekiq/{name}
+ */
+export declare const getApiV2StatsSidekiqName: (client: HttpClient, name: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Returns the details of a sidekiq batch
+ *
+ * @tags stats
+ * @name GetApiV2StatsSidekiqBatchStatusId
+ * @request GET:/api/v2/stats/sidekiq/batch_status/{id}
+ */
+export declare const getApiV2StatsSidekiqBatchStatusId: (client: HttpClient, id: string, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatchStatus>;
+/**
+ * @description Get sidekiq info
+ *
+ * @tags stats
+ * @name GetApiV21StatsSidekiq
+ * @summary Retrieve sidekiq info
+ * @request GET:/api/v2.1/stats/sidekiq
+ */
+export declare const getApiV21StatsSidekiq: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get queue info by queue name
+ *
+ * @tags stats
+ * @name GetApiV21StatsSidekiqName
+ * @summary Retrieve queue info by queue name
+ * @request GET:/api/v2.1/stats/sidekiq/{name}
+ */
+export declare const getApiV21StatsSidekiqName: (client: HttpClient, name: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Returns the details of a sidekiq batch
+ *
+ * @tags stats
+ * @name GetApiV21StatsSidekiqBatchStatusId
+ * @request GET:/api/v2.1/stats/sidekiq/batch_status/{id}
+ */
+export declare const getApiV21StatsSidekiqBatchStatusId: (client: HttpClient, id: string, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatchStatus>;

package/dist/generated/SurchargeMarkups.d.ts

@@ -0,0 +1,56 @@
+import { APIV2EntitiesCount, APIV2EntitiesSurchargeMarkup, GetApiV2SurchargeMarkupsCountParams, GetApiV2SurchargeMarkupsParams, PostApiV2SurchargeMarkups, PutApiV2SurchargeMarkupsId } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get all surcharge_markups
+ *
+ * @tags surcharge_markups
+ * @name GetApiV2SurchargeMarkups
+ * @summary List all surcharge markups
+ * @request GET:/api/v2/surcharge_markups
+ */
+export declare const getApiV2SurchargeMarkups: (client: HttpClient, query: GetApiV2SurchargeMarkupsParams, params?: RequestParams) => Promise<APIV2EntitiesSurchargeMarkup[]>;
+/**
+ * @description Create a surcharge_markup
+ *
+ * @tags surcharge_markups
+ * @name PostApiV2SurchargeMarkups
+ * @summary Create a surcharge markup
+ * @request POST:/api/v2/surcharge_markups
+ */
+export declare const postApiV2SurchargeMarkups: (client: HttpClient, postApiV2SurchargeMarkups: PostApiV2SurchargeMarkups, params?: RequestParams) => Promise<APIV2EntitiesSurchargeMarkup>;
+/**
+ * @description Returns count of surcharge_markups
+ *
+ * @tags surcharge_markups
+ * @name GetApiV2SurchargeMarkupsCount
+ * @summary Count surcharge markups
+ * @request GET:/api/v2/surcharge_markups/count
+ */
+export declare const getApiV2SurchargeMarkupsCount: (client: HttpClient, query: GetApiV2SurchargeMarkupsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * @description Get a SurchargeMarkup
+ *
+ * @tags surcharge_markups
+ * @name GetApiV2SurchargeMarkupsId
+ * @summary Retrieve a surcharge markup
+ * @request GET:/api/v2/surcharge_markups/{id}
+ */
+export declare const getApiV2SurchargeMarkupsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesSurchargeMarkup>;
+/**
+ * No description
+ *
+ * @tags surcharge_markups
+ * @name PutApiV2SurchargeMarkupsId
+ * @summary Update a surcharge markup
+ * @request PUT:/api/v2/surcharge_markups/{id}
+ */
+export declare const putApiV2SurchargeMarkupsId: (client: HttpClient, id: number, putApiV2SurchargeMarkupsId: PutApiV2SurchargeMarkupsId, params?: RequestParams) => Promise<APIV2EntitiesSurchargeMarkup>;
+/**
+ * No description
+ *
+ * @tags surcharge_markups
+ * @name DeleteApiV2SurchargeMarkupsId
+ * @summary Destroy a surcharge markup
+ * @request DELETE:/api/v2/surcharge_markups/{id}
+ */
+export declare const deleteApiV2SurchargeMarkupsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/TemplateTypes.d.ts

@@ -0,0 +1,20 @@
+import { APIV2EntitiesTemplateType, GetApiV21TemplateTypesParams, GetApiV2TemplateTypesParams } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get a list of template_types
+ *
+ * @tags template_types
+ * @name GetApiV2TemplateTypes
+ * @summary List all template types
+ * @request GET:/api/v2/template_types
+ */
+export declare const getApiV2TemplateTypes: (client: HttpClient, query: GetApiV2TemplateTypesParams, params?: RequestParams) => Promise<APIV2EntitiesTemplateType[]>;
+/**
+ * @description Get a list of template_types
+ *
+ * @tags template_types
+ * @name GetApiV21TemplateTypes
+ * @summary List all template types
+ * @request GET:/api/v2.1/template_types
+ */
+export declare const getApiV21TemplateTypes: (client: HttpClient, query: GetApiV21TemplateTypesParams, params?: RequestParams) => Promise<APIV2EntitiesTemplateType[]>;

package/dist/generated/Templates.d.ts

@@ -1,5 +1,14 @@
-import { APIV21EntitiesPostResponse, APIV21EntitiesTemplate, APIV2EntitiesTemplate, GetApiV21TemplatesParams, GetApiV2TemplatesParams, PostApiV21Templates, PostApiV2Templates, PutApiV21TemplatesId, PutApiV2TemplatesId } from "./data-contracts";
+import { APIV21EntitiesPostResponse, APIV21EntitiesTemplate, APIV2EntitiesAudits, APIV2EntitiesRenderedTemplate, APIV2EntitiesSidekiqBatch, APIV2EntitiesTemplate, GetApiV21TemplatesIdRenderResourceIdParams, GetApiV21TemplatesParams, GetApiV21TemplatesRenderTypeTemplateTypeSlugResourceIdParams, GetApiV2TemplatesIdRenderResourceIdParams, GetApiV2TemplatesParams, GetApiV2TemplatesRenderTypeTemplateTypeSlugResourceIdParams, PostApiV21Templates, PostApiV2Templates, PutApiV21TemplatesId, PutApiV21TemplatesIdCallAction, PutApiV21TemplatesIdCallAsyncAction, PutApiV2TemplatesId, PutApiV2TemplatesIdCallAction, PutApiV2TemplatesIdCallAsyncAction } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV2TemplatesIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2/templates/{id}/audits
+ */
+export declare const getApiV2TemplatesIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
 /**
  * No description
  *
@@ -45,6 +54,42 @@ export declare const getApiV2Templates: (client: HttpClient, query: GetApiV2Temp
  * @request POST:/api/v2/templates
  */
 export declare const postApiV2Templates: (client: HttpClient, postApiV2Templates: PostApiV2Templates, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV2TemplatesRenderTypeTemplateTypeSlugResourceId
+ * @summary Render template(s) of a specified type for a given resource
+ * @request GET:/api/v2/templates/render_type/{template_type_slug}/{resource_id}
+ */
+export declare const getApiV2TemplatesRenderTypeTemplateTypeSlugResourceId: (client: HttpClient, { templateTypeSlug, resourceId, ...query }: GetApiV2TemplatesRenderTypeTemplateTypeSlugResourceIdParams, params?: RequestParams) => Promise<APIV2EntitiesRenderedTemplate[]>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PutApiV2TemplatesIdCallAction
+ * @summary Perform an action on a template
+ * @request PUT:/api/v2/templates/{id}/call/{action}
+ */
+export declare const putApiV2TemplatesIdCallAction: (client: HttpClient, action: string, id: number, putApiV2TemplatesIdCallAction: PutApiV2TemplatesIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PutApiV2TemplatesIdCallAsyncAction
+ * @summary Perform an action on a template asynchronously
+ * @request PUT:/api/v2/templates/{id}/call_async/{action}
+ */
+export declare const putApiV2TemplatesIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV2TemplatesIdCallAsyncAction: PutApiV2TemplatesIdCallAsyncAction, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatch>;
+/**
+ * @description Given a specified template and resource, render
+ *
+ * @tags templates
+ * @name GetApiV2TemplatesIdRenderResourceId
+ * @summary Render a template
+ * @request GET:/api/v2/templates/{id}/render/{resource_id}
+ */
+export declare const getApiV2TemplatesIdRenderResourceId: (client: HttpClient, { id, resourceId, ...query }: GetApiV2TemplatesIdRenderResourceIdParams, params?: RequestParams) => Promise<APIV2EntitiesRenderedTemplate>;
 /**
  * No description
  *
@@ -63,6 +108,15 @@ export declare const getApiV21Templates: (client: HttpClient, query: GetApiV21Te
  * @request POST:/api/v2.1/templates
  */
 export declare const postApiV21Templates: (client: HttpClient, postApiV21Templates: PostApiV21Templates, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name GetApiV21TemplatesRenderTypeTemplateTypeSlugResourceId
+ * @summary Render template(s) of a specified type for a given resource
+ * @request GET:/api/v2.1/templates/render_type/{template_type_slug}/{resource_id}
+ */
+export declare const getApiV21TemplatesRenderTypeTemplateTypeSlugResourceId: (client: HttpClient, { templateTypeSlug, resourceId, ...query }: GetApiV21TemplatesRenderTypeTemplateTypeSlugResourceIdParams, params?: RequestParams) => Promise<APIV2EntitiesRenderedTemplate[]>;
 /**
  * No description
  *
@@ -90,3 +144,30 @@ export declare const putApiV21TemplatesId: (client: HttpClient, id: number, putA
  * @request DELETE:/api/v2.1/templates/{id}
  */
 export declare const deleteApiV21TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesTemplate>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PutApiV21TemplatesIdCallAction
+ * @summary Perform an action on a template
+ * @request PUT:/api/v2.1/templates/{id}/call/{action}
+ */
+export declare const putApiV21TemplatesIdCallAction: (client: HttpClient, action: string, id: number, putApiV21TemplatesIdCallAction: PutApiV21TemplatesIdCallAction, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags templates
+ * @name PutApiV21TemplatesIdCallAsyncAction
+ * @summary Perform an action on a template asynchronously
+ * @request PUT:/api/v2.1/templates/{id}/call_async/{action}
+ */
+export declare const putApiV21TemplatesIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV21TemplatesIdCallAsyncAction: PutApiV21TemplatesIdCallAsyncAction, params?: RequestParams) => Promise<void>;
+/**
+ * @description Given a specified template and resource, render
+ *
+ * @tags templates
+ * @name GetApiV21TemplatesIdRenderResourceId
+ * @summary Render a template
+ * @request GET:/api/v2.1/templates/{id}/render/{resource_id}
+ */
+export declare const getApiV21TemplatesIdRenderResourceId: (client: HttpClient, { id, resourceId, ...query }: GetApiV21TemplatesIdRenderResourceIdParams, params?: RequestParams) => Promise<APIV2EntitiesRenderedTemplate>;

package/dist/generated/Transactions.d.ts

@@ -0,0 +1,11 @@
+import { APIV2EntitiesAudits } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags transactions
+ * @name GetApiV2TransactionsIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2/transactions/{id}/audits
+ */
+export declare const getApiV2TransactionsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;

package/dist/generated/TransportationMarkups.d.ts

@@ -0,0 +1,56 @@
+import { APIV2EntitiesCount, APIV2EntitiesTransportationMarkup, GetApiV2TransportationMarkupsCountParams, GetApiV2TransportationMarkupsParams, PostApiV2TransportationMarkups, PutApiV2TransportationMarkupsId } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags transportation_markups
+ * @name GetApiV2TransportationMarkups
+ * @summary List all transportation markups
+ * @request GET:/api/v2/transportation_markups
+ */
+export declare const getApiV2TransportationMarkups: (client: HttpClient, query: GetApiV2TransportationMarkupsParams, params?: RequestParams) => Promise<APIV2EntitiesTransportationMarkup[]>;
+/**
+ * No description
+ *
+ * @tags transportation_markups
+ * @name PostApiV2TransportationMarkups
+ * @summary Create a transportation markup
+ * @request POST:/api/v2/transportation_markups
+ */
+export declare const postApiV2TransportationMarkups: (client: HttpClient, postApiV2TransportationMarkups: PostApiV2TransportationMarkups, params?: RequestParams) => Promise<APIV2EntitiesTransportationMarkup>;
+/**
+ * No description
+ *
+ * @tags transportation_markups
+ * @name GetApiV2TransportationMarkupsCount
+ * @summary Count transportation markups
+ * @request GET:/api/v2/transportation_markups/count
+ */
+export declare const getApiV2TransportationMarkupsCount: (client: HttpClient, query: GetApiV2TransportationMarkupsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags transportation_markups
+ * @name GetApiV2TransportationMarkupsId
+ * @summary Retrieve a transportation markup
+ * @request GET:/api/v2/transportation_markups/{id}
+ */
+export declare const getApiV2TransportationMarkupsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesTransportationMarkup>;
+/**
+ * No description
+ *
+ * @tags transportation_markups
+ * @name PutApiV2TransportationMarkupsId
+ * @summary Update a transportation markup
+ * @request PUT:/api/v2/transportation_markups/{id}
+ */
+export declare const putApiV2TransportationMarkupsId: (client: HttpClient, id: number, putApiV2TransportationMarkupsId: PutApiV2TransportationMarkupsId, params?: RequestParams) => Promise<APIV2EntitiesTransportationMarkup>;
+/**
+ * No description
+ *
+ * @tags transportation_markups
+ * @name DeleteApiV2TransportationMarkupsId
+ * @summary Destroy a transportation markup
+ * @request DELETE:/api/v2/transportation_markups/{id}
+ */
+export declare const deleteApiV2TransportationMarkupsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/Users.d.ts

@@ -0,0 +1,245 @@
+import { APIV21EntitiesPostResponse, APIV21EntitiesUser, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesResult, APIV2EntitiesUser, GetApiV21UsersCountParams, GetApiV21UsersIdCallTraitParams, GetApiV21UsersIdTraitsParams, GetApiV21UsersJwtParams, GetApiV21UsersParams, GetApiV2UsersCountParams, GetApiV2UsersIdCallTraitParams, GetApiV2UsersIdTraitsParams, GetApiV2UsersJwtParams, GetApiV2UsersParams, PostApiV21Users, PostApiV21UsersAuthorize, PostApiV2Users, PostApiV2UsersAuthorize, PutApiV21UsersId, PutApiV21UsersIdCallAction, PutApiV2UsersId, PutApiV2UsersIdCallAction } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersIdAudits
+ * @summary Retrieve audit info for users
+ * @request GET:/api/v2/users/{id}/audits
+ */
+export declare const getApiV2UsersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersIdTraits
+ * @summary Retrieve the specified users traits
+ * @request GET:/api/v2/users/{id}/traits
+ */
+export declare const getApiV2UsersIdTraits: (client: HttpClient, { id, ...query }: GetApiV2UsersIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersId
+ * @summary Retrieve a user
+ * @request GET:/api/v2/users/{id}
+ */
+export declare const getApiV2UsersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesUser>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PutApiV2UsersId
+ * @summary Update a user
+ * @request PUT:/api/v2/users/{id}
+ */
+export declare const putApiV2UsersId: (client: HttpClient, id: number, putApiV2UsersId: PutApiV2UsersId, params?: RequestParams) => Promise<APIV2EntitiesUser>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name DeleteApiV2UsersId
+ * @summary Destroy a user
+ * @request DELETE:/api/v2/users/{id}
+ */
+export declare const deleteApiV2UsersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersIdBroadcasts
+ * @summary Retrieve broadcasts for a user
+ * @request GET:/api/v2/users/{id}/broadcasts
+ */
+export declare const getApiV2UsersIdBroadcasts: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get users traits
+ *
+ * @tags users
+ * @name GetApiV2UsersTraits
+ * @summary List users traits
+ * @request GET:/api/v2/users/traits
+ */
+export declare const getApiV2UsersTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * @description This will list all users for all customer accounts to which you have access
+ *
+ * @tags users
+ * @name GetApiV2Users
+ * @summary List all users
+ * @request GET:/api/v2/users
+ */
+export declare const getApiV2Users: (client: HttpClient, query: GetApiV2UsersParams, params?: RequestParams) => Promise<APIV2EntitiesUser[]>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PostApiV2Users
+ * @summary Create a user
+ * @request POST:/api/v2/users
+ */
+export declare const postApiV2Users: (client: HttpClient, postApiV2Users: PostApiV2Users, params?: RequestParams) => Promise<APIV2EntitiesUser>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersCount
+ * @summary Count users
+ * @request GET:/api/v2/users/count
+ */
+export declare const getApiV2UsersCount: (client: HttpClient, query: GetApiV2UsersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PostApiV2UsersAuthorize
+ * @summary Authorize a user for a service
+ * @request POST:/api/v2/users/authorize
+ */
+export declare const postApiV2UsersAuthorize: (client: HttpClient, postApiV2UsersAuthorize: PostApiV2UsersAuthorize, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersJwt
+ * @summary Retrieve a JWT for a user
+ * @request GET:/api/v2/users/jwt
+ */
+export declare const getApiV2UsersJwt: (client: HttpClient, query: GetApiV2UsersJwtParams, params?: RequestParams) => Promise<APIV2EntitiesUser>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV2UsersIdCallTrait
+ * @summary Retrieve the specified users trait
+ * @request GET:/api/v2/users/{id}/call/{trait}
+ */
+export declare const getApiV2UsersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV2UsersIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PutApiV2UsersIdCallAction
+ * @summary Perform an action on a user
+ * @request PUT:/api/v2/users/{id}/call/{action}
+ */
+export declare const putApiV2UsersIdCallAction: (client: HttpClient, action: string, id: number, putApiV2UsersIdCallAction: PutApiV2UsersIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesUser>;
+/**
+ * @description Get users traits
+ *
+ * @tags users
+ * @name GetApiV21UsersTraits
+ * @summary List users traits
+ * @request GET:/api/v2.1/users/traits
+ */
+export declare const getApiV21UsersTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
+/**
+ * @description This will list all users for all customer accounts to which you have access
+ *
+ * @tags users
+ * @name GetApiV21Users
+ * @summary List all users
+ * @request GET:/api/v2.1/users
+ */
+export declare const getApiV21Users: (client: HttpClient, query: GetApiV21UsersParams, params?: RequestParams) => Promise<APIV21EntitiesUser[]>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PostApiV21Users
+ * @summary Create a user
+ * @request POST:/api/v2.1/users
+ */
+export declare const postApiV21Users: (client: HttpClient, postApiV21Users: PostApiV21Users, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV21UsersCount
+ * @summary Count users
+ * @request GET:/api/v2.1/users/count
+ */
+export declare const getApiV21UsersCount: (client: HttpClient, query: GetApiV21UsersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PostApiV21UsersAuthorize
+ * @summary Authorize a user for a service
+ * @request POST:/api/v2.1/users/authorize
+ */
+export declare const postApiV21UsersAuthorize: (client: HttpClient, postApiV21UsersAuthorize: PostApiV21UsersAuthorize, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV21UsersJwt
+ * @summary Retrieve a JWT for a user
+ * @request GET:/api/v2.1/users/jwt
+ */
+export declare const getApiV21UsersJwt: (client: HttpClient, query: GetApiV21UsersJwtParams, params?: RequestParams) => Promise<APIV21EntitiesUser>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV21UsersIdCallTrait
+ * @summary Retrieve the specified users trait
+ * @request GET:/api/v2.1/users/{id}/call/{trait}
+ */
+export declare const getApiV21UsersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21UsersIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV21UsersIdTraits
+ * @summary Retrieve the specified users traits
+ * @request GET:/api/v2.1/users/{id}/traits
+ */
+export declare const getApiV21UsersIdTraits: (client: HttpClient, { id, ...query }: GetApiV21UsersIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV21UsersId
+ * @summary Retrieve a user
+ * @request GET:/api/v2.1/users/{id}
+ */
+export declare const getApiV21UsersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesUser>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PutApiV21UsersId
+ * @summary Update a user
+ * @request PUT:/api/v2.1/users/{id}
+ */
+export declare const putApiV21UsersId: (client: HttpClient, id: number, putApiV21UsersId: PutApiV21UsersId, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name DeleteApiV21UsersId
+ * @summary Destroy a user
+ * @request DELETE:/api/v2.1/users/{id}
+ */
+export declare const deleteApiV21UsersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name GetApiV21UsersIdBroadcasts
+ * @summary Retrieve broadcasts for a user
+ * @request GET:/api/v2.1/users/{id}/broadcasts
+ */
+export declare const getApiV21UsersIdBroadcasts: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * No description
+ *
+ * @tags users
+ * @name PutApiV21UsersIdCallAction
+ * @summary Perform an action on a user
+ * @request PUT:/api/v2.1/users/{id}/call/{action}
+ */
+export declare const putApiV21UsersIdCallAction: (client: HttpClient, action: string, id: number, putApiV21UsersIdCallAction: PutApiV21UsersIdCallAction, params?: RequestParams) => Promise<void>;

package/dist/generated/Utilities.d.ts

@@ -0,0 +1,38 @@
+import { APIV21EntitiesPostResponse, APIV2EntitiesDocument, APIV2EntitiesResult, PostApiV21UtilitiesPresignUrl, PostApiV21UtilitiesPublicUrl, PostApiV2UtilitiesPresignUrl, PostApiV2UtilitiesPublicUrl } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * No description
+ *
+ * @tags utilities
+ * @name PostApiV2UtilitiesPresignUrl
+ * @summary Create a presigned upload URL
+ * @request POST:/api/v2/utilities/presign_url
+ */
+export declare const postApiV2UtilitiesPresignUrl: (client: HttpClient, postApiV2UtilitiesPresignUrl: PostApiV2UtilitiesPresignUrl, params?: RequestParams) => Promise<APIV2EntitiesDocument>;
+/**
+ * No description
+ *
+ * @tags utilities
+ * @name PostApiV2UtilitiesPublicUrl
+ * @summary Create a signed aws URL through a private url
+ * @request POST:/api/v2/utilities/public_url
+ */
+export declare const postApiV2UtilitiesPublicUrl: (client: HttpClient, postApiV2UtilitiesPublicUrl: PostApiV2UtilitiesPublicUrl, params?: RequestParams) => Promise<APIV2EntitiesResult>;
+/**
+ * No description
+ *
+ * @tags utilities
+ * @name PostApiV21UtilitiesPresignUrl
+ * @summary Create a presigned upload URL
+ * @request POST:/api/v2.1/utilities/presign_url
+ */
+export declare const postApiV21UtilitiesPresignUrl: (client: HttpClient, postApiV21UtilitiesPresignUrl: PostApiV21UtilitiesPresignUrl, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
+/**
+ * No description
+ *
+ * @tags utilities
+ * @name PostApiV21UtilitiesPublicUrl
+ * @summary Create a signed aws URL through a private url
+ * @request POST:/api/v2.1/utilities/public_url
+ */
+export declare const postApiV21UtilitiesPublicUrl: (client: HttpClient, postApiV21UtilitiesPublicUrl: PostApiV21UtilitiesPublicUrl, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;