Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ✨ added CsvOrder model + endpoints #7

Merged
merged 5 commits into from
Feb 13, 2024
Merged

feat: ✨ added CsvOrder model + endpoints #7

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2733848
feat: :sparkles: added CsvOrder model + endpoints
PaulRill00 Jan 24, 2024
1ec0047
docs: :memo: updated docs about CsvOrder
PaulRill00 Jan 24, 2024
9dd86ae
fix: PR feedback
PaulRill00 Jan 25, 2024
b4c5d63
Merge branch 'next' into feat/PO-1382-csv-upload-functionality
UnderKoen Feb 13, 2024
6df2e06
chore: type error
UnderKoen Feb 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions docs/CsvOrder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
Contains all information about a given CsvOrder

# Fields

| Name | Type | Description |
| --------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `string` | The ID of the order. |
| `templateId` | `string` | The ID of the template the order is based on. |
| `finish` | `string` | The finish of the order. Can be `GLOSSY` or `MATT`. |
| `format` | `string` | The format of the order. Can be `POSTCARD_A5`, `POSTCARD_A6`, `POSTCARD_SQ14` or `GREETINGCARD_SQ15`. |
| `mergeVariableMapping` | `object` | The merge variables of the order. Keys are the merge variable names. |
| `sender` | [`Address`](#Address) \| `undefined` | The sender of the order. |
| `recipientMapping` | [`Address`](#Address) | The mapping of the recipient. |
| `definitiveCountryId` | `string` | The ID of the definitive country of the order. |
| `billingId` | `string` \| `undefined` | The ID assigned to the csv order by the customer. |
| `isBillable` | `boolean` | Whether the csv order is billable. True when an live API key is used, false when a test API key is used. |
| `status` | `string` | The status of the csv order. Can be `order_created` or `order_processed` |
| `friendlyStatus` | `string` | The friendly status of the csv order. Can be `Processing` or `Success` |
| `estimatedOrderCount` | `number` | The amount of initial orders in the CSV
| `failedOrderCount` | `number` | The amount of orders which have failed to be processed
| `processedOrderCount` | `number` | The amount of orders which have successfully been processed
| `totalOrderCount` | `number` | The total amount of orders failed or processed
| `sendDate` | `Date` | The date the order will be sent on. |
| `createdAt` | `Date` | The date and time the order was created. |
| `updatedAt` | `Date` | The date and time the order was last updated. |

# Methods

## `.getTemplate()`

Get the template the order is based on. Uses [`PrintOne.getTemplate()`](./PrintOne#gettemplateid).

**Returns: [`Promise<Template>`](./Template)**

**Example**

```js
const order = await client.getOrder("example-order-id");
const template = await order.getTemplate();
```

---

## `.refresh()`

Refresh the CsvOrder data to get the latest information

**Returns: `Promise<void>`**

**Example**

```js
const csvOrder: CsvOrder;
await csvOrder.refresh();
```

---

## [`CsvOrder.getOrders([options])`](./PrintOne#getordersoptions)

Get all orders generated by the CSV.

**Parameters**

| Name | Type | Default | Description |
| ------------------------------- | ----------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `options.limit` | `number` | `10` | The maximum number of orders to return. |
| `options.page` | `number` | `1` | The page of orders to return. |
| `options.sortBy` | [`sort`](./Filtering#Sorting) | `createdAt:DESC` | The field(s) to sort the orders by. Can be `createdAt`, `anonymizedAt`, `updatedAt`, `friendlyStatus` or `sendDate` |
| `options.filter.friendlyStatus` | `string` \| `string[]` | `undefined` | The friendly status(es) of the order(s) to filter by. Can be `Processing`, `Success`, `Sent`, `Scheduled`, `Cancelled` or `Failed` |
| `options.filter.billingId` | `string` \| `string[]` | `undefined` | The billing ID(s) of the order(s) to filter by. |
| `options.filter.format` | `string` \| `string[]` | `undefined` | The format(s) of the order(s) to filter by. Can be `POSTCARD_A5`, `POSTCARD_A6`, `POSTCARD_SQ14` or `GREETINGCARD_SQ15` |
| `options.filter.finish` | `string` \| `string[]` | `undefined` | The finish(es) of the order(s) to filter by. Can be `GLOSSY` or `MATTE` |
| `options.filter.isBillable` | `boolean` | `undefined` | Whether the order(s) are live order or test orders. |
| `options.filter.createdAt` | [`date`](./Filtering#Date) | `undefined` | The date(s) the order(s) were created on. |

**Returns: [`Promise<PaginatedResponse<Order>>`](./Order)**

**Example**

```js
const orders = await csvOrder.getOrders({
limit: 20,
page: 1,
sortBy: "createdAt:ASC",
filter: {
friendlyStatus: "Success",
billingId: "example-billing-id",
format: Format.POSTCARD_A5,
finish: Finish.GLOSSY,
isBillable: true,
createdAt: {
from: "2020-01-01",
to: "2020-01-31",
},
},
});
```
36 changes: 36 additions & 0 deletions docs/PrintOne.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,39 @@ const orders = await client.getOrders({
},
});
```

---

## `.createCsvOrder(data)`

Create a new csv order.

**Parameters**

| Name | Type | Description |
| ------ | -------- | ---------------------------------------------------------------------------------------- |
| `data` | `object` | The data to create the order with. See [`CsvOrder`](./CsvOrder#createcsvorderdata) for more info. |

**Returns: [`Promise<CsvOrder>`](./CsvOrder)**

**Example**

```js
const order = await client.createCsvOrder({
mapping: {
recipient: {
city: "{{City}}",
name: "{{FirstName}} {{LastName}}",
address: "{{Street}} {{HouseNr}}",
country: "{{Country}}",
postalCode: "{{ZIP}}",
},
mergeVariables: {
name: "{{FirstName}}",
coupon: "{{Coupon}}",
},
},
template: template,
file: file,
});
```
73 changes: 58 additions & 15 deletions src/PrintOne.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ import { IOrder } from "./models/_interfaces/IOrder";
import { FriendlyStatus } from "./enums/Status";
import { Format } from "./enums/Format";
import { AxiosHTTPHandler } from "./AxiosHttpHandler";
import { CreateCsvOrder, CsvOrder } from "./models/CsvOrder";
import { ICsvOrder } from "./models/_interfaces/ICsvOrder";

export type RequestHandler = new (token: string, options: Required<PrintOneOptions>, debug: debug.Debugger) => HttpHandler<unknown, unknown>;
export type RequestHandler = new (token: string, options: Required<PrintOneOptions>, debug: debug.Debugger) => HttpHandler<{ headers: Record<string, string> }, unknown>;

export type PrintOneOptions = Partial<{
url: string;
Expand All @@ -48,6 +50,21 @@ export type Protected = {
printOne: PrintOne;
};

export type OrderPaginatedQuery = PaginationOptions<
"createdAt" | "anonymizedAt" | "updatedAt" | "friendlyStatus" | "sendDate"
> & {
filter?: {
friendlyStatus?: InFilter<FriendlyStatus>;
billingId?: InFilter;
format?: InFilter<Format>;
// finish?: InFilter<Finish>;
isBillable?: boolean;
createdAt?: DateFilter;
anonymizedAt?: DateFilter | boolean;
csvId?: InFilter;
};
};

export class PrintOne {
private readonly _protected: Partial<Protected> = {
debug: debug("print-one"),
Expand Down Expand Up @@ -238,6 +255,43 @@ export class PrintOne {
return new Order(this.protected, response);
}

public async createCsvOrder(data: CreateCsvOrder): Promise<CsvOrder> {
const templateId =
typeof data.template === "string" ? data.template : data.template.id;

const formData = new FormData();
formData.append(
"file",
new Blob([data.file], { type: "text/csv" }),
"upload.csv",
);
formData.append("mapping", JSON.stringify(data.mapping));
formData.append(
"orderData",
JSON.stringify({
sender: data.sender,
templateId,
finish: data.finish,
billingId: data.billingId,
}),
);

const response = await this.client.POST<{ id: string }>(
"orders/csv",
formData,
{
headers: {
"Content-Type": "multipart/form-data",
},
},
);

const id = response.id;
const csvInfo = await this.client.GET<ICsvOrder>(`orders/csv/${id}`);

return new CsvOrder(this.protected, csvInfo);
}

/**
* Get an order by its id.
* @param { string } id The id of the order.
Expand All @@ -259,19 +313,7 @@ export class PrintOne {
* @throws { PrintOneError } If the order could not be found.
*/
public async getOrders(
options: PaginationOptions<
"createdAt" | "anonymizedAt" | "updatedAt" | "friendlyStatus" | "sendDate"
> & {
filter?: {
friendlyStatus?: InFilter<FriendlyStatus>;
billingId?: InFilter;
format?: InFilter<Format>;
// finish?: InFilter<Finish>;
isBillable?: boolean;
createdAt?: DateFilter;
anonymizedAt?: DateFilter | boolean;
};
} = {},
options: OrderPaginatedQuery = {},
): Promise<PaginatedResponse<Order>> {
let params = {
...sortToQuery(options),
Expand All @@ -280,14 +322,15 @@ export class PrintOne {
...inFilterToQuery("format", options.filter?.format),
// ...inFilterToQuery("finish", options.filter?.finish),
...dateFilterToQuery("createdAt", options.filter?.createdAt),
...inFilterToQuery("csvOrderId", options.filter?.csvId),
};

if (typeof options.filter?.isBillable === "boolean") {
params = {
...params,
"filter.isBillable": `$eq:${options.filter.isBillable}`,
};
}
};

if (typeof options.filter?.anonymizedAt === "boolean") {
params = {
Expand Down
29 changes: 29 additions & 0 deletions src/enums/CsvStatus.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
export const CsvStatus: {
order_created: "order_created";
order_processed: "order_processed";
} = {
order_created: "order_created",
order_processed: "order_processed",
};

export type CsvStatus = (typeof CsvStatus)[keyof typeof CsvStatus];

export const FriendlyCsvStatusText: {
Processing: "Processing";
Success: "Success";
} = {
Processing: "Processing",
Success: "Success",
};

export type FriendlyCsvStatusText =
(typeof FriendlyCsvStatusText)[keyof typeof FriendlyCsvStatusText];

export const FriendlyCsvStatus: {
[key in CsvStatus]: FriendlyCsvStatusText;
} = {
order_created: "Processing",
order_processed: "Success",
};

export type FriendlyCsvStatus = typeof FriendlyCsvStatus;
2 changes: 2 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export * from "./PrintOne";
// Models
export * from "./models/Address";
export * from "./models/Company";
export * from "./models/CsvOrder";
export * from "./models/CustomFile";
export * from "./models/Order";
export * from "./models/PaginatedResponse";
Expand All @@ -15,6 +16,7 @@ export * from "./models/PreviewDetails";
export * from "./models/Template";

// Enums
export * from "./enums/CsvStatus";
export * from "./enums/Finish";
export * from "./enums/Format";
export * from "./enums/Status";
Expand Down
Loading