@promoboxx/graphql-gateway-types 1.9.0 → 1.12.0

package/index.d.ts

@@ -326,19 +326,6 @@ export type AddContractData = {
   title?: InputMaybe<Scalars['String']['input']>;
 };
 
-export type AddFundsParams = {
-  amount_cents: Scalars['String']['input'];
-  brand_id: Scalars['ID']['input'];
-  source: Scalars['String']['input'];
-  source_id: Scalars['ID']['input'];
-};
-
-export type AddFundsResponse = {
-  __typename?: 'AddFundsResponse';
-  deposit_id?: Maybe<Scalars['ID']['output']>;
-  transaction_id?: Maybe<Scalars['ID']['output']>;
-};
-
 export type AddLogoToAdAccountParams = {
   id: Scalars['ID']['input'];
   logo_id: Scalars['ID']['input'];
@@ -951,12 +938,6 @@ export type BrandStatus =
   | 'prospect'
   | 'unlocked';
 
-export type BrandWallet = {
-  __typename?: 'BrandWallet';
-  id?: Maybe<Scalars['String']['output']>;
-  payment_methods?: Maybe<Array<PaymentMethod>>;
-};
-
 export type BulkCollectionOperation =
   | 'deactivate'
   | 'delete';
@@ -3753,12 +3734,86 @@ export type LeadsListParams = {
   sort_direction?: InputMaybe<Scalars['String']['input']>;
 };
 
+/**
+ * Ledger Type
+ * belongs to a wallet, represents an amount of money that can be spent based on a set of restriction
+ */
 export type Ledger = {
   __typename?: 'Ledger';
-  balance?: Maybe<Scalars['String']['output']>;
-  id?: Maybe<Scalars['String']['output']>;
-  restrictions?: Maybe<Array<Restriction>>;
-  wallet_id?: Maybe<Scalars['ID']['output']>;
+  balance: Scalars['String']['output'];
+  created_at: Scalars['String']['output'];
+  created_by_id: Scalars['String']['output'];
+  expiration_date?: Maybe<Scalars['String']['output']>;
+  id: Scalars['ID']['output'];
+  refunded_at?: Maybe<Scalars['String']['output']>;
+  restrictions: Array<Restriction>;
+  wallet_id: Scalars['ID']['output'];
+};
+
+export type LedgersResponse = {
+  __typename?: 'LedgersResponse';
+  ledgers: Array<Ledger>;
+};
+
+export type LegacyWithdrawal = {
+  /** The amount to withdraw in cents */
+  amount_cents: Scalars['String']['input'];
+  destination?: InputMaybe<LegacyWithdrawalDestination>;
+  metadata?: InputMaybe<LegacyWithdrawalMetadata>;
+  source?: InputMaybe<LegacyWithdrawalSource>;
+  /**
+   * Abitrary type of the withdrawl
+   * ex: brand-withdrawal-to-pbxx-wallet
+   */
+  transaction_type: Scalars['String']['input'];
+};
+
+/**
+ * The destination.
+ * This example is like a black hole... the magic wallet
+ * key: promoboxx
+ * value: 00000000-0000-0000-0000-000000000000
+ */
+export type LegacyWithdrawalDestination = {
+  restriction?: InputMaybe<LegacyWithdrawalRestriction>;
+};
+
+/**
+ * The who/how for the withdrawal
+ * ex:
+ * sent_via: postman
+ * sent_by: tsharkey
+ */
+export type LegacyWithdrawalMetadata = {
+  sent_by: Scalars['String']['input'];
+  sent_via: Scalars['String']['input'];
+};
+
+export type LegacyWithdrawalParams = {
+  /**
+   * Unique key to be used to ensure the withdrawal, once processed, will not be processed again.
+   * For most use cases directly from the UI this can just be a random uuid.
+   * Note, this does need to be int he proper uuid format.
+   */
+  idempotency_key: Scalars['String']['input'];
+  withdrawals: Array<LegacyWithdrawal>;
+};
+
+export type LegacyWithdrawalResponse = {
+  __typename?: 'LegacyWithdrawalResponse';
+  wallet_balance: Scalars['String']['output'];
+  wallet_id: Scalars['String']['output'];
+};
+
+export type LegacyWithdrawalRestriction = {
+  key: Scalars['String']['input'];
+  value: Scalars['String']['input'];
+};
+
+export type LegacyWithdrawalSource = {
+  id: Scalars['String']['input'];
+  restriction?: InputMaybe<LegacyWithdrawalRestriction>;
+  type: Scalars['String']['input'];
 };
 
 export type Legend = {
@@ -3947,6 +4002,25 @@ export type Logo = {
   file?: Maybe<File>;
 };
 
+export type MakeDepositData = {
+  amount_cents: Scalars['String']['input'];
+  destination?: InputMaybe<WalletTargetData>;
+  idempotency_key: Scalars['String']['input'];
+  metadata?: InputMaybe<Scalars['String']['input']>;
+  source?: InputMaybe<RestrictionData>;
+  transaction_type: Scalars['String']['input'];
+};
+
+export type MakeTransferData = {
+  idempotency_key: Scalars['String']['input'];
+  transfers: Array<InputMaybe<TransferData>>;
+};
+
+export type MakeWithdrawalData = {
+  idempotency_key: Scalars['String']['input'];
+  withdrawals: Array<WithdrawalData>;
+};
+
 export type MapChart = {
   __typename?: 'MapChart';
   chart?: Maybe<Chart>;
@@ -3988,7 +4062,6 @@ export type Mutation = {
   /** Creates a new billboard with the given data and echoes the new row in the database */
   addBillboard?: Maybe<Billboard>;
   addContract?: Maybe<Contract>;
-  addFunds: AddFundsResponse;
   addLogoToAdAccount: AdAccount;
   addRetailerToRetailerAccount: AddRetailerToRetailerAccountResponse;
   approveContentRequest: ContentRequest;
@@ -4076,6 +4149,18 @@ export type Mutation = {
   inviteRetailers?: Maybe<Scalars['ID']['output']>;
   inviteRetailersAndPublishPaidAd: Scalars['ID']['output'];
   joinRetailer: Permission;
+  /**
+   * Make a deposit to a source account
+   * internal only
+   */
+  make_deposit?: Maybe<Transaction>;
+  /** Make a transfer between accounts */
+  make_transfer?: Maybe<Scalars['Boolean']['output']>;
+  /**
+   * Make a withdrawal from a source account
+   * internal only
+   */
+  make_withdrawal?: Maybe<Transaction>;
   markAllAlertsAsRead: Scalars['String']['output'];
   markCampaignInvitationOptIn: Scalars['ID']['output'];
   markCampaignInvitationOptOut: Scalars['ID']['output'];
@@ -4094,6 +4179,8 @@ export type Mutation = {
   rejectBrandRequest: BrandRequest;
   resendAccessInvitation: Scalars['ID']['output'];
   resetInvitations: Array<Invitations>;
+  /** Reset a transfer given an idempotency key */
+  reset_transfer?: Maybe<Transaction>;
   revokeBrandRequest: BrandRequest;
   setAccountFacebookPage?: Maybe<Scalars['ID']['output']>;
   setAccountFacebookPages?: Maybe<Array<Scalars['ID']['output']>>;
@@ -4135,7 +4222,8 @@ export type Mutation = {
   uploadCsv?: Maybe<UploadCsvResponse>;
   upsertContentRequests?: Maybe<Array<ContentRequest>>;
   upsertFacebookUser?: Maybe<UpsertFacebookUserResponse>;
-  withdrawal: WithdrawalResponse;
+  /** @deprecated Use the supergraph/wallet-service */
+  withdrawal: LegacyWithdrawalResponse;
 };
 
 
@@ -4165,11 +4253,6 @@ export type MutationAddContractArgs = {
 };
 
 
-export type MutationAddFundsArgs = {
-  params: AddFundsParams;
-};
-
-
 export type MutationAddLogoToAdAccountArgs = {
   params: AddLogoToAdAccountParams;
 };
@@ -4625,6 +4708,21 @@ export type MutationJoinRetailerArgs = {
 };
 
 
+export type MutationMake_DepositArgs = {
+  data: MakeDepositData;
+};
+
+
+export type MutationMake_TransferArgs = {
+  data?: InputMaybe<MakeTransferData>;
+};
+
+
+export type MutationMake_WithdrawalArgs = {
+  data: MakeWithdrawalData;
+};
+
+
 export type MutationMarkAllAlertsAsReadArgs = {
   include_retailers?: InputMaybe<Scalars['Boolean']['input']>;
   resourceId: Scalars['ID']['input'];
@@ -4717,6 +4815,11 @@ export type MutationResetInvitationsArgs = {
 };
 
 
+export type MutationReset_TransferArgs = {
+  idempotency_key: Scalars['String']['input'];
+};
+
+
 export type MutationRevokeBrandRequestArgs = {
   id: Scalars['ID']['input'];
 };
@@ -4950,7 +5053,7 @@ export type MutationUpsertFacebookUserArgs = {
 
 
 export type MutationWithdrawalArgs = {
-  params: WithdrawalParams;
+  params: LegacyWithdrawalParams;
 };
 
 export type NewEvent = {
@@ -5026,6 +5129,18 @@ export type OptimizationGoal =
   | 'REPLIES'
   | 'THRUPLAY';
 
+/**
+ * Type Pagination
+ * Represents the pagination information for a request
+ */
+export type Pagination = {
+  __typename?: 'Pagination';
+  offset: Scalars['Int']['output'];
+  page_size: Scalars['Int']['output'];
+  sort_fields: Array<Sort>;
+  total_count: Scalars['Int']['output'];
+};
+
 /** The paging parameter response from `getBillboards` */
 export type Paging = {
   __typename?: 'Paging';
@@ -5035,15 +5150,16 @@ export type Paging = {
   total_results: Scalars['Int']['output'];
 };
 
-export type PaidAdFilterGroups = {
-  filters?: InputMaybe<Array<FilterGroups>>;
+export type PagingResponse = {
+  __typename?: 'PagingResponse';
+  offset?: Maybe<Scalars['Int']['output']>;
+  page_size?: Maybe<Scalars['Int']['output']>;
+  sort?: Maybe<Scalars['String']['output']>;
+  total_results: Scalars['Int']['output'];
 };
 
-export type PaymentMethod = {
-  __typename?: 'PaymentMethod';
-  balance_cents?: Maybe<Scalars['String']['output']>;
-  id?: Maybe<Scalars['String']['output']>;
-  type?: Maybe<Scalars['String']['output']>;
+export type PaidAdFilterGroups = {
+  filters?: InputMaybe<Array<FilterGroups>>;
 };
 
 export type Permission = {
@@ -5169,6 +5285,12 @@ export type PutEventsResp = {
 
 export type Query = {
   __typename?: 'Query';
+  /**
+   * get brand_retailer_ledgers
+   * a list of business/retailer wallets that are associated to the requested brand.
+   * Each wallet contains the list of ledgers associated to the business/retailer and their expiration date if applicable.
+   */
+  brand_retailer_ledgers: WalletsResponse;
   bulkGetUsersByUuidAndBrandId: BulkGetUsersByUuidAndBrandIdResponse;
   getAccessInvitation?: Maybe<AccessInvitation>;
   getAccessInvitations?: Maybe<GetAccessInvitationsResponse>;
@@ -5285,13 +5407,34 @@ export type Query = {
   getTwitterAccounts: Array<TwitterAccount>;
   getUser: User;
   getUsers: Array<User>;
-  getWallets: WalletResponse;
+  /**
+   * get ledgers
+   * returns the ledgers for the requested brand or business filtered by the provided restrictions
+   */
+  get_ledgers: LedgersResponse;
+  /**
+   * get transaction history
+   * returns the transaction history for the requested brand or business
+   */
+  get_transaction_history: TransactionHistory;
+  /**
+   * get wallet by brand or business
+   * returns the wallet and the associated ledgers for the requested brand or business
+   */
+  get_wallet_by_brand_or_business: Wallet;
   manualBusinessRequest?: Maybe<FacebookPage>;
   validateToken?: Maybe<ValidateTokenResponse>;
   zipDigitalAssets: ZipDigitalAssetsResponse;
 };
 
 
+export type QueryBrand_Retailer_LedgersArgs = {
+  brand_id: Scalars['ID']['input'];
+  business_ids: Array<Scalars['ID']['input']>;
+  funded?: InputMaybe<Scalars['Boolean']['input']>;
+};
+
+
 export type QueryBulkGetUsersByUuidAndBrandIdArgs = {
   brand_id: Scalars['ID']['input'];
   strict_ordering?: InputMaybe<Scalars['Boolean']['input']>;
@@ -5911,8 +6054,26 @@ export type QueryGetUsersArgs = {
 };
 
 
-export type QueryGetWalletsArgs = {
-  params: WalletsParams;
+export type QueryGet_LedgersArgs = {
+  brand_id?: InputMaybe<Scalars['ID']['input']>;
+  business_id?: InputMaybe<Scalars['ID']['input']>;
+  exclusions?: InputMaybe<Scalars['String']['input']>;
+  restrictions?: InputMaybe<Scalars['String']['input']>;
+};
+
+
+export type QueryGet_Transaction_HistoryArgs = {
+  brand_id?: InputMaybe<Scalars['ID']['input']>;
+  business_id?: InputMaybe<Scalars['ID']['input']>;
+  limit?: InputMaybe<Scalars['Int']['input']>;
+  offset?: InputMaybe<Scalars['Int']['input']>;
+  sort?: InputMaybe<Scalars['String']['input']>;
+};
+
+
+export type QueryGet_Wallet_By_Brand_Or_BusinessArgs = {
+  brand_id?: InputMaybe<Scalars['ID']['input']>;
+  business_id?: InputMaybe<Scalars['ID']['input']>;
 };
 
 
@@ -6031,10 +6192,20 @@ export type ResourceType =
   | 'retailers'
   | 'smart_groups';
 
+/**
+ * Restriction Type
+ * used to restrict the use of a ledger
+ * i.e. a ledger can be restricted to a specific brand or business or campaign
+ */
 export type Restriction = {
   __typename?: 'Restriction';
-  key?: Maybe<Scalars['String']['output']>;
-  value?: Maybe<Scalars['String']['output']>;
+  filter_value: Scalars['String']['output'];
+  key: Scalars['String']['output'];
+};
+
+export type RestrictionData = {
+  type: Scalars['String']['input'];
+  value: Scalars['String']['input'];
 };
 
 export type Retailer = {
@@ -6560,6 +6731,16 @@ export type Socials = {
   share_data?: Maybe<Scalars['String']['output']>;
 };
 
+/**
+ * Type Sort
+ * Represents the sort information for a request
+ */
+export type Sort = {
+  __typename?: 'Sort';
+  direction: Scalars['String']['output'];
+  field: Scalars['String']['output'];
+};
+
 export type SortFields = {
   direction?: InputMaybe<Scalars['String']['input']>;
   field: Scalars['String']['input'];
@@ -6732,6 +6913,59 @@ export type TotalDivisionReferralStat = {
   reps?: Maybe<Scalars['Int']['output']>;
 };
 
+/**
+ * Type Transaction
+ * Represents the source and destination, destination, amount and type of a transaction
+ */
+export type Transaction = {
+  __typename?: 'Transaction';
+  amount: Scalars['String']['output'];
+  created_at: Scalars['String']['output'];
+  created_by_id: Scalars['ID']['output'];
+  destination_wallet_id?: Maybe<Scalars['ID']['output']>;
+  destination_wallet_type: Scalars['String']['output'];
+  id: Scalars['ID']['output'];
+  idempotency_key: Scalars['String']['output'];
+  metadata?: Maybe<Scalars['String']['output']>;
+  source_wallet_id?: Maybe<Scalars['ID']['output']>;
+  source_wallet_type: Scalars['String']['output'];
+  transaction_type: Scalars['String']['output'];
+  wallet_id: Scalars['ID']['output'];
+  wallet_running_balance: Scalars['String']['output'];
+};
+
+/**
+ * Type TransactionHistory
+ * Represents a list of transactions
+ */
+export type TransactionHistory = {
+  __typename?: 'TransactionHistory';
+  paging?: Maybe<Pagination>;
+  transactions: Array<Transaction>;
+};
+
+/**
+ * Type Transfer
+ * Represents a transfer from one wallet to another
+ */
+export type Transfer = {
+  __typename?: 'Transfer';
+  amount_cents: Scalars['String']['output'];
+  destination?: Maybe<WalletTarget>;
+  metadata?: Maybe<Scalars['String']['output']>;
+  source?: Maybe<WalletTarget>;
+  transaction_type: Scalars['String']['output'];
+};
+
+/** A transfer is a transaction between two accounts */
+export type TransferData = {
+  amount_cents: Scalars['String']['input'];
+  destination?: InputMaybe<WalletTargetData>;
+  metadata?: InputMaybe<Scalars['String']['input']>;
+  source?: InputMaybe<WalletTargetData>;
+  transaction_type: Scalars['String']['input'];
+};
+
 export type TwitterAccount = {
   __typename?: 'TwitterAccount';
   authenticated_local?: Maybe<Scalars['Boolean']['output']>;
@@ -7185,22 +7419,45 @@ export type ViewStat = {
   opened?: Maybe<Scalars['Int']['output']>;
 };
 
+/**
+ * Wallet Type
+ * Represents a wallet for a brand or business
+ * a wallet will only have a brand id or a business id set which indicates the type of wallet
+ */
 export type Wallet = {
   __typename?: 'Wallet';
-  balance?: Maybe<Scalars['String']['output']>;
+  balance: Scalars['String']['output'];
   brand_id?: Maybe<Scalars['ID']['output']>;
   business_id?: Maybe<Scalars['ID']['output']>;
-  id?: Maybe<Scalars['String']['output']>;
-  ledgers?: Maybe<Array<Ledger>>;
+  created_at: Scalars['String']['output'];
+  created_by_id?: Maybe<Scalars['ID']['output']>;
+  id: Scalars['ID']['output'];
+  ledgers: Array<Ledger>;
 };
 
-export type WalletResponse = {
-  __typename?: 'WalletResponse';
-  wallets?: Maybe<Array<Wallet>>;
+/**
+ * Type WalletTarget
+ * Represents the source or destination of a transaction
+ */
+export type WalletTarget = {
+  __typename?: 'WalletTarget';
+  expiration?: Maybe<Scalars['String']['output']>;
+  id: Scalars['ID']['output'];
+  restriction?: Maybe<Restriction>;
+  type: Scalars['String']['output'];
 };
 
-export type WalletsParams = {
-  brand_id: Scalars['ID']['input'];
+export type WalletTargetData = {
+  expiration?: InputMaybe<Scalars['String']['input']>;
+  id: Scalars['ID']['input'];
+  restriction?: InputMaybe<RestrictionData>;
+  type: Scalars['String']['input'];
+};
+
+/** get brand_retailer_ledgers */
+export type WalletsResponse = {
+  __typename?: 'WalletsResponse';
+  wallets: Array<Wallet>;
 };
 
 export type WeakCreateFilterDataFilterRuleSetCriteria = {
@@ -7212,77 +7469,25 @@ export type WeakCreateFilterDataFilterRuleSetCriteria = {
   within_days?: InputMaybe<Scalars['String']['input']>;
 };
 
-export type Withdrawal = {
-  /** The amount to withdraw in cents */
-  amount_cents: Scalars['String']['input'];
-  destination?: InputMaybe<WithdrawalDestination>;
-  metadata?: InputMaybe<WithdrawalMetadata>;
-  source?: InputMaybe<WithdrawalSource>;
-  /**
-   * Abitrary type of the withdrawl
-   * ex: brand-withdrawal-to-pbxx-wallet
-   */
-  transaction_type: Scalars['String']['input'];
-};
-
 /**
- * The destination.
- * This example is like a black hole... the magic wallet
- * key: promoboxx
- * value: 00000000-0000-0000-0000-000000000000
- */
-export type WithdrawalDestination = {
-  restriction?: InputMaybe<WithdrawalRestriction>;
-};
-
-/**
- * The who/how for the withdrawal
- * ex:
- * sent_via: postman
- * sent_by: tsharkey
+ * Type Withdrawal
+ * Represents a withdrawal from a wallet
  */
-export type WithdrawalMetadata = {
-  sent_by: Scalars['String']['input'];
-  sent_via: Scalars['String']['input'];
-};
-
-export type WithdrawalParams = {
-  /**
-   * Unique key to be used to ensure the withdrawal, once processed, will not be processed again.
-   * For most use cases directly from the UI this can just be a random uuid.
-   * Note, this does need to be int he proper uuid format.
-   */
-  idempotency_key: Scalars['String']['input'];
-  withdrawals: Array<Withdrawal>;
-};
-
-export type WithdrawalResponse = {
-  __typename?: 'WithdrawalResponse';
-  wallet_balance: Scalars['String']['output'];
-  wallet_id: Scalars['String']['output'];
-};
-
-export type WithdrawalRestriction = {
-  key: Scalars['String']['input'];
-  value: Scalars['String']['input'];
+export type Withdrawal = {
+  __typename?: 'Withdrawal';
+  amount_cents: Scalars['String']['output'];
+  destination?: Maybe<Restriction>;
+  metadata?: Maybe<Scalars['String']['output']>;
+  source?: Maybe<WalletTarget>;
+  transaction_type: Scalars['String']['output'];
 };
 
-/**
- * Source of the withdrawal
- * ex:
- * source: {
- *   id: <brand_uuid>
- *   type: "brand"
- *   restriction: {
- *     key: "brand"
- *     value: <brand_uuid>
- *   }
- * }
- */
-export type WithdrawalSource = {
-  id: Scalars['String']['input'];
-  restriction?: InputMaybe<WithdrawalRestriction>;
-  type: Scalars['String']['input'];
+export type WithdrawalData = {
+  amount_cents: Scalars['String']['input'];
+  destination?: InputMaybe<RestrictionData>;
+  metadata?: InputMaybe<Scalars['String']['input']>;
+  source?: InputMaybe<WalletTargetData>;
+  transaction_type: Scalars['String']['input'];
 };
 
 export type ZipDigitalAssetsParams = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promoboxx/graphql-gateway-types",
-  "version": "1.9.0",
+  "version": "1.12.0",
   "description": "",
   "main": "index.js",
   "scripts": {