Skip to content

Commit

Permalink
Automated update by SDK Generator version:3.3.0 commit:2aee95e
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 16, 2024
1 parent d4f3223 commit e8585d7
Show file tree
Hide file tree
Showing 6 changed files with 119 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/gen/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,7 @@ OrderPickupDetailsRecipient.md
OrderRefunds.md
OrderTenders.md
OrderType.md
OrdersSort.md
Owner.md
PaginationCoverage.md
PassThroughQuery.md
Expand Down Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions src/gen/apis/EcommerceApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
GetProductsResponseFromJSON,
GetStoreResponse,
GetStoreResponseFromJSON,
OrdersSort,
PassThroughQuery
} from '../models'
import * as runtime from '../runtime'
Expand Down Expand Up @@ -62,6 +63,7 @@ export interface EcommerceApiOrdersAllRequest {
cursor?: string | null
limit?: number
filter?: EcommerceOrdersFilter
sort?: OrdersSort
passThrough?: PassThroughQuery
fields?: string | null
}
Expand Down Expand Up @@ -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
}
Expand Down
1 change: 1 addition & 0 deletions src/gen/docs/apis/EcommerceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br /><br />Example: &#x60;fields=name,email,addresses.city&#x60;<br /><br />In the example above, the response will only include the fields \&quot;name\&quot;, \&quot;email\&quot; and \&quot;addresses.city\&quot;. If any other fields are available, they will be excluded. | (optional)

Expand Down
36 changes: 36 additions & 0 deletions src/gen/docs/models/OrdersSort.md
Original file line number Diff line number Diff line change
@@ -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]





<a name="OrdersSortBy"></a>
## 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)


73 changes: 73 additions & 0 deletions src/gen/models/OrdersSort.ts
Original file line number Diff line number Diff line change
@@ -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)
}
}
1 change: 1 addition & 0 deletions src/gen/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit e8585d7

Please sign in to comment.