feat: add getAccounts endpoint (#149)

src/__snapshots__/index.spec.ts.snap

@@ -14,6 +14,7 @@ exports[`module exports > exposes the correct data from index.ts 1`] = `
  "FetchClient": [Function],
  "GetAccount": [Function],
  "GetAccountMessages": [Function],
+ "GetAccounts": [Function],
  "GetApiKeys": [Function],
  "GetCarrier": [Function],
  "GetCarrierOptions": [Function],

src/endpoints/private/accounts/Account.types.ts

@@ -1,7 +1,8 @@
 /* eslint-disable @typescript-eslint/naming-convention */
+import {type PlatformId} from '@myparcel/constants';
 import {type Address} from '@/types/common.types';
+import {type PaginationParameters, type IntBoolean, type Price} from '@/types';
 import {type MyParcelShop} from '@/endpoints/private/shops/Shop.types';
-import { IntBoolean, Price } from '@/types';
 
 export interface AccountAdditionalInfo {
  ecommerce_platform: string;
@@ -24,6 +25,8 @@ export interface AccountSettings {
  use_mfa: IntBoolean;
 }
 
+export type AccountStatus = 1 | 2 | 3 | 4;
+
 export interface MyParcelAccount {
  additional_info: AccountAdditionalInfo;
  carrier_references: [];
@@ -43,8 +46,16 @@ export interface MyParcelAccount {
  platform_id: number;
  shipment_estimates: Record<string, unknown>;
  shops: MyParcelShop[];
- status: number;
+ status: AccountStatus;
  terms_agreed: boolean;
  username: string;
  users: Record<string, unknown>;
 }
+
+export type GetAccountsParams = PaginationParameters & {
+ status?: AccountStatus;
+ from?: string;
+ to?: string;
+ q?: string;
+ platform_id?: PlatformId;
+};

src/endpoints/private/accounts/GetAccounts.ts

@@ -0,0 +1,14 @@
+import {type GetAccountsParams, type MyParcelAccount} from './Account.types';
+import {AbstractPrivateEndpoint, type CreateDefinition, type PaginatedResponse} from '@/model';
+
+type GetAccountsDefinition = CreateDefinition<{
+ name: typeof GetAccounts.name;
+ parameters: GetAccountsParams;
+ response: PaginatedResponse<MyParcelAccount[]>;
+}>;
+
+export class GetAccounts extends AbstractPrivateEndpoint<GetAccountsDefinition> {
+ public readonly name = 'getAccounts';
+ public readonly path = 'accounts';
+ public readonly property = 'accounts';
+}

src/endpoints/private/accounts/index.ts

@@ -1,3 +1,4 @@
 export * from './Account.types';
 export * from './GetAccount';
+export * from './GetAccounts';
 export * from './PutAccount';