@compassdigital/sdk.typescript 3.17.0 → 3.19.0

package/src/interface/loyalty.ts

@@ -1,545 +0,0 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
-import { RequestQuery } from "./util";
-
-export interface Error {
-  message?: string;
-  code?: number;
-}
-
-export interface EnrollResponse {
-  points?: number;
-  loyalty_card_id?: number;
-}
-
-export interface Points {
-  points?: number;
-}
-
-export interface UserId {
-  user_id?: string;
-}
-
-export interface Offer {
-  id?: number;
-  name?: string;
-  promotion_type?: string;
-  target?: string;
-  image_url?: string;
-  description?: string;
-  terms_and_conditions?: string;
-  instructions?: string;
-  pos_code?: string;
-  pos_instructions?: string;
-  destination_url?: string;
-  created_at?: string;
-  updated_at?: string;
-  start_date?: string;
-  end_date?: string;
-}
-
-export interface EnrollmentStatus {
-  is_enrolled?: boolean;
-  loyalty_card_id?: number;
-}
-
-export interface Success {
-  success?: boolean;
-}
-
-export interface EarningOpportunity {
-  name?: string;
-  event_type?: string;
-  description?: string;
-  order_index?: number;
-  destination_url?: string;
-  image_url?: string;
-  points?: number;
-  cap_reached?: boolean;
-  rule_type?: string;
-}
-
-export interface Reward {
-  id?: number;
-  name?: string;
-  description?: string;
-  image_url?: string;
-  instructions?: string;
-  points_needed_to_redeem?: number;
-  status?: boolean;
-  expiration_date?: string;
-  points_remaining_to_redeem?: number;
-  dollar_value?: number;
-}
-
-export interface Coupon {
-  id?: string;
-  name?: string;
-  status?: string;
-  email?: string;
-  description?: string;
-  expiry_date?: string;
-  redeem_instructions?: string;
-  image_url?: string;
-  dollar_value?: number;
-}
-
-export interface RecordResponse {
-  points?: number;
-  event_id?: string;
-}
-
-export interface Item {
-  // item id
-  id: string;
-  label?: string;
-  quantity: number;
-  price: {
-    amount?: number;
-  };
-  [index: string]: any;
-}
-
-export interface HistoryTransaction {
-  event_type?: string;
-  created_at?: string;
-  points?: number;
-  value?: number;
-  channel?: string;
-  display_detail?: string;
-}
-
-export interface RewardInfo {
-  id?: number;
-  points?: number;
-  cost?: number;
-  description?: string;
-  expiry_date?: string;
-  event_id?: number;
-  image_url?: string;
-  name?: string;
-  pos_code?: string;
-  pos_instructions?: string;
-  redeem_instructions?: string;
-  reward_type?: string;
-  coupon_id?: string;
-}
-
-export interface LoyaltyUser {
-  id?: string;
-  channel?: string;
-  email?: string;
-  first_name?: string;
-  last_name?: string;
-  birthday?: string;
-  balance?: number;
-  lifetime_balance?: number;
-  loyalty_provider_user_id?: number;
-  enrolled_at?: string;
-  last_activity?: string;
-  updated_at?: string;
-  last_reward_date?: string;
-  last_reward_event_id?: string;
-}
-
-export interface Event {
-  id?: string;
-  external_id?: string;
-  created_at?: string;
-  updated_at?: string;
-  points?: number;
-  value?: number;
-  loyalty_provider_user_id?: number;
-  detail?: string;
-  display_detail?: string;
-  event_type?: string;
-  channel?: string;
-  status?: number;
-  email?: string;
-  expires_at?: string;
-}
-
-// POST /loyalty/{id}/enroll/{user_id} - Enroll logged in user in Loyalty program
-
-export interface PostLoyaltyEnrollPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface PostLoyaltyEnrollQuery {
-  // Enrollment Channel
-  channel?: string;
-}
-
-export type PostLoyaltyEnrollResponse = EnrollResponse;
-
-export interface PostLoyaltyEnrollRequest
-  extends RequestQuery<PostLoyaltyEnrollQuery>,
-    PostLoyaltyEnrollPath {}
-
-// GET /loyalty/{id}/points - Get potential points user could earn from certain event in Loyalty program
-
-export interface GetLoyaltyPointsPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyPointsQuery {
-  // event type
-  event: string;
-}
-
-export type GetLoyaltyPointsResponse = Points;
-
-export interface GetLoyaltyPointsRequest
-  extends RequestQuery<GetLoyaltyPointsQuery>,
-    GetLoyaltyPointsPath {}
-
-// GET /loyalty/{id}/offers/{user_id} - Get offers for the logged in user
-
-export interface GetLoyaltyOffersPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyOffersResponse {
-  offers?: Offer[];
-}
-
-export interface GetLoyaltyOffersRequest extends GetLoyaltyOffersPath {}
-
-// GET /loyalty/{id}/enrollmentstatus/{user_id} - Get enrollment status for logged in user
-
-export interface GetLoyaltyEnrollmentstatusPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export type GetLoyaltyEnrollmentstatusResponse = EnrollmentStatus;
-
-export interface GetLoyaltyEnrollmentstatusRequest extends GetLoyaltyEnrollmentstatusPath {}
-
-// GET /loyalty/{id}/balance/{user_id} - Get loyalty point balance for logged in user
-
-export interface GetLoyaltyBalancePath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export type GetLoyaltyBalanceResponse = Points;
-
-export interface GetLoyaltyBalanceRequest extends GetLoyaltyBalancePath {}
-
-// GET /loyalty/{id}/opportunities/{user_id} - Get earning opportunities for the logged in user
-
-export interface GetLoyaltyOpportunitiesPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyOpportunitiesQuery {
-  // Choose what opportunities should not be returned, can be several comma separated
-  filter?: string;
-}
-
-export interface GetLoyaltyOpportunitiesResponse {
-  opportunities?: EarningOpportunity[];
-}
-
-export interface GetLoyaltyOpportunitiesRequest
-  extends RequestQuery<GetLoyaltyOpportunitiesQuery>,
-    GetLoyaltyOpportunitiesPath {}
-
-// POST /loyalty/{id}/opportunities/{user_id} - Record an event for the logged in user
-
-export interface PostLoyaltyOpportunitiesPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface PostLoyaltyOpportunitiesQuery {
-  // Event type that should be recorded for the logged in user
-  event: string;
-  // Event occurence channel
-  channel?: string;
-}
-
-export type PostLoyaltyOpportunitiesResponse = RecordResponse;
-
-export interface PostLoyaltyOpportunitiesRequest
-  extends RequestQuery<PostLoyaltyOpportunitiesQuery>,
-    PostLoyaltyOpportunitiesPath {}
-
-// GET /loyalty/{id}/rewards/{user_id} - Get rewards available for the logged in user
-
-export interface GetLoyaltyRewardsPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyRewardsResponse {
-  rewards?: Reward[];
-}
-
-export interface GetLoyaltyRewardsRequest extends GetLoyaltyRewardsPath {}
-
-// GET /loyalty/{id}/coupons/{user_id} - Get coupons available for the logged in user
-
-export interface GetLoyaltyCouponsPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyCouponsResponse {
-  coupons?: Coupon[];
-}
-
-export interface GetLoyaltyCouponsRequest extends GetLoyaltyCouponsPath {}
-
-// GET /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for an order based on amount.
-
-export interface GetLoyaltyOrderpointsPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyOrderpointsQuery {
-  // Order amount before taxes to check potential loyalty points
-  order_amount: number;
-}
-
-export type GetLoyaltyOrderpointsResponse = Points;
-
-export interface GetLoyaltyOrderpointsRequest
-  extends RequestQuery<GetLoyaltyOrderpointsQuery>,
-    GetLoyaltyOrderpointsPath {}
-
-// POST /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for a order based on amount and items
-
-export interface PostLoyaltyOrderpointsPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface PostLoyaltyOrderpointsBody {
-  // Order total amount before taxes
-  order_amount: number;
-  // List of items in the cart
-  items?: {
-    items?: Item[];
-  };
-}
-
-export type PostLoyaltyOrderpointsResponse = Points;
-
-export interface PostLoyaltyOrderpointsRequest extends PostLoyaltyOrderpointsPath {
-  body: PostLoyaltyOrderpointsBody;
-}
-
-// POST /loyalty/{id}/purchase/{user_id} - Record purchase event
-
-export interface PostLoyaltyPurchasePath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface PostLoyaltyPurchaseQuery {
-  // Purchase Channel
-  channel?: string;
-}
-
-export interface PostLoyaltyPurchaseBody {
-  // Order id
-  order_id: string;
-  // Order total amount before taxes
-  order_total: number;
-  // List of order items
-  items: {
-    items?: Item[];
-  };
-}
-
-export type PostLoyaltyPurchaseResponse = RecordResponse;
-
-export interface PostLoyaltyPurchaseRequest
-  extends RequestQuery<PostLoyaltyPurchaseQuery>,
-    PostLoyaltyPurchasePath {
-  body: PostLoyaltyPurchaseBody;
-}
-
-// POST /loyalty/{id}/buyreward/{user_id} - Redeem rewards to coupons
-
-export interface PostLoyaltyBuyrewardPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface PostLoyaltyBuyrewardQuery {
-  // buy reward Channel
-  channel?: string;
-}
-
-export interface PostLoyaltyBuyrewardBody {
-  reward_id: string;
-}
-
-export type PostLoyaltyBuyrewardResponse = RewardInfo;
-
-export interface PostLoyaltyBuyrewardRequest
-  extends RequestQuery<PostLoyaltyBuyrewardQuery>,
-    PostLoyaltyBuyrewardPath {
-  body: PostLoyaltyBuyrewardBody;
-}
-
-// GET /loyalty/{id}/history/{user_id} - Get history of loyalty transactions for user
-
-export interface GetLoyaltyHistoryPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-}
-
-export interface GetLoyaltyHistoryQuery {
-  // Page number to return for pagination. If not specified will return first 1000 events
-  page_number?: number;
-  // How many entries to return per request. If not specified will return first 1000 events
-  entries_per_page?: number;
-}
-
-export interface GetLoyaltyHistoryResponse {
-  transactions?: HistoryTransaction[];
-}
-
-export interface GetLoyaltyHistoryRequest
-  extends RequestQuery<GetLoyaltyHistoryQuery>,
-    GetLoyaltyHistoryPath {}
-
-// GET /loyalty/{id}/coupon/{user_id}/{coupon_id} - get coupon's information
-
-export interface GetLoyaltyCouponPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-  // Coupon code to get coupon information
-  coupon_id: string;
-}
-
-export interface GetLoyaltyCouponResponse {
-  coupon?: Coupon;
-  // This will be true if the coupon status is either 'redeemed' or 'reissued'
-  is_valid?: boolean;
-}
-
-export interface GetLoyaltyCouponRequest extends GetLoyaltyCouponPath {}
-
-// PATCH /loyalty/{id}/coupon/{user_id}/{coupon_id} - Update coupon's status
-
-export interface PatchLoyaltyCouponPath {
-  // Loyalty Provider id
-  id: string;
-  // CompassDigital User id
-  user_id: string;
-  // Coupon code to update
-  coupon_id: string;
-}
-
-export interface PatchLoyaltyCouponBody {
-  // Coupon status to set
-  status: string;
-}
-
-export type PatchLoyaltyCouponResponse = Success;
-
-export interface PatchLoyaltyCouponRequest extends PatchLoyaltyCouponPath {
-  body: PatchLoyaltyCouponBody;
-}
-
-// GET /loyalty/{id}/search - Search CDL user id by internal 500friends id
-
-export interface GetLoyaltySearchPath {
-  // Loyalty Provider id
-  id: string;
-}
-
-export interface GetLoyaltySearchQuery {
-  // User id in 500friends
-  search_id: number;
-}
-
-export type GetLoyaltySearchResponse = UserId;
-
-export interface GetLoyaltySearchRequest
-  extends RequestQuery<GetLoyaltySearchQuery>,
-    GetLoyaltySearchPath {}
-
-// GET /loyalty/{id}/users - Get all loyalty users updated after specific date
-
-export interface GetLoyaltyUsersPath {
-  // Loyalty Provider id
-  id: string;
-}
-
-export interface GetLoyaltyUsersQuery {
-  // Page number if more than 1000 records available. Equal to 1 by default
-  page_number?: number;
-  // Start date to search from
-  from_date: string;
-}
-
-export interface GetLoyaltyUsersResponse {
-  users?: LoyaltyUser[];
-}
-
-export interface GetLoyaltyUsersRequest
-  extends RequestQuery<GetLoyaltyUsersQuery>,
-    GetLoyaltyUsersPath {}
-
-// GET /loyalty/{id}/events - Get all loyalty events updated after specific date
-
-export interface GetLoyaltyEventsPath {
-  // Loyalty Provider id
-  id: string;
-}
-
-export interface GetLoyaltyEventsQuery {
-  // Page number if more than 1000 records available. Equal to 1 by default
-  page_number?: number;
-  // Start date to search from
-  from_date: string;
-}
-
-export interface GetLoyaltyEventsResponse {
-  events?: Event[];
-}
-
-export interface GetLoyaltyEventsRequest
-  extends RequestQuery<GetLoyaltyEventsQuery>,
-    GetLoyaltyEventsPath {}

package/src/interface/message.ts

@@ -1,58 +0,0 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
-import { RequestQuery } from "./util";
-
-export interface Error {
-  message?: string;
-  code?: number;
-}
-
-export interface CreateMessage {
-  idfa?: string;
-  location?: {
-    latitude?: number;
-    longitude?: number;
-    id?: string;
-  };
-  meta?: {
-    [index: string]: any;
-  };
-  text?: string;
-}
-
-export interface Message {
-  // message
-  id?: string;
-  idfa?: string;
-  location?: {
-    latitude?: number;
-    longitude?: number;
-    id?: string;
-  };
-  meta?: {
-    [index: string]: any;
-  };
-  text?: string;
-  timestamp?: number;
-}
-
-// POST /message - Create a Message
-
-export type PostMessageBody = CreateMessage;
-
-export type PostMessageResponse = Message;
-
-export interface PostMessageRequest {
-  body: PostMessageBody;
-}
-
-// GET /message/{id} - Get a Message
-
-export interface GetMessagePath {
-  // Message CDL encoded id
-  id: string;
-}
-
-export type GetMessageResponse = Message;
-
-export interface GetMessageRequest extends GetMessagePath {}