@promoboxx/graphql-gateway-types 1.11.0 → 1.12.0

package/schema.graphql

@@ -305,18 +305,6 @@ input AddContractData {
   title: String
 }
 
-input AddFundsParams {
-  amount_cents: String!
-  brand_id: ID!
-  source: String!
-  source_id: ID!
-}
-
-type AddFundsResponse {
-  deposit_id: ID
-  transaction_id: ID
-}
-
 input AddLogoToAdAccountParams {
   id: ID!
   logo_id: ID!
@@ -924,11 +912,6 @@ enum BrandStatus {
   unlocked
 }
 
-type BrandWallet {
-  id: String
-  payment_methods: [PaymentMethod!]
-}
-
 enum BulkCollectionOperation {
   deactivate
   delete
@@ -3615,11 +3598,84 @@ input LeadsListParams {
   sort_direction: String
 }
 
+"""
+Ledger Type
+belongs to a wallet, represents an amount of money that can be spent based on a set of restriction
+"""
 type Ledger {
-  balance: String
-  id: String
-  restrictions: [Restriction!]
-  wallet_id: ID
+  balance: String!
+  created_at: String!
+  created_by_id: String!
+  expiration_date: String
+  id: ID!
+  refunded_at: String
+  restrictions: [Restriction!]!
+  wallet_id: ID!
+}
+
+type LedgersResponse {
+  ledgers: [Ledger!]!
+}
+
+input LegacyWithdrawal {
+  """The amount to withdraw in cents"""
+  amount_cents: String!
+  destination: LegacyWithdrawalDestination
+  metadata: LegacyWithdrawalMetadata
+  source: LegacyWithdrawalSource
+
+  """
+  Abitrary type of the withdrawl
+  ex: brand-withdrawal-to-pbxx-wallet
+  """
+  transaction_type: String!
+}
+
+"""
+The destination.
+This example is like a black hole... the magic wallet
+key: promoboxx
+value: 00000000-0000-0000-0000-000000000000
+"""
+input LegacyWithdrawalDestination {
+  restriction: LegacyWithdrawalRestriction
+}
+
+"""
+The who/how for the withdrawal
+ex:
+sent_via: postman
+sent_by: tsharkey
+"""
+input LegacyWithdrawalMetadata {
+  sent_by: String!
+  sent_via: String!
+}
+
+input 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: String!
+  withdrawals: [LegacyWithdrawal!]!
+}
+
+type LegacyWithdrawalResponse {
+  wallet_balance: String!
+  wallet_id: String!
+}
+
+input LegacyWithdrawalRestriction {
+  key: String!
+  value: String!
+}
+
+input LegacyWithdrawalSource {
+  id: String!
+  restriction: LegacyWithdrawalRestriction
+  type: String!
 }
 
 type Legend {
@@ -3808,6 +3864,25 @@ type Logo {
   file: File
 }
 
+input MakeDepositData {
+  amount_cents: String!
+  destination: WalletTargetData
+  idempotency_key: String!
+  metadata: String
+  source: RestrictionData
+  transaction_type: String!
+}
+
+input MakeTransferData {
+  idempotency_key: String!
+  transfers: [TransferData]!
+}
+
+input MakeWithdrawalData {
+  idempotency_key: String!
+  withdrawals: [WithdrawalData!]!
+}
+
 type MapChart {
   chart: Chart
   scale: MapScale
@@ -3846,7 +3921,6 @@ type Mutation {
   """
   addBillboard(data: AddBillboardData!): Billboard
   addContract(brandId: ID!, data: AddContractData!): Contract
-  addFunds(params: AddFundsParams!): AddFundsResponse!
   addLogoToAdAccount(params: AddLogoToAdAccountParams!): AdAccount!
   addRetailerToRetailerAccount(params: AddRetailerToRetailerAccountParams!): AddRetailerToRetailerAccountResponse!
   approveContentRequest(campaign_request_id: ID!): ContentRequest!
@@ -3936,6 +4010,21 @@ type Mutation {
   inviteRetailers(params: InviteRetailersParams!): ID
   inviteRetailersAndPublishPaidAd(inviteParams: InviteRetailersParams!, publishParams: PublishPaidAdParams!): ID!
   joinRetailer(brandId: ID!, linkId: ID!): Permission!
+
+  """
+  Make a deposit to a source account
+  internal only
+  """
+  make_deposit(data: MakeDepositData!): Transaction
+
+  """Make a transfer between accounts"""
+  make_transfer(data: MakeTransferData): Boolean
+
+  """
+  Make a withdrawal from a source account
+  internal only
+  """
+  make_withdrawal(data: MakeWithdrawalData!): Transaction
   markAllAlertsAsRead(include_retailers: Boolean, resourceId: ID!): String!
   markCampaignInvitationOptIn(id: ID!): ID!
   markCampaignInvitationOptOut(id: ID!): ID!
@@ -3955,6 +4044,9 @@ type Mutation {
   rejectBrandRequest(brand_request: RejectBrandRequestBrandRequest, id: ID!): BrandRequest!
   resendAccessInvitation(id: ID!): ID!
   resetInvitations(params: ResetInvitationsParams!): [Invitations!]!
+
+  """Reset a transfer given an idempotency key"""
+  reset_transfer(idempotency_key: String!): Transaction
   revokeBrandRequest(id: ID!): BrandRequest!
   setAccountFacebookPage(accountId: ID!, id: ID!): ID
   setAccountFacebookPages(params: [SetAccountFacebookPagesInput!]!): [ID!]
@@ -3998,7 +4090,7 @@ type Mutation {
   uploadCsv(brandId: String!, params: UploadCsvParams!): UploadCsvResponse @deprecated(reason: "Use bulkUpdateRetailerData or bulkDeleteRetailerData")
   upsertContentRequests(campaign_requests: [UpsertContentRequestInput!], fields: [String!]): [ContentRequest!]
   upsertFacebookUser(signedRequest: String!, uuid: ID!): UpsertFacebookUserResponse
-  withdrawal(params: WithdrawalParams!): WithdrawalResponse!
+  withdrawal(params: LegacyWithdrawalParams!): LegacyWithdrawalResponse! @deprecated(reason: "Use the supergraph/wallet-service")
 }
 
 input NewEvent {
@@ -4097,6 +4189,17 @@ enum OptimizationGoal {
   THRUPLAY
 }
 
+"""
+Type Pagination
+Represents the pagination information for a request
+"""
+type Pagination {
+  offset: Int!
+  page_size: Int!
+  sort_fields: [Sort!]!
+  total_count: Int!
+}
+
 """The paging parameter response from `getBillboards`"""
 type Paging {
   offset: Int
@@ -4105,14 +4208,15 @@ type Paging {
   total_results: Int!
 }
 
-input PaidAdFilterGroups {
-  filters: [FilterGroups!]
+type PagingResponse {
+  offset: Int
+  page_size: Int
+  sort: String
+  total_results: Int!
 }
 
-type PaymentMethod {
-  balance_cents: String
-  id: String
-  type: String
+input PaidAdFilterGroups {
+  filters: [FilterGroups!]
 }
 
 type Permission {
@@ -4252,6 +4356,12 @@ type PutEventsResp {
 }
 
 type 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(brand_id: ID!, business_ids: [ID!]!, funded: Boolean): WalletsResponse!
   bulkGetUsersByUuidAndBrandId(brand_id: ID!, strict_ordering: Boolean, uuids: [String!]!): BulkGetUsersByUuidAndBrandIdResponse!
   getAccessInvitation(id: ID!, params: GetAccessInvitationParams): AccessInvitation
   getAccessInvitations(params: GetAccessInvitationsParams, resourceId: ID!, resourceType: AccessInvitationResourceType!): GetAccessInvitationsResponse
@@ -4421,7 +4531,24 @@ type Query {
   getTwitterAccounts(params: TwitterAccountParams, resourceId: ID!, resourceType: String!): [TwitterAccount!]!
   getUser(fields: [String!], id: ID!): User!
   getUsers(fields: [String!], filters: GetUserFilters, offset: Int, per_page: Int, resource_id: ID, resource_type: String, search: String, sort_column: String, sort_direction: String): [User!]!
-  getWallets(params: WalletsParams!): WalletResponse!
+
+  """
+  get ledgers
+  returns the ledgers for the requested brand or business filtered by the provided restrictions
+  """
+  get_ledgers(brand_id: ID, business_id: ID, exclusions: String, restrictions: String): LedgersResponse!
+
+  """
+  get transaction history
+  returns the transaction history for the requested brand or business
+  """
+  get_transaction_history(brand_id: ID, business_id: ID, limit: Int, offset: Int, sort: String): 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(brand_id: ID, business_id: ID): Wallet!
   manualBusinessRequest(id: ID!, params: FacebookPageParams): FacebookPage
   validateToken: ValidateTokenResponse
   zipDigitalAssets(params: ZipDigitalAssetsParams): ZipDigitalAssetsResponse!
@@ -4530,9 +4657,19 @@ enum ResourceType {
   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
+"""
 type Restriction {
-  key: String
-  value: String
+  filter_value: String!
+  key: String!
+}
+
+input RestrictionData {
+  type: String!
+  value: String!
 }
 
 type Retailer {
@@ -5046,6 +5183,15 @@ type Socials {
   share_data: String
 }
 
+"""
+Type Sort
+Represents the sort information for a request
+"""
+type Sort {
+  direction: String!
+  field: String!
+}
+
 input SortFields {
   direction: String
   field: String!
@@ -5210,6 +5356,56 @@ type TotalDivisionReferralStat {
   reps: Int
 }
 
+"""
+Type Transaction
+Represents the source and destination, destination, amount and type of a transaction
+"""
+type Transaction {
+  amount: String!
+  created_at: String!
+  created_by_id: ID!
+  destination_wallet_id: ID
+  destination_wallet_type: String!
+  id: ID!
+  idempotency_key: String!
+  metadata: String
+  source_wallet_id: ID
+  source_wallet_type: String!
+  transaction_type: String!
+  wallet_id: ID!
+  wallet_running_balance: String!
+}
+
+"""
+Type TransactionHistory
+Represents a list of transactions
+"""
+type TransactionHistory {
+  paging: Pagination
+  transactions: [Transaction!]!
+}
+
+"""
+Type Transfer
+Represents a transfer from one wallet to another
+"""
+type Transfer {
+  amount_cents: String!
+  destination: WalletTarget
+  metadata: String
+  source: WalletTarget
+  transaction_type: String!
+}
+
+"""A transfer is a transaction between two accounts"""
+input TransferData {
+  amount_cents: String!
+  destination: WalletTargetData
+  metadata: String
+  source: WalletTargetData
+  transaction_type: String!
+}
+
 type TwitterAccount {
   authenticated_local: Boolean
   auto_share_enabled: Boolean
@@ -5656,20 +5852,42 @@ type ViewStat {
   opened: Int
 }
 
+"""
+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
+"""
 type Wallet {
-  balance: String
+  balance: String!
   brand_id: ID
   business_id: ID
-  id: String
-  ledgers: [Ledger!]
+  created_at: String!
+  created_by_id: ID
+  id: ID!
+  ledgers: [Ledger!]!
 }
 
-type WalletResponse {
-  wallets: [Wallet!]
+"""
+Type WalletTarget
+Represents the source or destination of a transaction
+"""
+type WalletTarget {
+  expiration: String
+  id: ID!
+  restriction: Restriction
+  type: String!
 }
 
-input WalletsParams {
-  brand_id: ID!
+input WalletTargetData {
+  expiration: String
+  id: ID!
+  restriction: RestrictionData
+  type: String!
+}
+
+"""get brand_retailer_ledgers"""
+type WalletsResponse {
+  wallets: [Wallet!]!
 }
 
 input WeakCreateFilterDataFilterRuleSetCriteria {
@@ -5681,77 +5899,24 @@ input WeakCreateFilterDataFilterRuleSetCriteria {
   within_days: String
 }
 
-input Withdrawal {
-  """The amount to withdraw in cents"""
-  amount_cents: String!
-  destination: WithdrawalDestination
-  metadata: WithdrawalMetadata
-  source: WithdrawalSource
-
-  """
-  Abitrary type of the withdrawl
-  ex: brand-withdrawal-to-pbxx-wallet
-  """
-  transaction_type: String!
-}
-
 """
-The destination.
-This example is like a black hole... the magic wallet
-key: promoboxx
-value: 00000000-0000-0000-0000-000000000000
+Type Withdrawal
+Represents a withdrawal from a wallet
 """
-input WithdrawalDestination {
-  restriction: WithdrawalRestriction
-}
-
-"""
-The who/how for the withdrawal
-ex:
-sent_via: postman
-sent_by: tsharkey
-"""
-input WithdrawalMetadata {
-  sent_by: String!
-  sent_via: String!
-}
-
-input 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: String!
-  withdrawals: [Withdrawal!]!
-}
-
-type WithdrawalResponse {
-  wallet_balance: String!
-  wallet_id: String!
-}
-
-input WithdrawalRestriction {
-  key: String!
-  value: String!
+type Withdrawal {
+  amount_cents: String!
+  destination: Restriction
+  metadata: String
+  source: WalletTarget
+  transaction_type: String!
 }
 
-"""
-Source of the withdrawal
-ex:
-source: {
-  id: <brand_uuid>
-  type: "brand"
-  restriction: {
-    key: "brand"
-    value: <brand_uuid>
-  }
-}
-"""
-input WithdrawalSource {
-  id: String!
-  restriction: WithdrawalRestriction
-  type: String!
+input WithdrawalData {
+  amount_cents: String!
+  destination: RestrictionData
+  metadata: String
+  source: WalletTargetData
+  transaction_type: String!
 }
 
 input ZipDigitalAssetsParams {