Module: ShopifyGraphql

Extended by:

Forwardable

Defined in:

lib/shopify_graphql/client.rb,
lib/shopify_graphql/engine.rb,
lib/shopify_graphql/version.rb,
lib/shopify_graphql/resource.rb,
lib/shopify_graphql/response.rb,
lib/shopify_graphql/exceptions.rb,
lib/shopify_graphql/configuration.rb,
lib/shopify_graphql/resources/shop.rb,
lib/shopify_graphql/resources/webhook.rb,
app/graphql/shopify_graphql/current_shop.rb,
lib/shopify_graphql/jobs/create_webhooks_job.rb,
lib/shopify_graphql/jobs/update_webhooks_job.rb,
app/graphql/shopify_graphql/create_bulk_query.rb,
lib/shopify_graphql/jobs/destroy_webhooks_job.rb,
lib/shopify_graphql/managers/webhooks_manager.rb,
app/graphql/shopify_graphql/get_bulk_operation.rb,
app/graphql/shopify_graphql/cancel_subscription.rb,
app/graphql/shopify_graphql/create_bulk_mutation.rb,
app/graphql/shopify_graphql/get_app_subscription.rb,
app/graphql/shopify_graphql/create_staged_uploads.rb,
app/graphql/shopify_graphql/app_subscription_fields.rb,
app/graphql/shopify_graphql/delete_private_metafield.rb,
app/graphql/shopify_graphql/upsert_private_metafield.rb,
app/graphql/shopify_graphql/create_usage_subscription.rb,
app/graphql/shopify_graphql/create_recurring_subscription.rb,
app/controllers/shopify_graphql/graphql_webhooks_controller.rb,
lib/shopify_graphql/controller_concerns/payload_verification.rb,
lib/shopify_graphql/controller_concerns/webhook_verification.rb

Defined Under Namespace

Modules: Mutation, PayloadVerification, Query, RedactJobParams, Resource, WebhookVerification Classes: AppSubscriptionFields, BadRequest, CancelSubscription, Client, ClientError, Configuration, ConnectionError, CreateBulkMutation, CreateBulkQuery, CreateRecurringSubscription, CreateStagedUploads, CreateUsageSubscription, CreateWebhooksJob, CurrentShop, DeletePrivateMetafield, DestroyWebhooksJob, Engine, ForbiddenAccess, GetAppSubscription, GetBulkOperation, GraphqlWebhooksController, MethodNotAllowed, MissingWebhookJobError, PaymentRequired, PreconditionFailed, ResourceConflict, ResourceGone, ResourceNotFound, Response, ServerError, Shop, ShopLocked, TooManyRequests, UnauthorizedAccess, UpdateWebhooksJob, UpsertPrivateMetafield, UserError, Webhook, WebhooksManager

Constant Summary

PLAN_TO_DISPLAY_NAME =

Mapping from deprecated plan_name to plan_display_name

{
  "trial" => "trial",
  "frozen" => "frozen",
  "fraudulent" => "cancelled",
  "shopify_alumni" => "shopify_alumni",
  "affiliate" => "development",
  "basic" => "basic",
  "professional" => "shopify",
  "npo_full" => "npo_full",
  "shopify_plus" => "shopify_plus",
  "staff" => "staff",
  "unlimited" => "advanced",
  "retail" => "retail",
  "cancelled" => "cancelled",
  "dormant" => "pause_and_build",
  "starter_2022" => "shopify_starter",
  "plus_partner_sandbox" => "shopify_plus_partner_sandbox",
  "paid_trial" => "extended_trial",
  "partner_test" => "developer_preview",
  "open_learning" => "open_learning",
  "staff_business" => "staff_business"
}

DISPLAY_NAME_TO_PLAN =

PLAN_TO_DISPLAY_NAME.invert

VERSION =

"2.0.0"

Class Method Summary

• .client ⇒ Object
• .configuration ⇒ Object
• .configuration=(config) ⇒ Object
• .configure {|configuration| ... } ⇒ Object
• .deprecator ⇒ Object
• .normalize_plan_display_name(plan_display_name) ⇒ Object

Class Method Details

.client ⇒ Object

# File 'lib/shopify_graphql/client.rb', line 151

def client
  Client.new
end

.configuration ⇒ Object

# File 'lib/shopify_graphql/configuration.rb', line 18

def self.configuration
  @configuration ||= Configuration.new
end

.configuration=(config) ⇒ Object

# File 'lib/shopify_graphql/configuration.rb', line 22

def self.configuration=(config)
  @configuration = config
end

.configure {|configuration| ... } ⇒ Object

Yields:

• (configuration)

# File 'lib/shopify_graphql/configuration.rb', line 26

def self.configure
  yield configuration
end

.deprecator ⇒ Object

# File 'lib/shopify_graphql/engine.rb', line 2

def self.deprecator
  @deprecator ||= ActiveSupport::Deprecation.new("3.0", "ShopifyGraphql")
end

.normalize_plan_display_name(plan_display_name) ⇒ Object

# File 'lib/shopify_graphql/client.rb', line 155

def normalize_plan_display_name(plan_display_name)
  return if plan_display_name.blank?
  plan_display_name.parameterize(separator: "_")
end