@promoboxx/graphql-gateway-types 1.129.0 → 1.131.0

package/graphql.schema.json

@@ -9515,6 +9515,18 @@
         "name": "CalendarItem",
         "description": null,
         "fields": [
+          {
+            "name": "associable",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "UNION",
+              "name": "CalendarItemAssociable",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "associable_id",
             "description": null,
@@ -9709,6 +9721,18 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "share",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "OBJECT",
+              "name": "Share",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "start_date_at",
             "description": null,
@@ -9787,6 +9811,32 @@
         "enumValues": null,
         "possibleTypes": null
       },
+      {
+        "kind": "UNION",
+        "name": "CalendarItemAssociable",
+        "description": null,
+        "fields": null,
+        "inputFields": null,
+        "interfaces": null,
+        "enumValues": null,
+        "possibleTypes": [
+          {
+            "kind": "OBJECT",
+            "name": "Campaign",
+            "ofType": null
+          },
+          {
+            "kind": "OBJECT",
+            "name": "CommunicationAutomation",
+            "ofType": null
+          },
+          {
+            "kind": "OBJECT",
+            "name": "Share",
+            "ofType": null
+          }
+        ]
+      },
       {
         "kind": "INPUT_OBJECT",
         "name": "CalendarItemFilters",
@@ -48336,6 +48386,55 @@
             "isDeprecated": false,
             "deprecationReason": null
           },
+          {
+            "name": "adsvcGetRetailerCampaign",
+            "description": null,
+            "args": [
+              {
+                "name": "id",
+                "description": null,
+                "type": {
+                  "kind": "NON_NULL",
+                  "name": null,
+                  "ofType": {
+                    "kind": "SCALAR",
+                    "name": "ID",
+                    "ofType": null
+                  }
+                },
+                "defaultValue": null,
+                "isDeprecated": false,
+                "deprecationReason": null
+              },
+              {
+                "name": "retailerID",
+                "description": null,
+                "type": {
+                  "kind": "NON_NULL",
+                  "name": null,
+                  "ofType": {
+                    "kind": "SCALAR",
+                    "name": "Int",
+                    "ofType": null
+                  }
+                },
+                "defaultValue": null,
+                "isDeprecated": false,
+                "deprecationReason": null
+              }
+            ],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "OBJECT",
+                "name": "adsvcGetRetailerCampaignResponse",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
           {
             "name": "brand_retailer_ledgers",
             "description": "get brand_retailer_ledgers\na list of business/retailer wallets that are associated to the requested brand. \nEach wallet contains the list of ledgers associated to the business/retailer and their expiration date if applicable.",
@@ -69582,6 +69681,650 @@
           }
         ],
         "possibleTypes": null
+      },
+      {
+        "kind": "OBJECT",
+        "name": "adsvcCampaignChannel",
+        "description": null,
+        "fields": [
+          {
+            "name": "campaignID",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "channel",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "channelCampaignID",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "createdAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "id",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          }
+        ],
+        "inputFields": null,
+        "interfaces": [],
+        "enumValues": null,
+        "possibleTypes": null
+      },
+      {
+        "kind": "OBJECT",
+        "name": "adsvcCampaignInvitation",
+        "description": null,
+        "fields": [
+          {
+            "name": "acceptedAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "automateAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "automated",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Boolean",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "businessID",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "campaignID",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "createdAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "failureReason",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "id",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "intendedAmountCents",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Int",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "refundAttempts",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Int",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "refundedAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "retailerID",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "state",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "updatedAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          }
+        ],
+        "inputFields": null,
+        "interfaces": [],
+        "enumValues": null,
+        "possibleTypes": null
+      },
+      {
+        "kind": "OBJECT",
+        "name": "adsvcGetRetailerCampaignResponse",
+        "description": null,
+        "fields": [
+          {
+            "name": "automated",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Boolean",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "automatedNow",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Boolean",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "brandId",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "campaignChannels",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "LIST",
+                "name": null,
+                "ofType": {
+                  "kind": "NON_NULL",
+                  "name": null,
+                  "ofType": {
+                    "kind": "OBJECT",
+                    "name": "adsvcCampaignChannel",
+                    "ofType": null
+                  }
+                }
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "campaignInvitation",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "OBJECT",
+                "name": "adsvcCampaignInvitation",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "createdAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "endsAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "fbAdAccountId",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "id",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "ID",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "objective",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "platforms",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "LIST",
+                "name": null,
+                "ofType": {
+                  "kind": "NON_NULL",
+                  "name": null,
+                  "ofType": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  }
+                }
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "publishedAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "SCALAR",
+              "name": "String",
+              "ofType": null
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "startsAt",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "state",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "thumbnail",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "OBJECT",
+                "name": "adsvcMedia",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "title",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "type",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          }
+        ],
+        "inputFields": null,
+        "interfaces": [],
+        "enumValues": null,
+        "possibleTypes": null
+      },
+      {
+        "kind": "OBJECT",
+        "name": "adsvcMedia",
+        "description": null,
+        "fields": [
+          {
+            "name": "sourceID",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "sourceType",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          }
+        ],
+        "inputFields": null,
+        "interfaces": [],
+        "enumValues": null,
+        "possibleTypes": null
       }
     ],
     "directives": [

package/index.d.ts

@@ -1069,6 +1069,7 @@ export type BulkUpdateDigitalAssetParams = {
 
 export type CalendarItem = {
   __typename?: 'CalendarItem';
+  associable?: Maybe<CalendarItemAssociable>;
   associable_id: Scalars['ID']['output'];
   associable_type: Scalars['String']['output'];
   campaign?: Maybe<Campaign>;
@@ -1080,6 +1081,7 @@ export type CalendarItem = {
   id: Scalars['ID']['output'];
   owner_id: Scalars['ID']['output'];
   owner_type: Scalars['String']['output'];
+  share?: Maybe<Share>;
   start_date_at: Scalars['String']['output'];
   targetable_id?: Maybe<Scalars['ID']['output']>;
   targetable_type?: Maybe<Scalars['ID']['output']>;
@@ -1097,6 +1099,8 @@ export type CalendarItemCommunicationAutomationArgs = {
   fields?: InputMaybe<Array<Scalars['String']['input']>>;
 };
 
+export type CalendarItemAssociable = Campaign | CommunicationAutomation | Share;
+
 export type CalendarItemFilters = {
   max_date: Scalars['String']['input'];
   min_date: Scalars['String']['input'];
@@ -5732,6 +5736,7 @@ export type PutEventsResp = {
 export type Query = {
   __typename?: 'Query';
   adminGetSignedDashboard?: Maybe<SignedDashboardResponse>;
+  adsvcGetRetailerCampaign: AdsvcGetRetailerCampaignResponse;
   /**
    * get brand_retailer_ledgers
    * a list of business/retailer wallets that are associated to the requested brand.
@@ -5899,6 +5904,12 @@ export type QueryAdminGetSignedDashboardArgs = {
 };
 
 
+export type QueryAdsvcGetRetailerCampaignArgs = {
+  id: Scalars['ID']['input'];
+  retailerID: Scalars['Int']['input'];
+};
+
+
 export type QueryBrand_Retailer_LedgersArgs = {
   brand_id: Scalars['ID']['input'];
   business_ids: Array<Scalars['ID']['input']>;
@@ -8170,3 +8181,57 @@ export type ZipDigitalAssetsResponse = {
   __typename?: 'ZipDigitalAssetsResponse';
   url: Scalars['String']['output'];
 };
+
+export type AdsvcCampaignChannel = {
+  __typename?: 'adsvcCampaignChannel';
+  campaignID: Scalars['ID']['output'];
+  channel: Scalars['String']['output'];
+  channelCampaignID: Scalars['String']['output'];
+  createdAt: Scalars['String']['output'];
+  id: Scalars['ID']['output'];
+};
+
+export type AdsvcCampaignInvitation = {
+  __typename?: 'adsvcCampaignInvitation';
+  acceptedAt?: Maybe<Scalars['String']['output']>;
+  automateAt?: Maybe<Scalars['String']['output']>;
+  automated: Scalars['Boolean']['output'];
+  businessID: Scalars['ID']['output'];
+  campaignID: Scalars['ID']['output'];
+  createdAt: Scalars['String']['output'];
+  failureReason?: Maybe<Scalars['String']['output']>;
+  id: Scalars['ID']['output'];
+  intendedAmountCents: Scalars['Int']['output'];
+  refundAttempts: Scalars['Int']['output'];
+  refundedAt?: Maybe<Scalars['String']['output']>;
+  retailerID: Scalars['ID']['output'];
+  state: Scalars['String']['output'];
+  updatedAt: Scalars['String']['output'];
+};
+
+export type AdsvcGetRetailerCampaignResponse = {
+  __typename?: 'adsvcGetRetailerCampaignResponse';
+  automated: Scalars['Boolean']['output'];
+  automatedNow: Scalars['Boolean']['output'];
+  brandId: Scalars['ID']['output'];
+  campaignChannels: Array<AdsvcCampaignChannel>;
+  campaignInvitation: AdsvcCampaignInvitation;
+  createdAt: Scalars['String']['output'];
+  endsAt: Scalars['String']['output'];
+  fbAdAccountId?: Maybe<Scalars['String']['output']>;
+  id: Scalars['ID']['output'];
+  objective: Scalars['String']['output'];
+  platforms: Array<Scalars['String']['output']>;
+  publishedAt?: Maybe<Scalars['String']['output']>;
+  startsAt: Scalars['String']['output'];
+  state: Scalars['String']['output'];
+  thumbnail: AdsvcMedia;
+  title: Scalars['String']['output'];
+  type: Scalars['String']['output'];
+};
+
+export type AdsvcMedia = {
+  __typename?: 'adsvcMedia';
+  sourceID: Scalars['String']['output'];
+  sourceType: Scalars['String']['output'];
+};

package/package.json

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

package/schema.graphql

@@ -1043,6 +1043,7 @@ input BulkUpdateDigitalAssetParams {
 }
 
 type CalendarItem {
+  associable: CalendarItemAssociable
   associable_id: ID!
   associable_type: String!
   campaign(params: CampaignParams): Campaign
@@ -1054,6 +1055,7 @@ type CalendarItem {
   id: ID!
   owner_id: ID!
   owner_type: String!
+  share: Share
   start_date_at: String!
   targetable_id: ID
   targetable_type: ID
@@ -1061,6 +1063,8 @@ type CalendarItem {
   updated_at: String!
 }
 
+union CalendarItemAssociable = Campaign | CommunicationAutomation | Share
+
 input CalendarItemFilters {
   max_date: String!
   min_date: String!
@@ -4653,6 +4657,7 @@ type PutEventsResp {
 
 type Query {
   adminGetSignedDashboard(req: AdminGetSignedDashboardRequest!): SignedDashboardResponse
+  adsvcGetRetailerCampaign(id: ID!, retailerID: Int!): adsvcGetRetailerCampaignResponse!
 
   """
   get brand_retailer_ledgers
@@ -6319,4 +6324,54 @@ input ZipDigitalAssetsParams {
 
 type ZipDigitalAssetsResponse {
   url: String!
+}
+
+type adsvcCampaignChannel {
+  campaignID: ID!
+  channel: String!
+  channelCampaignID: String!
+  createdAt: String!
+  id: ID!
+}
+
+type adsvcCampaignInvitation {
+  acceptedAt: String
+  automateAt: String
+  automated: Boolean!
+  businessID: ID!
+  campaignID: ID!
+  createdAt: String!
+  failureReason: String
+  id: ID!
+  intendedAmountCents: Int!
+  refundAttempts: Int!
+  refundedAt: String
+  retailerID: ID!
+  state: String!
+  updatedAt: String!
+}
+
+type adsvcGetRetailerCampaignResponse {
+  automated: Boolean!
+  automatedNow: Boolean!
+  brandId: ID!
+  campaignChannels: [adsvcCampaignChannel!]!
+  campaignInvitation: adsvcCampaignInvitation!
+  createdAt: String!
+  endsAt: String!
+  fbAdAccountId: String
+  id: ID!
+  objective: String!
+  platforms: [String!]!
+  publishedAt: String
+  startsAt: String!
+  state: String!
+  thumbnail: adsvcMedia!
+  title: String!
+  type: String!
+}
+
+type adsvcMedia {
+  sourceID: String!
+  sourceType: String!
 }