Merge pull request magento#364 from magento-architects/company-credit

ECP-472: GraphQL schema for company credit

Author: paliarush

design-documents/graph-ql/coverage/company-credit.md

@@ -0,0 +1,64 @@
+# Queries
+
+```graphql
+
+###### Begin: Extending existing types ######
+type Company {
+    credit: CompanyCredit! @doc(description: "Company credit balance")
+    credit_history(filter: CompanyCreditHistoryFilterInput, pageSize: Int = 20, currentPage: Int = 1): CompanyCreditHistory! @doc(description: "Company credit operations history")
+}
+###### End: Extending existing types ######
+
+
+###### Begin: Defining new types ######
+type CompanyCreditHistory {
+    items: [CompanyCreditOperation]! @doc(description: "An array of company credit operations")
+    page_info: SearchResultPageInfo! @doc(description: "Metadata for pagination rendering")
+    total_count: Int @doc(description: "The number of the company credit operations matching the specified filter")
+}
+
+type CompanyCreditOperation {
+    date: String! @doc(description: "The date of the company credit operation")
+    type: CompanyCreditOperationType! @doc(description: "The type of the company credit operation")
+    amount: Money @doc(description: "The amount fo the company credit operation")
+    balance: CompanyCredit! @doc(description: "Credit balance after the company credit operation")
+    purchase_order: String @doc(description: "Purchase order number associated with the company credit operation")
+    updated_by: CompanyCreditOperationUser! @doc(description: "The user submitting the company credit operation")
+}
+
+type CompanyCreditOperationUser {
+    name: String! @doc(description: "The name of the user submitting the company credit operation")
+    type: CompanyCreditOperationUserType! @doc(description: "The type of the user submitting the company credit operation")
+}
+
+type CompanyCredit {
+    outstanding_balance: Money! @doc(description: "Outstanding company credit")
+    available_credit: Money! @doc(description: "Available company credit")
+    credit_limit: Money! @doc(description: "Company credit limit")
+}
+
+enum CompanyCreditOperationType {
+    ALLOCATION
+    UPDATE
+    PURCHASE
+    REIMBURSEMENT
+    REFUND
+    REVERT
+}
+
+enum CompanyCreditOperationUserType {
+    CUSTOMER
+    ADMIN
+}
+
+input CompanyCreditHistoryFilterInput {
+    operation_type: CompanyCreditOperationType @doc(description: "Enum filter by the type of the company credit operation")
+    purchase_order: String @doc(description: "Free text filter by the purchase order number associated with the company credit operation")
+    updated_by: String @doc(description: "Free text filter by the name of the person submitting the company credit operation")
+}
+###### End: Defining new types ######
+
+```
+
+
+

design-documents/graph-ql/coverage/customer-password-reset.md

@@ -2,7 +2,7 @@
 
 ```graphql
 type Mutation {
-    requestPasswordResetEmail(email: String!): Boolean @doc(description: "Request an email with reset password token for the registerspecified customer identified by the provided email")
+    requestPasswordResetEmail(email: String!): Boolean @doc(description: "Request an email with reset password token for the registered customer identified by the provided email")
     resetPassword(email: String!, resetPasswordToken: String!, newPassword: String!): Boolean @doc(description: "Reset customer password using reset password token received in the email after requesting it using requestPasswordResetEmail")
 }
 ```

design-documents/graph-ql/coverage/gift-wrapping.md

@@ -13,8 +13,8 @@ It is suggested to use base64 encoded DB increment ID as ID in GraphQL.
 type Cart {
     available_gift_wrappings: [GiftWrapping]! @doc(description: "The list of available gift wrapping options for the cart")
     gift_wrapping: GiftWrapping @doc(description: "The selected gift wrapping for the cart")
-    include_printed_card: Boolean! @doc(description: "Wether customer requested printed card for the order")
-    include_gift_receipt: Boolean! @doc(description: "Wether customer requested gift receipt for the order")
+    printed_card_included: Boolean! @doc(description: "Wether customer requested printed card for the order")
+    gift_receipt_included: Boolean! @doc(description: "Wether customer requested gift receipt for the order")
     gift_message: GiftMessage @doc(description: "The entered gift message for the cart")
 }
 
@@ -47,8 +47,8 @@ type SalesItemInterface {
 
 type CustomerOrder {
     gift_wrapping: GiftWrapping @doc(description: "The selected gift wrapping for the order")
-    include_printed_card: Boolean! @doc(description: "Wether customer requested printed card for the order")
-    include_gift_receipt: Boolean! @doc(description: "Wether customer requested gift receipt for the order")
+    printed_card_included: Boolean! @doc(description: "Whether customer requested printed card for the order")
+    gift_receipt_included: Boolean! @doc(description: "Whether customer requested gift receipt for the order")
     gift_message: GiftMessage @doc(description: "The entered gift message for the order")
 }
 
@@ -178,7 +178,7 @@ type CartItemUpdateInput {
 }
 
 type Mutation {
-    setGiftOptionsOnCart(cart_id: String!, gift_message: GiftMessageInput, gift_wrapping_id: ID, include_gift_receipt: Boolean, include_printed_card: Boolean): SetGiftOptionsOnCartOutput @doc(description: "Set gift options like gift wrapping or gift message for the entire cart")
+    setGiftOptionsOnCart(cart_id: String!, gift_message: GiftMessageInput, gift_wrapping_id: ID, gift_receipt_included: Boolean, printed_card_included: Boolean): SetGiftOptionsOnCartOutput @doc(description: "Set gift options like gift wrapping or gift message for the entire cart")
 }
 ###### End: Extending existing types ######