From e8585d7bbe58b5937f6668b7bff7eac60c1e7628 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 16 Apr 2024 11:17:02 +0000 Subject: [PATCH] Automated update by SDK Generator version:3.3.0 commit:2aee95e --- src/gen/.openapi-generator/FILES | 2 + src/gen/apis/EcommerceApi.ts | 6 +++ src/gen/docs/apis/EcommerceApi.md | 1 + src/gen/docs/models/OrdersSort.md | 36 +++++++++++++++ src/gen/models/OrdersSort.ts | 73 +++++++++++++++++++++++++++++++ src/gen/models/index.ts | 1 + 6 files changed, 119 insertions(+) create mode 100644 src/gen/docs/models/OrdersSort.md create mode 100644 src/gen/models/OrdersSort.ts diff --git a/src/gen/.openapi-generator/FILES b/src/gen/.openapi-generator/FILES index 38fc4838f..4d9f09edc 100644 --- a/src/gen/.openapi-generator/FILES +++ b/src/gen/.openapi-generator/FILES @@ -517,6 +517,7 @@ OrderPickupDetailsRecipient.md OrderRefunds.md OrderTenders.md OrderType.md +OrdersSort.md Owner.md PaginationCoverage.md PassThroughQuery.md @@ -1189,6 +1190,7 @@ models/OrderPickupDetailsRecipient.ts models/OrderRefunds.ts models/OrderTenders.ts models/OrderType.ts +models/OrdersSort.ts models/Owner.ts models/PaginationCoverage.ts models/PassThroughQuery.ts diff --git a/src/gen/apis/EcommerceApi.ts b/src/gen/apis/EcommerceApi.ts index 715ebf3ad..250125086 100644 --- a/src/gen/apis/EcommerceApi.ts +++ b/src/gen/apis/EcommerceApi.ts @@ -29,6 +29,7 @@ import { GetProductsResponseFromJSON, GetStoreResponse, GetStoreResponseFromJSON, + OrdersSort, PassThroughQuery } from '../models' import * as runtime from '../runtime' @@ -62,6 +63,7 @@ export interface EcommerceApiOrdersAllRequest { cursor?: string | null limit?: number filter?: EcommerceOrdersFilter + sort?: OrdersSort passThrough?: PassThroughQuery fields?: string | null } @@ -285,6 +287,10 @@ export class EcommerceApi extends runtime.BaseAPI { queryParameters['filter'] = requestParameters.filter } + if (requestParameters.sort !== undefined) { + queryParameters['sort'] = requestParameters.sort + } + if (requestParameters.passThrough !== undefined) { queryParameters['pass_through'] = requestParameters.passThrough } diff --git a/src/gen/docs/apis/EcommerceApi.md b/src/gen/docs/apis/EcommerceApi.md index 7aedb457a..a9a50b5d0 100644 --- a/src/gen/docs/apis/EcommerceApi.md +++ b/src/gen/docs/apis/EcommerceApi.md @@ -175,6 +175,7 @@ Name | Type | Description | Notes **cursor** | [**string**] | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | (optional) **limit** | [**number**] | Number of results to return. Minimum 1, Maximum 200, Default 20 | (optional) defaults to 20 **filter** | **EcommerceOrdersFilter** | Apply filters | (optional) + **sort** | **OrdersSort** | Apply sorting | (optional) **passThrough** | **PassThroughQuery** | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | (optional) **fields** | [**string**] | The \'fields\' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. | (optional) diff --git a/src/gen/docs/models/OrdersSort.md b/src/gen/docs/models/OrdersSort.md new file mode 100644 index 000000000..c482a2661 --- /dev/null +++ b/src/gen/docs/models/OrdersSort.md @@ -0,0 +1,36 @@ +# Apideck.OrdersSort + +### Description + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +`by` | **string** | The field on which to sort the Orders | [optional] +`direction` | [**SortDirection**](SortDirection.md) | | [optional] + + + + + + +## Enum: OrdersSort.by + + +* `created_at` (value: `'created_at'`) + +* `updated_at` (value: `'updated_at'`) + +* `name` (value: `'name'`) + + + + +## Referenced Types: + +* [`SortDirection`](SortDirection.md) + +--- + +[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md) + + diff --git a/src/gen/models/OrdersSort.ts b/src/gen/models/OrdersSort.ts new file mode 100644 index 000000000..c5ab0c477 --- /dev/null +++ b/src/gen/models/OrdersSort.ts @@ -0,0 +1,73 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Apideck + * The Apideck OpenAPI Spec: SDK Optimized + * + * The version of the OpenAPI document: 10.4.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import { exists } from '../runtime' +import { SortDirection, SortDirectionFromJSON, SortDirectionToJSON } from './SortDirection' + +/** + * + * @export + * @interface OrdersSort + */ +export interface OrdersSort { + /** + * The field on which to sort the Orders + * @type {string} + * @memberof OrdersSort + */ + by?: OrdersSortBy + /** + * + * @type {SortDirection} + * @memberof OrdersSort + */ + direction?: SortDirection +} + +/** + * @export + * @enum {string} + */ +export enum OrdersSortBy { + created_at = 'created_at', + updated_at = 'updated_at', + name = 'name' +} + +export function OrdersSortFromJSON(json: any): OrdersSort { + return OrdersSortFromJSONTyped(json, false) +} + +export function OrdersSortFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrdersSort { + if (json === undefined || json === null) { + return json + } + return { + by: !exists(json, 'by') ? undefined : json['by'], + direction: !exists(json, 'direction') ? undefined : SortDirectionFromJSON(json['direction']) + } +} + +export function OrdersSortToJSON(value?: OrdersSort | null): any { + if (value === undefined) { + return undefined + } + if (value === null) { + return null + } + return { + by: value.by, + direction: SortDirectionToJSON(value.direction) + } +} diff --git a/src/gen/models/index.ts b/src/gen/models/index.ts index b98796ecb..add401064 100644 --- a/src/gen/models/index.ts +++ b/src/gen/models/index.ts @@ -485,6 +485,7 @@ export * from './OrderPickupDetails' export * from './OrderPickupDetailsCurbsidePickupDetails' export * from './OrderPickupDetailsRecipient' export * from './OrderRefunds' +export * from './OrdersSort' export * from './OrderTenders' export * from './OrderType' export * from './Owner'