Skip to content

Commit 991df7d

Browse files
committed
fix some type names
1 parent 9b0f6aa commit 991df7d

File tree

6 files changed

+22
-16
lines changed

6 files changed

+22
-16
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# @code.store/arcxp-sdk-ts
22

3+
## 5.0.1
4+
5+
### Patch Changes
6+
7+
- fix some type names
8+
39
## 5.0.0
410

511
### Major Changes

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@code.store/arcxp-sdk-ts",
3-
"version": "5.0.0",
3+
"version": "5.0.1",
44
"description": "A strongly typed set of ArcXP API's and utilities reduce the amount of work required to develop with ArcXP, starting with reducing the boilerplate code you have to write.",
55
"type": "module",
66
"main": "./dist/index.js",

src/api/migration-center/index.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
22
import type {
33
Count,
4-
CountRequest,
4+
CountParams,
55
DetailReport,
6-
DetailReportRequest,
6+
DetailReportParams,
77
GetANSParams,
88
GetRecentGroupIdsResponse,
99
GetRemainingTimeParams,
1010
GetRemainingTimeResponse,
1111
PostANSParams,
1212
PostANSPayload,
1313
Summary,
14-
SummaryReportRequest,
14+
SummaryReportParams,
1515
} from './types.js';
1616

1717
export class ArcMigrationCenter extends ArcAbstractAPI {
1818
constructor(options: ArcAPIOptions) {
1919
super({ ...options, apiPath: 'migrations/v3' });
2020
}
2121

22-
async summary(params?: SummaryReportRequest) {
22+
async summary(params?: SummaryReportParams) {
2323
const { data, headers } = await this.client.get<Summary>('/report/summary', { params });
2424
const nextFromId: string | undefined = headers['amc-record-id'];
2525

2626
return { records: data, nextFromId };
2727
}
2828

29-
async detailed(params?: DetailReportRequest) {
29+
async detailed(params?: DetailReportParams) {
3030
const { data } = await this.client.get<DetailReport>('/report/detail', { params });
3131
return data;
3232
}
3333

34-
async count(params?: CountRequest) {
34+
async count(params?: CountParams) {
3535
const { data } = await this.client.get<Count>('/report/status/count', {
3636
params: {
3737
startDate: params?.startDate?.toISOString(),

src/api/migration-center/types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export type Count = {
116116

117117
type ANSTypeCount = Partial<Record<MigrationStatus, number>>;
118118

119-
export type DetailReportRequest = {
119+
export type DetailReportParams = {
120120
sourceId?: string;
121121
sourceType?: string;
122122
ansId?: string;
@@ -125,12 +125,12 @@ export type DetailReportRequest = {
125125
documentType?: string;
126126
};
127127

128-
export type CountRequest = {
128+
export type CountParams = {
129129
startDate?: Date;
130130
endDate?: Date;
131131
};
132132

133-
export type SummaryReportRequest = {
133+
export type SummaryReportParams = {
134134
status?: MigrationStatus;
135135
website: string;
136136
groupId?: string;

src/api/tags/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
22
import type {
3-
AddTagRequest,
3+
AddTagsPayload,
44
AddTagsResponse,
5-
DeleteTagRequest,
5+
DeleteTagPayload,
66
DeleteTagsResponse,
77
GetAllTagsParams,
88
GetTagsResponse,
@@ -35,12 +35,12 @@ export class ArcTags extends ArcAbstractAPI {
3535
return data;
3636
}
3737

38-
async addTags(payload: AddTagRequest) {
38+
async addTags(payload: AddTagsPayload) {
3939
const { data } = await this.client.post<AddTagsResponse>('/add', payload);
4040
return data;
4141
}
4242

43-
async deleteTags(payload: DeleteTagRequest) {
43+
async deleteTags(payload: DeleteTagPayload) {
4444
const { data } = await this.client.post<DeleteTagsResponse>('/delete', payload);
4545
return data;
4646
}

src/api/tags/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ export type DeleteTagsResponse = {
6868
/**
6969
* Create new tags. The maximum limit per request is 25 tags or 16 MB of data.
7070
*/
71-
export type AddTagRequest = {
71+
export type AddTagsPayload = {
7272
slug: string;
7373
name: string;
7474
description?: string;
7575
}[];
7676
/**
7777
* Delete tags. The maximum limit per request is 25 tags or 16 MB of data.
7878
*/
79-
export type DeleteTagRequest = string[];
79+
export type DeleteTagPayload = string[];

0 commit comments

Comments
 (0)